Set-AzApiManagementApiVersionSet
Met à jour un jeu de versions d’API dans le contexte gestion des API.
Syntaxe
Set-AzApiManagementApiVersionSet
-Context <PsApiManagementContext>
-ApiVersionSetId <String>
[-Name <String>]
[-Scheme <PsApiManagementVersioningScheme>]
[-HeaderName <String>]
[-QueryName <String>]
[-Description <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementApiVersionSet
-InputObject <PsApiManagementApiVersionSet>
[-Name <String>]
[-Scheme <PsApiManagementVersioningScheme>]
[-HeaderName <String>]
[-QueryName <String>]
[-Description <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
La cmdlet Set-AzApiManagementApiVersionSet modifie un jeu de versions d’API Gestion des API Azure.
Exemples
Exemple 1
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"Cette commande met à jour un jeu de versions d’API existant avec le schéma de contrôle de version Header et le paramètre d’en-tête api-version.
Paramètres
-ApiVersionSetId
Identificateur du nouvel ensemble de versions d’API.
| 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 |
-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 du jeu de versions d’API.
| 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 |
-HeaderName
Valeur d’en-tête qui contiendra les informations de contrôle de version. Si l’EN-tête du schéma de contrôle de version est choisi, cette valeur doit être spécifiée.
| 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 PsApiManagementApiVersionSet. Ce paramètre est requis.
| Type: | PsApiManagementApiVersionSet |
| 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 du jeu ApiVersion. 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 |
-PassThru
Si elle est spécifiée, l’instance de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet, qui représente le type apiVersionSet modifié, est écrite en sortie.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-QueryName
Valeur de requête qui contiendra les informations de contrôle de version. Si la requête de schéma de contrôle de version est choisie, cette valeur doit être spécifiée.
| 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 |
-Scheme
Schéma de contrôle de version à sélectionner pour le jeu de versions d’API. Ce paramètre est facultatif.
| Type: | PsApiManagementVersioningScheme |
| Valeurs acceptées: | Segment, Query, Header |
| 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 |
Entrées
PsApiManagementVersioningScheme
