Conceitos Básicos

Este tópico descreve como instalar e configurar o SDK para TypeScript e JavaScript.

Para usar o Oracle Cloud Infrastructure SDK para TypeScript e JavaScript em seu projeto, importe qualquer serviço de ./oci-typescript-sdk/index.ts. Por exemplo:

// Container Engine

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

// Core

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

// Database

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

Download do SDK no GitHub

Você pode fazer download do SDK para TypeScript e JavaScript como arquivo zip pelo GitHub. O GitHub contém o SDK, todas as suas dependências, documentação e exemplos.

Instalando com o yum

Se estiver usando o Oracle Linux 7 ou 8, você poderá usar o yum para instalar o OCI SDK para TypeScript e JavaScript:

Para o 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

Para o Oracle Linux 7:

O OS Management System precisa ser ativado para a instância de computação. Consulte a Documentação do OS Management para obter mais informações.

O nó versão 14 ou 16 precisa ser adicionado na lista de origens de software pelo serviço OS Management. Consulte a documentação da Origem de Software para obter mais informações sobre como adicionar Nodejs 14 ou 16 à Origem de Software.

Depois que a origem de software for adicionada, execute:

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

O pacote do yum oci-typescript-sdk só funcionará para o Nó versão 14 ou 16. O pacote oci-sdk será instalado na pasta global node_modules. Para usar o pacote oci-sdk em um projeto, vincule o pacote global oci-sdk ao seu projeto local.

Por exemplo:

# 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

Como o pacote oci-sdk é instalado globalmente, atualize as instruções de importação dos subpacotes do pacote oci-sdk ao executar os exemplos de oci-typescript-sdk no GitHub. Por exemplo:

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

Usando o SDK para TypeScript e JavaScript com NPM

NPM.

Configurando o SDK

Os serviços SDK precisam de dois tipos de configuração: credenciais e definições HTTP do cliente.

Configurando Credenciais

Primeiro, você precisa configurar as suas credenciais e o arquivo de configuração. Para obter instruções, consulte Arquivo de Configuração da CLI e do SDK.

O local de configuração padrão é "~/.oci/config" e o perfil "DEFAULT" é usado. Você pode usar ConfigFileAuthenticationDetailsProvider com ou sem especificar o local de configuração e o nome do perfil:

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

Configurando Opções Personalizadas

No arquivo de configuração, você poderá inserir pares de chave/valor personalizados e referenciá-los conforme necessário. Por exemplo, você pode especificar um ID de compartimento frequentemente usado no arquivo de configuração:

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

Depois, você poderá recuperar o valor:

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