Fichier de configuration des trousses SDK et de l'interface de ligne de commande
Les trousses SDK et l'interface de ligne de commande Oracle Cloud Infrastructure nécessitent des informations de configuration de base, notamment des données d'identification et l'OCID de la location de l'utilisateur. Pour fournir ces informations, vous pouvez :
- Utiliser un fichier de configuration
- Déclarer une configuration au moment de l'exécution
Vous pouvez utiliser la console pour générer un fichier de configuration. Pour plus d'informations, voir Génération d'une clé de signature d'API (Console).
Les trousses SDK prennent en charge les deux options. Pour plus d'informations sur l'objet de configuration et les éventuelles exceptions lors de l'utilisation d'un fichier de configuration, consultez la documentation relative à chaque trousse SDK :
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour Java
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour Python
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour Ruby
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour Go
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour TypeScript et JavaScript
- Configuration de la trousse SDK Oracle Cloud Infrastructure pour .NET
L'interface de ligne de commande nécessite un fichier de configuration, mais vous permet également de définir des variables d'environnement pour fournir certaines informations. Pour plus d'informations, voir Variables d'environnement pour l'interface de ligne de commande.
Nom et emplacement du fichier
Le nom et l'emplacement du fichier de configuration par défaut sont ~/.oci/config.
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 qui commencent par un point. Entrées du fichier
Le tableau suivant répertorie les entrées de base requises pour le fichier de configuration ainsi que l'emplacement où vous pouvez obtenir les informations obligatoires.
| Entrée | Description et obtention de la valeur | Obligatoire? |
|---|---|---|
user
|
OCID de l'utilisateur appelant l'API. Pour obtenir la valeur, voir Clés et OCID requis. Exemple : |
Oui |
fingerprint
|
Empreinte de la clé publique qui a été ajoutée à cet utilisateur. Pour obtenir la valeur, voir Clés et OCID requis. |
Oui |
key_file
|
Chemin complet et nom du fichier de la clé privée. Important : La paire de clés doit être au format PEM. Pour des instructions sur la génération d'une paire de clés dans le format PEM, voir Clés et OCID requis. Exemple (Linux/Mac OS) : Exemple (Windows) : Cela correspond au fichier |
Oui |
pass_phrase
|
Phrase secrète utilisée pour la clé si elle est chiffrée. Attention : Cette entrée est obsolète et n'est incluse que pour la rétrocompatibilité. Évitez d'enregistrer des informations confidentielles dans le fichier de configuration. Pour une sécurité supplémentaire, transmettez la phrase secrète à la trousse SDK/l'interface de ligne de commande au moment de l'exécution. |
Oui, si la clé est chiffrée et que la phrase secrète n'a pas été configurée pour être transmise au moment de l'exécution |
tenancy
|
OCID de votre location. Pour obtenir la valeur, voir Clés et OCID requis. Exemple : |
Oui |
region
|
Une région d'Oracle Cloud Infrastructure. Voir Régions et domaines de disponibilité. Exemple : |
Oui |
security_token_file
|
Si l'authentification par jeton de session est utilisée, ce paramètre est requis. Lorsque cette méthode d'authentification est utilisée, fingerprint, user et pass_phrase ne sont pas requis. Le démarrage d'une session à partir de l'interface de ligne de commande OCI alimente tous les paramètres requis pour cette méthode d'authentification. Voir Démarrage d'une session d'interface de ligne de commande basée sur un jeton. |
Sous conditions |
Valeurs personnalisées
Certaines trousses SDK pour Oracle Cloud Infrastructure prennent en charge la définition de valeurs personnalisées dans le fichier de configuration. Pour plus d'informations, consultez la documentation sur chaque trousse 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.
Certaines trousses SDK pour Oracle Cloud Infrastructure requièrent un profil DEFAULT et prennent en charge l'héritage de profils. Cela signifie que toute valeur qui n'est pas définie explicitement pour un profil particulier est héritée du profil DEFAULT. Pour plus d'informations, consultez la documentation sur chaque trousse SDK.
Exemple de configuration
Les exemples suivants (pour Linux et Mac OS) présentent les valeurs clés d'un fichier de configuration et montrent comment définir des profils pour une trousse SDK qui prend en charge l'héritage de profils.
[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>[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>