az apic api definition

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 definition command. Apprenez-en davantage sur les extensions.

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

Commandes

Nom	Description	Type	État
az apic api definition create	Créez une définition d’API ou mettez à jour une définition d’API existante.	Extension	GA
az apic api definition delete	Supprimez la définition d’API spécifiée.	Extension	GA
az apic api definition export-specification	Exporte la spécification de l’API.	Extension	GA
az apic api definition import-specification	Importe la spécification de l’API.	Extension	GA
az apic api definition list	Répertorier une collection de définitions d’API.	Extension	GA
az apic api definition show	Obtenez des détails sur la définition de l’API.	Extension	GA
az apic api definition update	Mettez à jour la définition d’API existante.	Extension	GA

az apic api definition create

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

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Exemples

Créer une définition d’API

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Paramètres obligatoires

--api-id

ID de l’API.

--definition-id

ID de la définition 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.

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

--description

Description de la définition de l’API.

Propriété	Valeur
Groupe de paramètres:	Properties 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 definition delete

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

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

Exemples

Supprimer la définition de l’API

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

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

--definition-id

ID de la définition 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 definition export-specification

Exporte la spécification de l’API.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Exemples

Spécification de l’exportation

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Paramètres obligatoires

--file-name

Nom du fichier dans lequel exporter la spécification.

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

--definition-id

ID de la définition de l’API.

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

--ids

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

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

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

--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 definition import-specification

Importe la spécification de l’API.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Exemples

Exemple de spécification d’importation 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Exemple de spécification d’importation 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Importer une spécification à partir d’un exemple de fichier

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Paramètres obligatoires

--format

Format de la source de spécification de l’API.

Propriété	Valeur
Groupe de paramètres:	Payload Arguments
Valeurs acceptées:	inline, link

--specification

Détails de la spécification de l’API. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

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

--value

Valeur de la source de spécification de l’API.

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

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

--definition-id

ID de la définition de l’API.

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

--ids

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

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

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

--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 definition list

Répertorier une collection de définitions d’API.

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

Exemples

Répertorier les définitions d’API

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

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.

--version-id

ID de la version de l’API.

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 definition show

Obtenez des détails sur la définition de l’API.

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

Exemples

Afficher les détails de la définition d’API

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

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

--definition-id

ID de la définition 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 definition update

Mettez à jour la définition d’API existante.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Exemples

Mettre à jour la définition de l’API

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

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

--definition-id

ID de la définition de l’API.

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

--description

Description de la définition de l’API.

Propriété	Valeur
Groupe de paramètres:	Properties 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

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

Titre de la 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 definition

Commandes

az apic api definition create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic api definition delete

Exemples

Paramètres facultatifs

az apic api definition export-specification

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic api definition import-specification

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic api definition list

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic api definition show

Exemples

Paramètres facultatifs

az apic api definition update

Exemples

Paramètres facultatifs

Commentaires