Utilisation des applets de commande

ConfigFile

Chemin d'accès au fichier de configuration qui fournit les données d'identification pour Oracle Cloud.

Endpoint

Indique le point d'extrémité de service à utiliser pour les appels d'API OCI, y compris le chemin de version d'API requis. Par exemple, https://audit.us-ashburn-1.oraclecloud.com

FullResponse

Par défaut, les applets de commande OCI affichent le corps de réponse de l'opération d'API REST. L'inclusion du paramètre de commutateur FullResponse indique que l'applet de commande doit produire la réponse complète retournée par l'opération d'API encapsulée dans son type .NET associé (un objet contenant des en-têtes de réponse d'API en plus d'un corps de réponse facultatif).

NoRetry

Paramètre de commutation permettant de désactiver la logique de nouvelles tentatives par défaut pour les appels aux services.

Par défaut, les modules OCI pour PowerShell lancent de nouvelles tentatives pour les appels d'API en échec qui retournent les codes de statut 400, 401, 404, 409, 429 et 500. Les nouvelles tentatives utilisent un algorithme d'interruption exponentielle avec un maximum de 5 tentatives sur une période maximale de 10 minutes. Incluez ce paramètre de commutateur dans l'appel d'applet de commande pour désactiver la logique de nouvelles tentatives par défaut.

Profile

Indique le profil à charger à partir du fichier de configuration. Ce paramètre s'attend à ce qu'un nom de profil sensible à la casse existe dans le fichier de configuration.

Region

Indique l'ID région de la région par rapport à laquelle effectuer des appels. Par exemple : us-phoenix-1 ou ap-singapore-1.

TimeOutInMillis

Indique le délai d'attente maximal en millisecondes pour la fin de la demande d'API. La valeur par défaut est 100 000 millisecondes (100 secondes).

AuthType

Définit le type d'authentification à utiliser pour faire des demandes d'API. Par défaut, la clé d'API de votre fichier de configuration est utilisée. Les valeurs valides sont ApiKey ou InstancePrincipal.

Entrée d'applet de commande

Les applets de commande OCI acceptent actuellement les entrées des paramètres de ligne de commande ou par pipeline par nom de propriété. Pour voir un exemple sur la transmission des entrées par pipeline par nom de propriété, consultez cet exemple.

Sortie d'applet de commande

Par défaut, les applets de commande OCI retournent uniquement le corps de réponse de l'API encapsulé dans un type .NET associé. Pour les cas d'utilisation qui nécessitent que les utilisateurs inspectent la réponse d'API complète, y compris les en-têtes de réponse, utilisez le paramètre de commutateur FullResponse dans l'appel de l'applet de commande.

Dans l'exemple suivant, l'opération GetConfiguration du service de vérification pour OCI retourne une ressource Configuration dans le corps de la réponse.

PS /> Get-OCIAuditConfiguration -CompartmentId $env:CompartmentId | gm
 
   TypeName: Oci.AuditService.Models.Configuration
 
Name                MemberType Definition
----                ---------- ----------
Equals              Method     bool Equals(System.Object obj)
GetHashCode         Method     int GetHashCode()
GetType             Method     type GetType()
ToString            Method     string ToString()
RetentionPeriodDays Property   System.Nullable[int] RetentionPeriodDays {get;set;}

Dans la sortie de l'exemple ci-dessus, l'appel par défaut retourne uniquement l'objet .NET qui encapsule le corps de la réponse d'API.

Pour obtenir un objet de sortie qui inclut la réponse d'API complète, incluez le paramètre -FullResponse dans l'appel de l'applet de commande. Par exemple :

PS /> Get-OCIAuditConfiguration -CompartmentId $env:CompartmentId -FullResponse | gm                                                              
 
   TypeName: Oci.AuditService.Responses.GetConfigurationResponse
 
Name          MemberType Definition
----          ---------- ----------
Equals        Method     bool Equals(System.Object obj)
GetHashCode   Method     int GetHashCode()
GetType       Method     type GetType()
ToString      Method     string ToString()
Configuration Property   Oci.AuditService.Models.Configuration Configuration {get;set;}

Appels asynchrones

Pour les API Oracle Cloud qui retournent une réponse de demande de travail asynchrone, avec opc-work-request-id dans l'en-tête de réponse et aucun corps de réponse, les applets de commande OCI PowerShell retournent un objet Oci.PSModules.Common.Cmdlets.WorkRequest contenant la propriété OpcWorkRequestId .

Par exemple :

   TypeName: Oci.PSModules.Common.Cmdlets.WorkRequest
 
Name             MemberType Definition
----             ---------- ----------
Equals           Method     bool Equals(System.Object obj)
GetHashCode      Method     int GetHashCode()
GetType          Method     type GetType()
ToString         Method     string ToString()
OpcWorkRequestId Property   string OpcWorkRequestId {get;set;}

Traitement des erreurs

Si une erreur se produit lors de l'exécution d'un applet de commande OCI, l'applet de commande génère une erreur de fin avec un enregistrement d'erreur contenant l'exception et un message d'erreur sur la cause sous-jacente.