Fichier de configuration du kit SDK et de l'interface de ligne de commande

Les kits SDK et l'interface de ligne de commande Oracle Cloud Infrastructure nécessitent des informations de configuration de base, telles que les informations d'identification utilisateur et l'OCID de location. Vous pouvez fournir ces informations à l'aide des méthodes suivantes :

Utilisation d'un fichier de configuration
Déclaration d'une configuration au moment de l'exécution

Remarque

Vous pouvez utiliser la console pour générer un fichier de configuration. Pour plus d'informations, reportez-vous à Génération d'une clé de signature d'API (console).

Les kits SDK prennent en charge entièrement les deux options. Reportez-vous à la documentation de chaque kit SDK pour obtenir des informations sur l'objet de configuration et les exceptions éventuelles lors de l'utilisation d'un fichier de configuration :

L'interface de ligne de commande requiert un fichier de configuration, mais vous permet également de définir des variables d'environnement pour fournir certaines informations. Pour plus d'informations, reportez-vous à Variables d'environnement de l'interface de ligne de commande.

Nom et emplacement du fichier

Nom et emplacement par défaut du fichier de configuration : ~/.oci/config.

Remarque

Sous Windows, vous pouvez utiliser PowerShell pour créer le dossier avec la commande suivante : mkdir %HOMEDRIVE%%HOMEPATH%\.oci. L'explorateur de fichiers ne prend pas en charge la création de noms de dossier commençant par un point.

Entrées de fichier

Le tableau ci-dessous répertorie les entrées de base requises pour le fichier de configuration et indique où obtenir les informations requises.


Entrée	Description et emplacement de la valeur	Requis ?
`user`	OCID de l'utilisateur appelant l'API. Pour obtenir la valeur, reportez-vous à Clés et OCID requis. Exemple : `ocid1.user.oc1..<unique_ID>` (abrégé dans un souci de concision)	Oui
`fingerprint`	Empreinte de la clé publique ajoutée à cet utilisateur. Pour obtenir la valeur, reportez-vous à Clés et OCID requis.	Oui
`key_file`	Nom de fichier et chemin complet de la clé privée. Important : la paire de clés doit être au format PEM. Pour obtenir des instructions sur la génération d'une paire de clés au format PEM, reportez-vous à Clés et OCID requis. Exemple (Linux/Mac OS) : `~/.oci/oci_api_key.pem` Exemple (Windows) : `~/.oci/oci_api_key.pem` Correspond au fichier `%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem`.	Oui
`pass_phrase`	Phrase de passe utilisée pour la clé, si elle est cryptée. Attention: Cette entrée est en phase d'abandon et est incluse à des fins de compatibilité amont uniquement. Evitez d'enregistrer des informations confidentielles dans le fichier de configuration. Pour plus de sécurité, transmettez la phrase de passe au kit SDK ou à l'interface de ligne de commande lors de l'exécution.	Oui, si la clé est cryptée et que la phrase de passe n'a pas été configurée pour être transmise lors de l'exécution.
`tenancy`	OCID de votre location. Pour obtenir la valeur, reportez-vous à Clés et OCID requis. Exemple : `ocid1.tenancy.oc1..<unique_ID>`	Oui
`region`	Région Oracle Cloud Infrastructure. Reportez-vous à Régions et domaines de disponibilité. Exemple : `us-ashburn-1`	Oui
`security_token_file`	Si l'authentification par jeton de session est en cours d'utilisation, ce paramètre est requis. Avec cette méthode d'authentification, fingerprint, user et pass_phrase ne sont pas requis. Le démarrage d'une session avec l'interface de ligne de commande OCI renseigne tous les paramètres requis pour cette méthode d'authentification. Reportez-vous à Démarrage d'une session d'interface de ligne de commande basée sur un jeton.	Conditionnel

Valeurs personnalisées

Certains kits SDK Oracle Cloud Infrastructure prennent en charge la définition de valeurs personnalisées dans le fichier de configuration. Pour plus d'informations, reportez-vous à la documentation de chaque kit SDK.

Profils et héritage

Vous pouvez créer plusieurs profils avec des valeurs différentes pour ces entrées, puis spécifier le profil à charger.

Certains kits SDK Oracle Cloud Infrastructure nécessitent un profil DEFAULT et prennent en charge l'héritage de profil. Autrement dit, toute valeur non explicitement définie pour un profil donné est héritée du profil DEFAULT. Pour plus d'informations, reportez-vous à la documentation de chaque kit SDK.

Exemple de configuration

L'exemple ci-dessous (pour Linux et Mac OS) indique des valeurs de clé dans un fichier de configuration et la procédure de définition des profils pour un kit SDK prenant en charge l'héritage de profil.

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

L'exemple suivant concerne 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>