Utilisation des cmdlets

ConfigFile

Chemin du fichier de configuration qui fournit les informations d'identification pour Oracle Cloud.

Endpoint

Adresse de service à utiliser pour les appels d'API OCI, y compris tout chemin de version d'API requis. Par exemple, https://audit.us-ashburn-1.oraclecloud.com

FullResponse

Par défaut, les cmdlets OCI génèrent le corps de réponse de l'opération d'API REST. L'ajout du paramètre de commutateur FullResponse permet d'indiquer que la cmdlet doit générer la réponse complète renvoyée par l'opération d'API encapsulée dans le type .NET associé (objet contenant des en-têtes de réponse d'API en plus d'un corps de réponse facultatif).

NoRetry

Paramètre de commutateur permettant de désactiver la logique de nouvelle tentative par défaut pour les appels vers les services.

Par défaut, les modules OCI pour PowerShell effectuent des nouvelles tentatives pour les appels d'API en échec qui ont renvoyé les codes de statut 400, 401, 404, 409, 429 et 500. Les nouvelles tentatives utilisent un algorithme d'attente avec un nombre maximal de 5 tentatives sur une période maximale de 10 minutes. Incluez ce paramètre de commutateur dans l'appel de la cmdlet pour désactiver la logique de nouvelle tentative par défaut.

Profile

Profil à charger à partir du fichier de configuration. Ce paramètre attend un nom du profil avec distinctions des majuscules/minuscules existant dans le fichier de configuration.

Region

Valeur Region-ID de la région vers laquelle envoyer des appels. Par exemple : us-phoenix-1 ou ap-singapore-1.

TimeOutInMillis

Durée d'attente maximale, en millisecondes, pendant laquelle la demande d'API doit aboutir. La valeur par défaut est de 100 000 millisecondes (100 secondes).

AuthType

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

Entrée de cmdlet

Les cmdlets OCI acceptent actuellement les entrées transmises via les paramètres de ligne de commande ou via le pipeline par des noms de propriété. Pour consulter un exemple de transmission d'entrées via le pipeline par nom de propriété, reportez-vous à cet exemple.

Sortie de cmdlet

Par défaut, les cmdlets OCI renvoient uniquement le corps de réponse d'API encapsulé dans le type .NET associé. Pour les cas d'utilisation dans lesquels l'utilisateur doit inspecter 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 la cmdlet.

Dans l'exemple suivant, l'opération GetConfiguration du service OCI Audit renvoie une ressource Configuration dans le corps de 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 l'exemple ci-dessus, l'appel par défaut renvoie uniquement l'objet .NET qui encapsule le corps de réponse d'API.

Pour obtenir un objet de sortie qui inclut la réponse d'API complète, ajoutez le paramètre -FullResponse à l'appel de la cmdlet. 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 renvoyant une réponse de demande de travail asynchrone, avec opc-work-request-id dans l'en-tête des réponses et aucun corps de réponses, les cmdlet OCI PowerShell renvoient 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;}

Gestion des erreurs

En cas d'erreur lors de l'exécution d'une cmdlet OCI, celle-ci génère une erreur avec fin d'exécution ainsi qu'un enregistrement d'erreur contenant l'exception et un message d'erreur concernant la cause sous-jacente.