Partager via

az apic api

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

Commandes pour gérer les API dans le Centre des API.

Commandes

Nom Description Type État
az apic api create

Inscrivez une nouvelle API ou mettez à jour une API existante.

 Extension GA
az apic api definition

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

 Extension GA
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 delete

Supprimez l’API spécifiée.

 Extension GA
az apic api deployment

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

 Extension GA
az apic api deployment create

Créez un déploiement d’API ou mettez à jour un déploiement d’API existant.

 Extension GA
az apic api deployment delete

Supprimer le déploiement d’API.

 Extension GA
az apic api deployment list

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

 Extension GA
az apic api deployment show

Obtenez des détails sur le déploiement de l’API.

 Extension GA
az apic api deployment update

Mettez à jour le déploiement d’API existant.

 Extension GA
az apic api list

Répertorier une collection d’API.

 Extension GA
az apic api register

Inscrit une nouvelle API avec des déploiements de version, de définition et associés à l’aide du fichier de spécification comme source de vérité. Pour l’instant, nous prenons uniquement en charge le format JSON/YAML OpenAPI.

 Extension Preview
az apic api show

Obtenez les détails de l’API.

 Extension GA
az apic api update

Mettez à jour l’API existante.

 Extension GA
az apic api version

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

 Extension GA
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 create

Inscrivez une nouvelle API ou mettez à jour une API existante.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Exemples

Créer une API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Créer une API avec des propriétés personnalisées

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Créer une API avec des propriétés personnalisées à l’aide d’un fichier json

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

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.

--title

Titre de l’API.

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

Type d’API.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: graphql, grpc, rest, soap, webhook, websocket

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.

--contacts

Informations de contact pour 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: Properties Arguments
--custom-properties

Métadonnées personnalisées définies pour les entités du catalogue d’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: Properties Arguments
--description

Description de l’API.

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

Documentation externe supplémentaire pour 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: Properties Arguments
--license

Informations de licence pour 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: Properties Arguments
--summary

Brève description 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 delete

Supprimez l’API spécifiée.

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

Exemples

Supprimer l’API

az apic api delete -g contoso-resources -n contoso --api-id echo-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.

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

Répertorier une collection d’API.

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

Exemples

Répertorier les API

az apic api list -g contoso-resources -n contoso

Répertorier les API avec filtre

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

Préversion

Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Inscrit une nouvelle API avec des déploiements de version, de définition et associés à l’aide du fichier de spécification comme source de vérité. Pour l’instant, nous prenons uniquement en charge le format JSON/YAML OpenAPI.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Exemples

Inscrivez l’API en fournissant le fichier de spécifications.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Inscrivez l’API en fournissant une URL de spécification.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Paramètres obligatoires

--api-location -l

Emplacement du fichier de spécifications.

--resource-group -g

Nom du groupe de ressources.

--service-name -n

Nom du catalogue ou du service APICenter.

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.

--environment-id

ID de l’environnement créé avant.

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 show

Obtenez les détails de l’API.

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

Exemples

Afficher les détails de l’API

az apic api show -g contoso-resources -n contoso --api-id echo-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.

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

Mettez à jour l’API existante.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Exemples

Mettre à jour l’API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Mettre à jour les propriétés personnalisées

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Mettre à jour des propriétés personnalisées à l’aide d’un fichier json

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Mettre à jour des métadonnées personnalisées uniques

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

Informations de contact pour 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: Properties Arguments
--custom-properties

Métadonnées personnalisées définies pour les entités du catalogue d’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: Properties Arguments
--description

Description de l’API.

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

Documentation externe supplémentaire pour 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: 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

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

Informations de licence pour 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: Properties 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
--summary

Brève description de l’API.

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

Titre de l’API.

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

Type d’API.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: graphql, grpc, rest, soap, webhook, websocket
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