Set-AzApiManagementApiRevision
Modifie une révision d’API
Syntaxe
Set-AzApiManagementApiRevision
-ApiRevision <String>
-Context <PsApiManagementContext>
-ApiId <String>
[-Name <String>]
[-Description <String>]
[-ServiceUrl <String>]
[-Path <String>]
[-Protocols <PsApiManagementSchema[]>]
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-OpenIdProviderId <String>]
[-BearerTokenSendingMethod <String[]>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-SubscriptionRequired]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementApiRevision
-InputObject <PsApiManagementApi>
[-Name <String>]
[-Description <String>]
[-ServiceUrl <String>]
[-Path <String>]
[-Protocols <PsApiManagementSchema[]>]
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-OpenIdProviderId <String>]
[-BearerTokenSendingMethod <String[]>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-SubscriptionRequired]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
La cmdlet Set-AzApiManagementApiRevision modifie une révision de l’API Gestion des API Azure.
Exemples
Exemple 1 : Modifier une révision d’API
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiRevision -Context $ApiMgmtContext -ApiId "echo-api" -ApiRevision "2" -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"L’applet de commande met à jour la révision 2 de l’API echo-api avec une nouvelle description, un protocole et un chemin d’accès.
Paramètres
-ApiId
Identificateur de l’API existante. Ce paramètre est requis.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-ApiRevision
Identificateur de révision d’API existante. Ce paramètre est requis.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-AuthorizationScope
Étendue des opérations OAuth. Ce paramètre est facultatif. La valeur par défaut est $null.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-AuthorizationServerId
Identificateur du serveur d’autorisation OAuth. Ce paramètre est facultatif. La valeur par défaut est $null. Doit être spécifié si AuthorizationScope spécifié.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-BearerTokenSendingMethod
Mécanisme de serveur d’autorisation OpenId par lequel le jeton d’accès est passé à l’API. Reportez-vous à https://datatracker.ietf.org/doc/html/rfc6749#section-4. Ce paramètre est facultatif. La valeur par défaut est $null.
| Type: | String[] |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
| Type: | SwitchParameter |
| Alias: | cf |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Context
Instance de PsApiManagementContext. Ce paramètre est requis.
| Type: | PsApiManagementContext |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
| Type: | IAzureContextContainer |
| Alias: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Description
Description de l’API web. Ce paramètre est facultatif.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-InputObject
Instance de PsApiManagementApi. Ce paramètre est requis.
| Type: | PsApiManagementApi |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Name
Nom de l’API web. Nom public de l’API tel qu’il apparaît sur les portails de développement et d’administration. Ce paramètre est requis.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-OpenIdProviderId
Identificateur du serveur d’autorisation OpenId. Ce paramètre est facultatif. La valeur par défaut est $null. Doit être spécifié si BearerTokenSendingMethods est spécifié.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-PassThru
Si elle est spécifiée, l’instance de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi est de type représentant l’API set.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Path
Chemin d’accès de l’API web. Dernière partie de l’URL publique de l’API. Cette URL sera utilisée par les consommateurs d’API pour envoyer des demandes au service web. Doit avoir une longueur de 1 à 400 caractères. Ce paramètre est facultatif. La valeur par défaut est $null.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Protocols
Protocoles d’API web (http, https). Protocoles sur lesquels l’API est rendue disponible. Ce paramètre est requis. La valeur par défaut est $null.
| Type: | PsApiManagementSchema[] |
| Valeurs acceptées: | Http, Https |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-ServiceUrl
URL du service web exposant l’API. Cette URL sera utilisée uniquement par Gestion des API Azure et ne sera pas rendue publique. Doit être de 1 à 2 000 caractères. Ce paramètre est requis.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-SubscriptionKeyHeaderName
Nom de l’en-tête de clé d’abonnement. Ce paramètre est facultatif. La valeur par défaut est $null.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-SubscriptionKeyQueryParamName
Nom du paramètre de chaîne de requête de clé d’abonnement. Ce paramètre est facultatif. La valeur par défaut est $null.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-SubscriptionRequired
Indicateur pour appliquer SubscriptionRequired pour les demandes adressées à l’API. Ce paramètre est facultatif.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.
| Type: | SwitchParameter |
| Alias: | wi |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
