Introduction

Cette rubrique décrit comment installer et configurer la trousse SDK pour TypeScript et JavaScript.

Pour utiliser la trousse SDK Oracle Cloud Infrastructure pour TypeScript et JavaScript dans votre projet, importez tout service depuis ./oci-typescript-sdk/index.ts. Par exemple :

// Container Engine

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

// Core

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

// Database

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

Téléchargement de la trousse SDK à partir de GitHub

Vous pouvez télécharger la trousse SDK pour TypeScript et JavaScript en tant qu'archive zip à partir de GitHub. Le téléchargement contient la trousse SDK, toutes ses dépendances, la documentation, ainsi que des exemples.

Installation avec yum

Si vous utilisez Oracle Linux 7 ou 8, vous pouvez utiliser yum pour installer la trousse SDK pour TypeScript et JavaScript d'OCI :

Pour 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

Pour Oracle Linux 7 :

Le service de gestion du système d'exploitation doit être activé pour l'instance de calcul. Pour plus d'informations, voir la documentation sur le service de gestion du système d'exploitation.

La version 14 ou 16 de Node.js doit être ajoutée dans la liste des sources de logiciels par le service de gestion du système d'exploitation. Pour plus d'informations sur l'ajout de Node.js 14 ou 16 à la source de logiciels, voir la documentation sur les sources de logiciels.

Une fois la source de logiciels ajoutée, exécutez :

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

L'ensemble yum oci-typescript-sdk fonctionne uniquement pour la version 14 ou 16 de Node.js. L'ensemble oci-sdk est installé dans le dossier global node_modules. Pour utiliser l'ensemble oci-sdk dans un projet, liez l'ensemble global oci-sdk à votre projet local.

Par exemple :

# 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

Comme l'ensemble oci-sdk est installé globalement, vous devez mettre à jour les énoncés d'importation pour les sous-ensembles oci-sdk lors de l'exécution des exemples oci-typescript-sdk sur GitHub. Par exemple :

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

Utilisation de la trousse SDK pour TypeScript et JavaScript avec NPM

NPM.

Configuration de la trousse SDK

Les services de trousse SDK ont besoin de deux types de configuration : données d'identification et paramètres HTTP côté client.

Configuration des données d'identification

Tout d'abord, vous devez configurer vos données d'identification et votre fichier de configuration. Pour les instructions, voir Fichier de configuration des trousses SDK et de l'interface de ligne de commande.

L'emplacement de configuration par défaut est "~/.oci/config" et le profil "DEFAULT" est utilisé. Vous pouvez utiliser ConfigFileAuthenticationDetailsProvider avec ou sans indication de l'emplacement de configuration et du nom de profil :

// 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
);

Configuration des options personnalisées

Dans le fichier de configuration, vous pouvez insérer des paires clé-valeur personnalisées que vous définissez, puis les référencer si nécessaire. Par exemple, vous pouvez spécifier un ID compartiment fréquemment utilisé dans le fichier de configuration :

[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>

Vous pouvez ensuite extraire la valeur :

// 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") || "";