file di configurazione SDK e CLI

Oracle Cloud InfrastructureSDKs e CLI richiedono informazioni di configurazione di base, come le credenziali utente e l'OCID tenancy. È possibile fornire queste informazioni:

Uso di un file della configurazione
Dichiarazione di una configurazione in runtime

Nota

È possibile utilizzare la console per generare un file di configurazione. Per ulteriori informazioni, vedere Generazione di una chiave di firma API (console).

Gli SDK supportano completamente entrambe le opzioni. Fare riferimento alla documentazione di ciascun SDK per informazioni sull'oggetto di configurazione e sulle eventuali eccezioni quando si utilizza un file di configurazione:

L'interfaccia CLI richiede un file di configurazione ma consente anche di impostare le variabili d'ambiente per fornire determinate informazioni. Per ulteriori informazioni, vedere Variabili d'ambiente della CLI.

Nome e posizione file

In macOS e Git Bash in Windows la posizione predefinita del file di configurazione dell'interfaccia CLI OCI è ~/.oci/config. Qui, ~ fa riferimento alla home directory dell'utente corrente, ad esempio /Users/username/.oci/config. In Windows PowerShell (shell di Windows nativa) la posizione del file di configurazione è "$($Env:UserProfile)\.oci\config". Viene espansa in C:\Users\YourUsername\.oci\config.

Voci file

Nella tabella seguente sono elencate le voci di base necessarie per il file di configurazione, nonché la posizione in cui ottenere le informazioni richieste.


Voce	Descrizione e dove ottenere il valore	Obbligatorio?
`user`	OCID dell'utente che richiama l'API. Per ottenere il valore, vedere Chiavi e OCID obbligatori. Esempio: `ocid1.user.oc1..<unique_ID>`(abbreviato per brevità)	Sì
`fingerprint`	Impronta digitale per la chiave pubblica aggiunta a questo utente. Per ottenere il valore, vedere Chiavi e OCID obbligatori.	Sì
`key_file`	Percorso completo e nome file della chiave privata. Importante: la coppia di chiavi deve essere in formato PEM. Per istruzioni sulla generazione di una coppia di chiavi in formato PEM, vedere Chiavi e OCID richiesti. Esempio (Linux/Mac OS): `~/.oci/oci_api_key.pem` Esempio (Windows): `~/.oci/oci_api_key.pem` Questo corrisponde al file `%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem`.	Sì
`pass_phrase`	Passphrase utilizzata per la chiave, se cifrata. Attenzione: questa voce è deprecata ed è inclusa solo per la compatibilità con le versioni precedenti. Evitare di salvare informazioni riservate nel file di configurazione. Per una maggiore sicurezza, passare la passphrase all'SDK/CLI in fase di esecuzione.	Sì, se la chiave è cifrata e la passphrase non è stata configurata per essere passata in runtime
`tenancy`	OCID della tenancy. Per ottenere il valore, vedere Chiavi e OCID obbligatori. Esempio: `ocid1.tenancy.oc1..<unique_ID>`	Sì
`region`	Un'area Oracle Cloud Infrastructure. Vedere Region and Availability Domains. Esempio: `us-ashburn-1`	Sì
`security_token_file`	Se si utilizza l'autenticazione del token di sessione, questo parametro è obbligatorio. L'uso di questo metodo di autenticazione rende fingerprint, utente e pass_phrase non necessari. L'avvio di una sessione con l'interfaccia CLI OCI popolerà tutti i parametri necessari per questo metodo di autenticazione. Vedere Avvio di una sessione CLI basata su token.	Condizionale

Valori personalizzati

Alcuni SDK di Oracle Cloud Infrastructure supportano la definizione di valori personalizzati nel file di configurazione. Per maggiori informazioni, fare riferimento alla documentazione di ciascun SDK.

Profili ed eredità

È possibile creare più profili con valori diversi per queste voci, quindi è possibile specificare il profilo da caricare.

Alcuni SDK di Oracle Cloud Infrastructure richiedono un profilo DEFAULT e un'ereditarietà del profilo di supporto. Ciò significa che qualsiasi valore non definito in modo esplicito per un determinato profilo viene ereditato dal profilo PREDEFINITO. Per maggiori informazioni, fare riferimento alla documentazione di ciascun SDK.

Configurazione di esempio

L'esempio seguente (per Linux e Mac OS) mostra i valori chiave in un file di configurazione e come impostare i profili per un SDK che supporta l'ereditarietà del profilo.

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

Questo esempio è per 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>