Partager via

az apic api version

  • Référence

Remarque

Cette référence fait partie de l’extension apic-extension pour Azure CLI (version 2.57.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az apic api version . En savoir plus sur les extensions.

Commandes pour gérer les versions d’API dans le Centre DES API.

Commandes

Nom Description Type État
az apic api version create

Créez une version d’API ou mettez à jour une version d’API existante.

 Extension GA
az apic api version delete

Supprimez la version d’API spécifiée.

 Extension GA
az apic api version list

Répertorier une collection de versions d’API.

 Extension GA
az apic api version show

Obtenez les détails de la version de l’API.

 Extension GA
az apic api version update

Mettez à jour la version existante de l’API.

 Extension GA

az apic api version create

Créez une version d’API ou mettez à jour une version d’API existante.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

Exemples

Créer une version d’API

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

Paramètres obligatoires

--api-id

ID de l’API.

--lifecycle-stage

Étape de cycle de vie actuelle de l’API.

Valeurs acceptées: deprecated, design, development, preview, production, retired, testing
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

--title

Version d’API.

--version-id

ID de la version de l’API.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az apic api version delete

Supprimez la version d’API spécifiée.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--version-id]
                           [--yes]

Exemples

Supprimer la version de l’API

az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Paramètres facultatifs

--api-id

ID de l’API.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

--subscription

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

--version-id

ID de la version de l’API.

--yes -y

Ne pas demander de confirmation.

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az apic api version list

Répertorier une collection de versions d’API.

az apic api version list --api-id
                         --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Exemples

Liste des versions d’API

az apic api version list -g api-center-test -n contosoeuap --api-id echo-api

Paramètres obligatoires

--api-id

ID de l’API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

Paramètres facultatifs

--filter

Paramètre de filtre OData.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az apic api version show

Obtenez les détails de la version de l’API.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]
                         [--version-id]

Exemples

Afficher les détails de la version de l’API

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

Paramètres facultatifs

--api-id

ID de l’API.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

--subscription

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

--version-id

ID de la version de l’API.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az apic api version update

Mettez à jour la version existante de l’API.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Exemples

Mettre à jour la version de l’API

az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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 ou JSON string>.

--api-id

ID 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.

Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--lifecycle-stage

Étape de cycle de vie actuelle de l’API.

Valeurs acceptées: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

--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=.

--subscription

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

--title

Version d’API.

--version-id

ID de la version de l’API.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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