az apic api version

Note

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 az apic api version commande. Apprenez-en davantage 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.

Propriété	Valeur
Groupe de paramètres:	Properties Arguments
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 à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

--title

Version de l’API.

Propriété	Valeur
Groupe de paramètres:	Properties Arguments

--version-id

ID de la version de l’API.

Paramètres globaux

--debug

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

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

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

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id

ID de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--resource-group -g

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--service-name -n

Nom du service Du Centre des API Azure.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--version-id

ID de la version de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--yes -y

N’invitez pas à confirmer.

Propriété	Valeur
Valeur par défaut:	False

Paramètres globaux

--debug

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

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

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

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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 à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom du service Du Centre des API Azure.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 argument d’une commande suivante.

Propriété	Valeur
Groupe de paramètres:	Pagination Arguments

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

Propriété	Valeur
Groupe de paramètres:	Pagination Arguments

Paramètres globaux

--debug

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

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

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

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id

ID de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--ids

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--resource-group -g

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--service-name -n

Nom du service Du Centre des API Azure.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--version-id

ID de la version de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

Paramètres globaux

--debug

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

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

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

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

--api-id

ID de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--force-string

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--lifecycle-stage

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

Propriété	Valeur
Groupe de paramètres:	Properties Arguments
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 <indexToRemove> OR --remove propertyToRemove.

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

--resource-group -g

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--service-name -n

Nom du service Du Centre des API Azure.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--title

Version de l’API.

Propriété	Valeur
Groupe de paramètres:	Properties Arguments

--version-id

ID de la version de l’API.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

Paramètres globaux

--debug

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

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

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

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

Commentaires

Cette page a-t-elle été utile ?

Partager via

az apic api version

Commandes

az apic api version create

Exemples

Paramètres obligatoires

az apic api version delete

Exemples

Paramètres facultatifs

az apic api version list

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic api version show

Exemples

Paramètres facultatifs

az apic api version update

Exemples

Paramètres facultatifs

Commentaires