Guida introduttiva

Questo argomento descrive come installare e configurare l'SDK per TypeScript e JavaScript.

Per utilizzare Oracle Cloud Infrastructure SDK per TypeScript e JavaScript nel progetto, importare qualsiasi servizio da ./oci-typescript-sdk/index.ts. Ad esempio:

// Container Engine

export import containerengine = require("oci-containerengine");

// Core

export import core = require("oci-core");

// Database

export import database = require("oci-database");

Download dell'SDK da GitHub

È possibile scaricare il kit SDK per TypeScript e JavaScript come archivio zip da GitHub. Contiene l'SDK, tutte le sue dipendenze, documentazione ed esempi.

Installazione con yum

Se stai utilizzando Oracle Linux 7 o 8, puoi utilizzare yum per installare l'SDK OCI per TypeScript e JavaScript.

Per Oracle Linux 8:

sudo yum module enable nodejs:14 # for node 16 run: sudo yum module enable nodejs:16
sudo yum install oci-typescript-sdk

Per Oracle Linux 7:

Il sistema di gestione del sistema operativo deve essere abilitato per l'istanza di computazione. Per ulteriori informazioni, consultare la documentazione sulla gestione del sistema operativo.

Il nodo versione 14 o 16 deve essere aggiunto nell'elenco delle origini software da Gestione sistema operativo. Per ulteriori informazioni sull'aggiunta di Nodejs 14 o 16 all'origine software, consultare la documentazione sull'origine software.

Dopo aver aggiunto l'origine software, eseguire le operazioni riportate di seguito.

sudo yum --disablerepo ol7_developer_epel-x86_64 install nodejs 
sudo yum install oci-typescript-sdk

Il package yum oci-typescript-sdk funzionerà solo per il nodo versione 14 o 16. Il pacchetto oci-sdk verrà installato nella cartella global node_modules. Per utilizzare il pacchetto oci-sdk in un progetto, collegare il pacchetto globale oci-sdk al progetto locale.

Ad esempio:

# Assuming you are in your project's top level directory
npm link oci-sdk
# You should now see oci-sdk package in your local project's node_modules folder

Poiché il pacchetto oci-sdk è installato a livello globale, è necessario aggiornare le istruzioni di importazione per i sottopacchetti di oci-sdk quando si eseguono gli esempi oci-typescript-sdk in GitHub. Ad esempio:

import * as identity from "oci-identity"; // Change needed
import * as oci from "oci-sdk"; // No change needed

import * as identity from "oci-sdk/node_modules/oci-identity"; //Changed
import * as oci from "oci-sdk"; // No change

Utilizzo dell'SDK per TypeScript e JavaScript con NPM

NPM.

Configurazione dell'SDK

I servizi SDK richiedono due tipi di configurazione: le credenziali e le impostazioni HTTP lato client.

Configurazione delle credenziali

In primo luogo, è necessario impostare le credenziali e il file di configurazione. Per istruzioni, vedere SDK and CLI Configuration File.

La posizione di configurazione predefinita è "~/.oci/config" e viene utilizzato il profilo "DEFAULT". È possibile utilizzare ConfigFileAuthenticationDetailsProvider con o senza specificare la posizione di configurazione e il nome del profilo:

// TypeScript
import common = require("oci-common");
// Using default configuration
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

// JavaScript
const common = require("oci-common");
// Using default configurations
const provider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

Configurazione delle opzioni personalizzate

Nel file di configurazione è possibile inserire coppie chiave-valore personalizzate definite, quindi fare riferimento a tali coppie in base alle esigenze. Ad esempio, è possibile specificare un ID compartimento utilizzato di frequente nel file di configurazione:

[DEFAULT]
user=ocid1.user.oc1..<your_unique_id>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<your_unique_id>
customCompartmentId=ocid1.compartment.oc1..<your_unique_id>

Quindi è possibile recuperare il valore:

// TypeScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";


// JavaScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";