az apim api

Gérer les API Gestion des API Azure.

Commandes

Nom	Description	Type	État
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 api create

Modifier

Créez une API Gestion des API.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Exemples

Créez une API de base.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Paramètres obligatoires

--api-id

Nom unique de l’API à créer.

Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

--display-name

Nom complet de l’API à créer.

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

--path

Chemin d’accès à l’API.

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

--service-name -n

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

Type de l’API.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	graphql, http, soap, websocket

--authorization-scope

Spécifie l’étendue des opérations OAuth.

--authorization-server-id

Spécifie l’ID du serveur d’autorisation OAuth.

--bearer-token-sending-methods

Spécifie les méthodes d’envoi pour le jeton du porteur.

--description

Description de l’API. Peut inclure des balises de mise en forme HTML.

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

--no-wait

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

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

--open-id-provider-id

Spécifie l’openid dans le paramètre d’authentification.

--protocols

Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	http, https, ws, wss

--service-url

URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.

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

--subscription-key-header-name

Spécifie le nom de l’en-tête de clé d’abonnement.

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

--subscription-key-query-param-name

Spécifie le nom du paramètre de chaîne de requête de clé d’abonnement.

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

--subscription-key-required

Spécifie si la clé d’abonnement est requise lors de l’appel à cette API, true - l’API est incluse dans les produits fermés uniquement, false - l’API est incluse dans les produits ouverts seuls, null - il existe une combinaison de produits.

--subscription-required

Si la valeur est true, l’API nécessite une clé d’abonnement sur les demandes.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeur par défaut:	False
Valeurs acceptées:	false, true

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

Modifier

Supprimez une API Gestion des API.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

Paramètres obligatoires

--api-id

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

--service-name -n

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

--delete-revisions

Supprimez toutes les révisions de l’API.

--if-match

ETag de l’entité.

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

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 apim api export

Modifier

Exportez une API Gestion des API.

az apim api export --api-id
                   --ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Exemples

Exportez une API Gestion des API vers un fichier ou retournez une réponse contenant un lien de l’exportation.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

Paramètres obligatoires

--api-id

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision. Modèle d’expression régulière : ^[^*#&+ :<>?]+$.

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

--ef --export-format

Spécifiez le format de l’API d’exportation.

Propriété	Valeur
Valeurs acceptées:	OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

Nom du groupe de ressources. Le nom ne respecte pas la casse.

--service-name -n

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

--file-path -f

Chemin d’accès au fichier spécifié pour exporter l’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

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

Modifier

Importez une API Gestion des API.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Exemples

Importer une API Gestion des API à partir d’un fichier ou d’une URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Paramètres obligatoires

--path

Required. URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API.

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

--service-name -n

Nom de l’instance du service de gestion des API.

--specification-format

Spécifiez le format de l’API importée.

Propriété	Valeur
Valeurs acceptées:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

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

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

--api-revision

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée.

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

--api-type

Type de l’API.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	graphql, http, soap, websocket

--api-version

Décrit la version de l’API. Si vous ajoutez une version à une API non versionnée, une version d’origine est automatiquement créée et répond sur l’URL par défaut.

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

--api-version-set-id

Décrit le jeu de versions à utiliser avec l’API.

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

--description

Description de l’API. Peut inclure des balises de mise en forme HTML.

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

--display-name

Nom complet de cette API.

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

--no-wait

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

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

--protocols

Décrit sur quels protocoles(une ou plusieurs) les opérations de cette API peuvent être appelées.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	http, https, ws, wss

--service-url

URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.

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

--soap-api-type

Type d’API lorsque le format de fichier est WSDL.

--specification-path

Chemin d’accès au fichier spécifié pour importer l’API.

--specification-url

URL spécifiée pour importer l’API.

--subscription-key-header-name

Spécifie le nom de l’en-tête de clé d’abonnement.

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

--subscription-key-query-param-name

Spécifie le nom du paramètre de chaîne de requête de clé d’abonnement.

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

--subscription-required

Si la valeur est true, l’API nécessite une clé d’abonnement sur les demandes.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	false, true

--wsdl-endpoint-name

Nom local du point de terminaison WSDL (port) à importer.

--wsdl-service-name

Nom local du service WSDL à importer.

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

Modifier

Répertorier les API Gestion des API.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

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 de l’instance du service Gestion des 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-display-name

Filtre des API par displayName.

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

--skip

Nombre d’enregistrements à ignorer.

--top

Nombre d’enregistrements à retourner.

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

Modifier

Afficher les détails d’une API Gestion des API.

az apim api show --api-id
                 --resource-group
                 --service-name

Paramètres obligatoires

--api-id

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

--service-name

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

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

Modifier

Mettez à jour une API Gestion des API.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Exemples

Créez une API de base.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Paramètres obligatoires

--api-id

Nom unique de l’API à créer.

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

--service-name -n

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

--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
Valeur par défaut:	[]

--api-type

Type de l’API.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	graphql, http, soap, websocket

--description

Description de l’API. Peut inclure des balises de mise en forme HTML.

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

--display-name

Nom de l’API. Doit être de 1 à 300 caractères.

Propriété	Valeur
Groupe de paramètres:	API 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
Valeur par défaut:	False

--if-match

ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité. La valeur par défaut est None.

--no-wait

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

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

--path

Required. URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API.

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

--protocols

Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	http, https, ws, wss

--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
Valeur par défaut:	[]

--service-url

URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.

Propriété	Valeur
Groupe de paramètres:	API 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
Valeur par défaut:	[]

--subscription-key-header-name

Spécifie le nom de l’en-tête de clé d’abonnement.

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

--subscription-key-query-param-name

Spécifie le nom du paramètre de chaîne de requête de clé d’abonnement.

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

--subscription-required

Si la valeur est true, l’API nécessite une clé d’abonnement sur les demandes.

Propriété	Valeur
Groupe de paramètres:	API Arguments
Valeurs acceptées:	false, true

--tags

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

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

Modifier

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

az apim api wait --api-id
                 --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’api apim soit remplie. (autogenerated)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Paramètres obligatoires

--api-id

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

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.

--created

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

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

--deleted

Attendez la suppression.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

--exists

Attendez que la ressource existe.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

--interval

Intervalle d’interrogation en secondes.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	30

--timeout

Délai maximal d’attente en secondes.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	3600

--updated

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

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

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

Commentaires

Cette page a-t-elle été utile ?

Partager via

az apim api

Commandes

az apim api create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim api delete

Paramètres obligatoires

Paramètres facultatifs

az apim api export

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim api import

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim api list

Paramètres obligatoires

Paramètres facultatifs

az apim api show

Paramètres obligatoires

az apim api update

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim api wait

Exemples

Paramètres obligatoires

Paramètres facultatifs

Commentaires