Partager via

az apic

  • 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 . En savoir plus sur les extensions.

Gérer les services du Centre des API Azure.

Commandes

Nom Description Type État
az apic api

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

 Extension GA
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 Aperçu
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 create

Crée une instance ou met à jour une instance existante d’un service Azure API Center.

 Extension GA
az apic delete

Supprime une instance d’un service Azure API Center.

 Extension GA
az apic environment

Commandes pour gérer les environnements dans le Centre DES API.

 Extension GA
az apic environment create

Créez un environnement ou mettez à jour un environnement existant.

 Extension GA
az apic environment delete

Supprimez l’environnement.

 Extension GA
az apic environment list

Répertorier une collection d’environnements.

 Extension GA
az apic environment show

Obtenez des détails sur l’environnement.

 Extension GA
az apic environment update

Mettez à jour l’environnement existant.

 Extension GA
az apic import-from-apim

Importe des API à partir d’une instance de service Azure Gestion des API.

 Extension GA
az apic list

Répertorie les services du Centre des API Azure au sein d’un abonnement Azure.

 Extension GA
az apic metadata

Commandes pour gérer les schémas de métadonnées dans le Centre DES API.

 Extension GA
az apic metadata create

Créez un schéma de métadonnées ou mettez à jour un schéma de métadonnées existant.

 Extension GA
az apic metadata delete

Supprimez le schéma de métadonnées spécifié.

 Extension GA
az apic metadata export

Exporte le schéma de métadonnées.

 Extension GA
az apic metadata list

Répertorier une collection de schémas de métadonnées.

 Extension GA
az apic metadata show

Obtenez les détails du schéma de métadonnées.

 Extension GA
az apic metadata update

Mettez à jour le schéma de métadonnées existant.

 Extension GA
az apic show

Afficher les détails d’une instance de service Azure API Center.

 Extension GA
az apic update

Mettez à jour une instance d’un service Azure API Center.

 Extension GA

az apic create

Crée une instance ou met à jour une instance existante d’un service Azure API Center.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Exemples

Créer un exemple de service 1

az apic create -g contoso-resources -n contoso -l eastus

Créer un exemple de service 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Paramètres obligatoires

--name -n

Nom du service Centre d’API.

--resource-group -g

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

Paramètres facultatifs

--identity

Identités de service managées affectées à cette ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--location -l

Emplacement géographique où la ressource se trouve quand elle n’est pas spécifiée, l’emplacement du groupe de ressources sera utilisé.

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

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 delete

Supprime une instance d’un service Azure API Center.

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

Exemples

Suppression du service

az apic delete -n contoso -g contoso-resources

Paramètres facultatifs

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

--name -n

Nom du service Centre d’API.

--resource-group -g

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

--subscription

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

--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 import-from-apim

Importe des API à partir d’une instance de service Azure Gestion des API.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Exemples

Importer toutes les API à partir d’APIM dans le même groupe de ressources

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importer les API sélectionnées à partir d’APIM dans le même groupe de ressources

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importer toutes les API à partir d’APIM dans un autre abonnement et un autre groupe de ressources

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Paramètres obligatoires

--apim-apis

API à importer. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--apim-name

Nom de l’instance APIM source.

Paramètres facultatifs

--apim-resource-group

Groupe de ressources de l’instance APIM source.

--apim-subscription

ID d’abonnement de l’instance APIM source.

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

--no-wait

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

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

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 list

Répertorie les services du Centre des API Azure au sein d’un abonnement Azure.

Il existe un problème connu qui répertorie toutes les ressources d’un abonnement ne fonctionne pas. Répertoriez les ressources par groupe de ressources.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Exemples

Répertorier les services dans le groupe de ressources

az apic list -g contoso-resources

Paramètres facultatifs

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

--resource-group -g

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

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 show

Afficher les détails d’une instance de service Azure API Center.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Exemples

Afficher les détails du service

az apic show -g contoso-resources -n contoso

Paramètres facultatifs

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

--name -n

Nom du service Centre d’API.

--resource-group -g

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

--subscription

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

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 update

Mettez à jour une instance d’un service Azure API Center.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Exemples

Mettre à jour les détails du service

az apic update -g contoso-resources -n contoso

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

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

Identités de service managées affectées à cette ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

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

--name -n

Nom du service Centre d’API.

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

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

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

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.