az apim

Gérer les services Azure Gestion des API.

Commandes

Nom	Description	Type	État
az apim api	Gérer les API Gestion des API Azure.	Core	GA
az apim api create	Créez une API Gestion des API.	Core	GA
az apim api delete	Supprimez une API Gestion des API.	Core	GA
az apim api export	Exportez une API Gestion des API.	Core	GA
az apim api import	Importez une API Gestion des API.	Core	GA
az apim api list	Répertorier les API Gestion des API.	Core	GA
az apim api operation	Gérer les opérations de l’API Gestion des API Azure.	Core	GA
az apim api operation create	Crée une opération dans l’API.	Core	GA
az apim api operation delete	Supprime l’opération spécifiée dans l’API.	Core	GA
az apim api operation list	Répertorier une collection des opérations pour l’API spécifiée.	Core	GA
az apim api operation show	Obtient les détails de l’opération d’API spécifiée par son identificateur.	Core	GA
az apim api operation update	Met à jour les détails de l’opération dans l’API spécifiée par son identificateur.	Core	GA
az apim api release	Gérer la version de l’API Gestion des API Azure.	Core	GA
az apim api release create	Crée une version pour l’API.	Core	GA
az apim api release delete	Supprime la version spécifiée dans l’API.	Core	GA
az apim api release list	Répertorie toutes les versions d’une API.	Core	GA
az apim api release show	Retourne les détails d’une version d’API.	Core	GA
az apim api release update	Met à jour les détails de la publication de l’API spécifiée par son identificateur.	Core	GA
az apim api revision	Gérer la révision de l’API Gestion des API Azure.	Core	GA
az apim api revision create	Créer une révision d’API.	Core	GA
az apim api revision list	Répertorie toutes les révisions d’une API.	Core	GA
az apim api schema	Gérer le schéma de l’API Gestion des API Azure.	Core	GA
az apim api schema create	Créez un schéma d’API Gestion des API.	Core	GA
az apim api schema delete	Supprimez un schéma d’API Gestion des API.	Core	GA
az apim api schema get-etag	Obtenir un etag d’un schéma d’API Gestion des API.	Core	GA
az apim api schema list	Répertorier les schémas de l’API Gestion des API.	Core	GA
az apim api schema show	Afficher les détails d’un schéma d’API Gestion des API.	Core	GA
az apim api schema wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un schéma d’API apim soit remplie.	Core	GA
az apim api show	Afficher les détails d’une API Gestion des API.	Core	GA
az apim api update	Mettez à jour une API Gestion des API.	Core	GA
az apim api versionset	Gérer l’ensemble de versions de l’API Gestion des API Azure.	Core	GA
az apim api versionset create	Crée un jeu de versions d’API.	Core	GA
az apim api versionset delete	Supprime un jeu de versions d’API spécifique.	Core	GA
az apim api versionset list	Répertorie une collection de jeux de versions d’API dans l’instance de service spécifiée.	Core	GA
az apim api versionset show	Obtient les détails du jeu de versions d’API spécifié par son identificateur.	Core	GA
az apim api versionset update	Met à jour les détails de l’Api VersionSet spécifié par son identificateur.	Core	GA
az apim api wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’api apim soit remplie.	Core	GA
az apim apply-network-updates	Mettez à jour la ressource Gestion des API en cours d’exécution dans le réseau virtuel pour sélectionner les paramètres réseau mis à jour.	Core	GA
az apim backup	Crée une sauvegarde du service Gestion des API sur le compte de stockage Azure donné. Il s’agit d’une opération longue et peut prendre plusieurs minutes.	Core	GA
az apim check-name	Vérifie si un nom de service est disponible.	Core	GA
az apim create	Créez une instance de service Gestion des API.	Core	GA
az apim delete	Supprime un service Gestion des API.	Core	GA
az apim deletedservice	Gérer les services de gestion des API Azure supprimés de manière réversible.	Core	GA
az apim deletedservice list	Répertorier toutes les instances de services Gestion des API supprimées de manière réversible disponibles pour annuler la suppression pour l’abonnement donné.	Core	GA
az apim deletedservice purge	Vider l’instance du service Gestion des API supprimée de manière réversible (la supprime sans option pour annuler la suppression).	Core	GA
az apim deletedservice show	Obtenir les instances de service Gestion des API supprimées de manière réversible disponibles pour annuler la suppression par nom.	Core	GA
az apim graphql	Gérer les API GraphQL de gestion des API Azure.	Core	GA
az apim graphql resolver	Gérer les résolveurs de l’API GraphQL de gestion des API Azure.	Core	GA
az apim graphql resolver create	Créez un programme de résolution dans l’API GraphQL ou met à jour un programme existant.	Core	GA
az apim graphql resolver delete	Supprimez le programme de résolution spécifié dans l’API GraphQL.	Core	GA
az apim graphql resolver list	Répertorier une collection des programmes de résolution pour l’API GraphQL spécifiée.	Core	GA
az apim graphql resolver policy	Gérer les stratégies de résolution des programmes de résolution de l’API GraphQL de gestion des API Azure.	Core	GA
az apim graphql resolver policy create	Créer ou mettre à jour la configuration de stratégie pour le niveau de résolution de l’API GraphQL.	Core	GA
az apim graphql resolver policy delete	Supprimez la configuration de la stratégie dans le programme de résolution d’API GraphQL.	Core	GA
az apim graphql resolver policy list	Obtenez la liste de la configuration de stratégie au niveau du programme de résolution de l’API GraphQL.	Core	GA
az apim graphql resolver policy show	Obtenez la configuration de la stratégie au niveau du programme de résolution de l’API GraphQL.	Core	GA
az apim graphql resolver show	Obtenez les détails du programme de résolution de l’API GraphQL spécifié par son identificateur.	Core	GA
az apim list	Répertorier les instances du service Gestion des API.	Core	GA
az apim nv	Gérer les valeurs nommées gestion des API Azure.	Core	GA
az apim nv create	Créez une valeur nommée gestion des API.	Core	GA
az apim nv delete	Supprimez une valeur nommée gestion des API.	Core	GA
az apim nv list	Répertorier les valeurs nommées gestion des API.	Core	GA
az apim nv show	Afficher les détails d’une valeur nommée gestion des API.	Core	GA
az apim nv show-secret	Obtient le secret d’une valeur nommée gestion des API.	Core	GA
az apim nv update	Mettez à jour une valeur nommée gestion des API.	Core	GA
az apim nv wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’une valeur nommée apim soit remplie.	Core	GA
az apim product	Gérer les produits de gestion des API Azure.	Core	GA
az apim product api	Gérer les API du produit Gestion des API Azure.	Core	GA
az apim product api add	Ajoutez une API au produit spécifié.	Core	GA
az apim product api check	Vérifie que l’entité API spécifiée par l’identificateur est associée à l’entité Product.	Core	GA
az apim product api delete	Supprime l’API spécifiée du produit spécifié.	Core	GA
az apim product api list	Répertorie une collection des API associées à un produit.	Core	GA
az apim product create	Crée un produit.	Core	GA
az apim product delete	Delete product.	Core	GA
az apim product list	Répertorie une collection de produits dans l’instance de service spécifiée.	Core	GA
az apim product show	Obtient les détails du produit spécifié par son identificateur.	Core	GA
az apim product update	Mettez à jour les détails du produit existant.	Core	GA
az apim product wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un produit apim soit remplie.	Core	GA
az apim restore	Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération longue et peut prendre plusieurs minutes.	Core	GA
az apim show	Afficher les détails d’une instance de service Gestion des API.	Core	GA
az apim update	Mettez à jour une instance de service Gestion des API.	Core	GA
az apim wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’apim soit remplie.	Core	GA

az apim apply-network-updates

Mettez à jour la ressource Gestion des API en cours d’exécution dans le réseau virtuel pour sélectionner les paramètres réseau mis à jour.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Exemples

Mettre à jour les paramètres du réseau virtuel de l’instance du service Gestion des API

az apim apply-network-updates --name MyApim -g MyResourceGroup

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

Location. Valeurs provenant de : az account list-locations. Vous pouvez configurer l’emplacement par défaut à l’aide de az configure --defaults location=<location>.

--no-wait

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

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

Output format.

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

Crée une sauvegarde du service Gestion des API sur le compte de stockage Azure donné. Il s’agit d’une opération longue et peut prendre plusieurs minutes.

az apim backup --backup-name
               --container-name --storage-account-container
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Exemples

Créer une sauvegarde de l’instance du service Gestion des API

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Paramètres obligatoires

--backup-name

Nom du fichier de sauvegarde à créer.

--container-name --storage-account-container

Nom du conteneur de compte de stockage utilisé pour placer la sauvegarde.

--name -n

Nom de l’instance du service de gestion des 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>.

--storage-account-key

Clé d’accès du compte de stockage utilisé pour placer la sauvegarde.

Propriété	Valeur
Parameter group:	Storage Arguments

--storage-account-name

Nom du compte de stockage utilisé pour placer la sauvegarde.

Propriété	Valeur
Parameter group:	Storage Arguments

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

Output format.

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 apim check-name

Vérifie si un nom de service est disponible.

az apim check-name --name

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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

Output format.

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

Créez une instance de service Gestion des API.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Exemples

Créez un service Gestion des API de niveau Développeur.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Créez un service Gestion des API de niveau Consommation.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Paramètres obligatoires

--name -n

Nom unique de l’instance de service à créer.

Le nom doit être globalement unique, car il sera inclus en tant que nom d’hôte de passerelle comme ' https://my-api-servicename.azure-api.net'. See examples.

--publisher-email

Adresse de messagerie pour recevoir toutes les notifications système.

--publisher-name

Nom de votre organisation à utiliser dans le portail des développeurs et les notifications par e-mail.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-gateway

Désactivez la passerelle dans la région maître. Valide uniquement pour un service Gestion des API déployé à plusieurs emplacements.

Propriété	Valeur
Valeurs acceptées:	false, true

--enable-client-certificate

Applique un certificat client à présenter à chaque demande à la passerelle et permet également d’authentifier le certificat dans la stratégie sur la passerelle.

Propriété	Valeur
Valeurs acceptées:	false, true

--enable-managed-identity

Créez une identité managée pour le service Gestion des API pour accéder à d’autres ressources Azure. Uniquement destiné à être utilisé pour le service de référence SKU Consommation.

Propriété	Valeur
Valeur par défaut:	False
Valeurs acceptées:	false, true

--location -l

Location. Valeurs provenant de : az account list-locations. Vous pouvez configurer l’emplacement par défaut à l’aide de az configure --defaults location=<location>.

--no-wait

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

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

--public-network-access

Indique si l’accès au point de terminaison public est autorisé pour ce service Gestion des API. Si la valeur est true, les points de terminaison privés sont la méthode d’accès exclusif.

Propriété	Valeur
Valeurs acceptées:	false, true

--sku-capacity

Nombre d’unités déployées de la référence SKU.

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

--sku-name

Référence sku de l’instance de gestion des API.

Propriété	Valeur
Valeur par défaut:	Developer
Valeurs acceptées:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--virtual-network -v

Type de réseau virtuel.

Propriété	Valeur
Valeur par défaut:	None
Valeurs acceptées:	External, Internal, None

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

Output format.

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

Supprime un service Gestion des API.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Exemples

Supprimez un service Gestion des API.

az apim delete -n MyApim -g MyResourceGroup

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

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

Output format.

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

Répertorier les instances du service Gestion des API.

az apim list [--resource-group]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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

Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération longue et peut prendre plusieurs minutes.

az apim restore --backup-name
                --container-name --storage-account-container
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Exemples

Restaure une sauvegarde de l’instance du service Gestion des API

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Paramètres obligatoires

--backup-name

Nom du fichier de sauvegarde à restaurer.

--container-name --storage-account-container

Nom du conteneur de compte de stockage utilisé pour récupérer la sauvegarde.

--name -n

Nom de l’instance du service de gestion des 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>.

--storage-account-key

Clé d’accès du compte de stockage utilisé pour récupérer la sauvegarde.

Propriété	Valeur
Parameter group:	Storage Arguments

--storage-account-name

Nom du compte de stockage utilisé pour récupérer la sauvegarde.

Propriété	Valeur
Parameter group:	Storage Arguments

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

Output format.

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

Afficher les détails d’une instance de service Gestion des API.

az apim show --name
             --resource-group

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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 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

Output format.

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

Mettez à jour une instance de service Gestion des API.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Generic Update Arguments
Valeur par défaut:	[]

--disable-gateway

Désactivez la passerelle dans la région maître. Valide uniquement pour un service Gestion des API déployé à plusieurs emplacements.

Propriété	Valeur
Valeurs acceptées:	false, true

--enable-client-certificate

Applique un certificat client à présenter à chaque demande à la passerelle et permet également d’authentifier le certificat dans la stratégie sur la passerelle.

Propriété	Valeur
Valeurs acceptées:	false, true

--enable-managed-identity

Créez une identité managée pour le service Gestion des API pour accéder à d’autres ressources Azure. Uniquement destiné à être utilisé pour le service de référence SKU Consommation.

Propriété	Valeur
Valeurs acceptées:	false, true

--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
Parameter group:	Generic Update Arguments
Valeur par défaut:	False

--no-wait

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

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

--public-network-access

Indique si l’accès au point de terminaison public est autorisé pour ce service Gestion des API. Si la valeur est true, les points de terminaison privés sont la méthode d’accès exclusif.

Propriété	Valeur
Valeurs acceptées:	false, true

--publisher-email

Adresse de messagerie pour recevoir toutes les notifications système.

--publisher-name

Nom de votre organisation à utiliser dans le portail des développeurs et les notifications par e-mail.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriété	Valeur
Parameter group:	Generic Update Arguments
Valeur par défaut:	[]

--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
Parameter group:	Generic Update Arguments
Valeur par défaut:	[]

--sku-capacity

Nombre d’unités déployées de la référence SKU.

--sku-name

Référence sku de l’instance de gestion des API.

Propriété	Valeur
Valeurs acceptées:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--virtual-network -v

Type de réseau virtuel.

Propriété	Valeur
Valeurs acceptées:	External, Internal, None

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

Output format.

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

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’apim soit remplie.

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--timeout]
             [--updated]

Exemples

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’apim soit remplie. (autogenerated)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Paramètres obligatoires

--name -n

Nom de l’instance du service de gestion des 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Propriété	Valeur
Parameter group:	Wait Condition Arguments
Valeur par défaut:	False

--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

Propriété	Valeur
Parameter group:	Wait Condition Arguments

--deleted

Attendez la suppression.

Propriété	Valeur
Parameter group:	Wait Condition Arguments
Valeur par défaut:	False

--exists

Attendez que la ressource existe.

Propriété	Valeur
Parameter group:	Wait Condition Arguments
Valeur par défaut:	False

--interval

Intervalle d’interrogation en secondes.

Propriété	Valeur
Parameter group:	Wait Condition Arguments
Valeur par défaut:	30

--timeout

Délai maximal d’attente en secondes.

Propriété	Valeur
Parameter group:	Wait Condition Arguments
Valeur par défaut:	3600

--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Propriété	Valeur
Parameter group:	Wait Condition Arguments
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

Output format.

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