az apic

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 commande az apic . Apprenez-en davantage 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-analysis	Gérer les fonctionnalités d’analyse des API du service Azure API Center.	Extension	Preview
az apic api-analysis create	Créez ou met à jour la configuration existante de l’analyseur d’API.	Extension	Preview
az apic api-analysis delete	Supprime la configuration de l’analyseur d’API.	Extension	Preview
az apic api-analysis export-ruleset	Exporte l’ensemble de règles d’analyseur d’API.	Extension	Preview
az apic api-analysis import-ruleset	Importe l’ensemble de règles de l’analyseur d’API.	Extension	Preview
az apic api-analysis list	Répertorier les configurations de l’analyseur d’API.	Extension	Preview
az apic api-analysis show	Obtenez des détails sur la configuration de l’analyseur d’API.	Extension	Preview
az apic api-analysis update	Mettez à jour la configuration existante de l’analyseur d’API ou la mise à jour.	Extension	Preview
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 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 integration	Gère les intégrations dans azure API Center.	Extension	GA
az apic integration create	Gérer les services du Centre des API Azure.	Extension	GA
az apic integration create apim	Ajoutez Azure APIM en tant que source d’API.	Extension	GA
az apic integration create aws	Ajoutez Amazon API Gateway en tant que source d’API.	Extension	GA
az apic integration delete	Supprimez la source d’API spécifiée.	Extension	GA
az apic integration list	Répertorier une collection de sources d’API.	Extension	GA
az apic integration show	Obtenez les détails de la source de l’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

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

Créer un service avec l’exemple d’identité affectée par le système

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

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

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.

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

Supprime une instance d’un service Azure API Center.

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

Exemples

Supprimer le service

az apic delete -n contoso -g contoso-resources

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.

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

--name -n

Nom du service Centre d’API.

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

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

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.

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

--resource-group -g

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

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

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.

--ids

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

--name -n

Nom du service Centre d’API.

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

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

Mettre à jour le service avec l’exemple d’identité affectée par le système

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

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

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

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

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

--name -n

Nom du service Centre d’API.

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

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

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

Commandes

az apic create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apic delete

Exemples

Paramètres facultatifs

az apic list

Exemples

Paramètres facultatifs

az apic show

Exemples

Paramètres facultatifs

az apic update

Exemples

Paramètres facultatifs

Commentaires