Partager via

az apim api versionset

  • Référence

Gérer l’ensemble de versions de l’API Gestion des API Azure.

Commandes

Nom Description Type État
az apim api versionset create

Crée un jeu de versions d’API.

 Noyau GA
az apim api versionset delete

Supprime un jeu de versions d’API spécifique.

 Noyau GA
az apim api versionset list

Répertorie une collection de jeux de versions d’API dans l’instance de service spécifiée.

 Noyau GA
az apim api versionset show

Obtient les détails du jeu de versions d’API spécifié par son identificateur.

 Noyau GA
az apim api versionset update

Met à jour les détails de l’Api VersionSet spécifié par son identificateur.

 Noyau GA

az apim api versionset create

Modifier

Crée un jeu de versions d’API.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Exemples

Crée un ensemble de versions d’API avec le schéma de version en tant qu’en-tête.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Crée un jeu de versions d’API avec le schéma de version en tant que requête.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Paramètres obligatoires

--display-name

Obligatoire. Nom du jeu de versions de l’API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service Gestion des API.

--versioning-scheme

Obligatoire. Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. Les valeurs possibles sont les suivantes : « Segment », « Requête », « En-tête ».

Paramètres facultatifs

--description

Description du jeu de versions d’API.

--if-match

ETag de l’entité.

--version-header-name

Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.

--version-query-name

Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.

--version-set-id

Identificateur de ressource pour l’ApiVersionSet associé.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

az apim api versionset delete

Modifier

Supprime un jeu de versions d’API spécifique.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Exemples

Supprime un jeu de versions d’API spécifique.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service Gestion des API.

--version-set-id

Identificateur de ressource pour l’ApiVersionSet associé.

Paramètres facultatifs

--if-match

ETag de l’entité.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

az apim api versionset list

Modifier

Répertorie une collection de jeux de versions d’API dans l’instance de service spécifiée.

az apim api versionset list --resource-group
                            --service-name

Exemples

Répertorie une collection de jeux de versions d’API dans l’instance de service spécifiée.

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service Gestion des API.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

az apim api versionset show

Modifier

Obtient les détails du jeu de versions d’API spécifié par son identificateur.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Exemples

Obtient les détails du jeu de versions d’API spécifié par son identificateur.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service Gestion des API.

--version-set-id

Identificateur de ressource pour l’ApiVersionSet associé.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

az apim api versionset update

Modifier

Met à jour les détails de l’Api VersionSet spécifié par son identificateur.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Exemples

Met à jour la description, le nom complet de l’Api VersionSet spécifié par son identificateur.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Met à jour le schéma de version de l’Api VersionSet spécifié par son identificateur.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service Gestion des API.

--version-set-id

Identificateur de ressource pour l’ApiVersionSet associé.

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Valeur par défaut: []
--description

Description du jeu de versions d’API.

--display-name

Obligatoire. Nom du jeu de versions de l’API.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Valeur par défaut: False
--if-match

ETag de l’entité.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valeur par défaut: []
--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Valeur par défaut: []
--version-header-name

Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.

--version-query-name

Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.

--versioning-scheme

Obligatoire. Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. Les valeurs possibles sont les suivantes : « Segment », « Requête », « En-tête ».

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.