Arquivo de Configuração da CLI e de SDKs

Os SDKs e a CLI do Oracle Cloud Infrastructure requerem informações básicas sobre a configuração, como credenciais do usuário e o OCID da tenancy. Você pode fornecer estas informações:

Usando um arquivo de configuração
Declarando uma configuração durante o runtime

Observação

Você pode usar a Console para ajudar a gerar um arquivo de configuração. Para obter mais informações, consulte Gerando uma Chave de Assinatura de API (Console).

Os SDKs suportam totalmente ambas as opções. Consulte a documentação de cada SDK para obter informações sobre o objeto de configuração e exceções durante a utilização do arquivo de configuração:

A CLI exige um arquivo de configuração, mas também permite definir variáveis de ambiente para fornecer determinadas informações. Consulte Variáveis de Ambiente da CLI para obter mais informações.

Nome e Localização do Arquivo

O nome e a localização do arquivo de configuração padrão são ~/.oci/config.

Observação

No Windows, você pode usar o PowerShell para criar a pasta com o seguinte comando: mkdir %HOMEDRIVE%%HOMEPATH%\.oci. O Explorador de Arquivos não suporta a criação de nomes de pastas que começam com um ponto.

Entradas do Arquivo

A tabela a seguir lista as entradas básicas necessárias para o arquivo de configuração e também onde obter as informações necessárias.


Entrada	Descrição e Onde Obter o Valor	Obrigatória?
`user`	O OCID do usuário que está chamando a API. Para obter o valor, consulte Chaves e OCIDs Necessários. Exemplo: `ocid1.user.oc1..<unique_ID>`(abreviado para ficar menor)	Sim
`fingerprint`	Impressão digital para a chave pública que foi adicionada a este usuário. Para obter o valor, consulte Chaves e OCIDs Necessários.	Sim
`key_file`	Caminho e nome do arquivo completos da chave privada. Importante: o par de chaves deve estar no formato PEM. Para obter instruções sobre como gerar um par de chaves no formato PEM, consulte Chaves e OCIDs Necessários. Exemplo (SO Linux/Mac): `~/.oci/oci_api_key.pem` Exemplo (Windows): `~/.oci/oci_api_key.pem` Isso corresponde ao arquivo `%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem`.	Sim
`pass_phrase`	Frase-senha usada para a chave, se estiver criptografada. Cuidado: Esta entrada está obsoleta e só foi incluída por questões de compatibilidade reversa. Evite salvar informações confidenciais no arquivo de configuração. Para obter segurança adicional, informe a frase-senha para o SDK/CLI no runtime.	Sim, se a chave for criptografada e a frase-senha não tiver sido configurada para ser informada no runtime
`tenancy`	OCID da sua tenancy. Para obter o valor, consulte Chaves e OCIDs Necessários. Exemplo: `ocid1.tenancy.oc1..<unique_ID>`	Sim
`region`	Uma região do Oracle Cloud Infrastructure. Consulte Regiões e Domínios de Disponibilidade. Exemplo: `us-ashburn-1`	Sim
`security_token_file`	Se a autenticação do token de sessão estiver sendo usada, esse parâmetro será obrigatório. O uso desse método de autenticação faz com que as entradas fingerprint, user e pass_phrase não sejam necessárias. Iniciar uma sessão com a CLI do OCI preencherá todos os parâmetros necessários para este método de autenticação. Consulte Iniciando uma Sessão da CLI Baseada em Token.	Condicional

Valores Personalizados

Alguns SDKs do Oracle Cloud Infrastructure suportam a definição de valores personalizados no arquivo de configuração. Consulte a documentação de cada SDK para obter mais informações.

Perfis e Herança

Você pode criar vários perfis com valores específicos para essas entradas. Depois, poderá especificar qual perfil deverá ser carregado.

Alguns SDKs do Oracle Cloud Infrastructure exigem um perfil DEFAULT e suportam herança de perfil. Isso significa que qualquer valor que não esteja explicitamente definido para determinado perfil será herdado do perfil DEFAULT. Consulte a documentação de cada SDK para obter mais informações.

Exemplo de Configuração

O exemplo a seguir (para sistemas operacionais Linux e Mac) mostra valores de chave em um arquivo de configuração e como definir perfis para um SDK que suporta herança de perfil.

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys/admin_key.pem
pass_phrase=<your_passphrase>

Este exemplo é do Windows:

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=%HOMEPATH%\.oci\oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys\admin_key.pem
pass_phrase=<your_passphrase>