Partager via

az apim api

  • Référence

Gérez les API Azure Gestion des API.

Commandes

Nom Description Type Statut
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épertoriez les Gestion des API API.

 Core GA
az apim api operation

Gérer les opérations d’API Azure Gestion des API.

 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

Mises à 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 Azure Gestion des API.

 Core GA
az apim api release create

Crée une nouvelle version de 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

Mises à jour les détails de la version de l’API spécifiée par son identificateur.

 Core GA
az apim api revision

Gérer la révision de l’API Azure Gestion des API.

 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érez les schémas d’API Azure Gestion des API.

 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épertoriez Gestion des API schéma d’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 Azure Gestion des API.

 Core GA
az apim api versionset create

Crée un jeu de versions d’API.

 Core GA
az apim api versionset delete

Supprime un ensemble de versions d’API spécifique.

 Core GA
az apim api versionset list

Répertorie une collection d’ensembles 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

Mises à 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 de service Gestion des API actuelle. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

--display-name

Nom complet de l’API à créer.

--path

Chemin d’accès à l’API.

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

Paramètres facultatifs

--api-type

Type de l’API.

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 comporter des balises de mise en forme.

--no-wait

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

valeur par défaut: False
--open-id-provider-id

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

--protocols

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

valeurs acceptées: http, https, ws, wss
--service-url

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

--subscription-key-header-name

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

--subscription-key-query-param-name

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

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

valeurs acceptées: false, true
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 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 de service Gestion des API actuelle. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

Paramètres facultatifs

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

valeur par défaut: False
--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 apim api export

Modifier

Exportez une API Gestion des API.

az apim api export --api-id
                   --ef {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 de service Gestion des API actuelle. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision. Modèle Regex : ^[^*#&+ :<>?] +$.

--ef --export-format

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

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

--file-path -f

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

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

Obligatoire. URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API.

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

--specification-format

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

valeurs acceptées: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Paramètres facultatifs

--api-id

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

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

--api-type

Type de l’API.

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.

--api-version-set-id

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

--description

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

--display-name

Nom complet de cette API.

--no-wait

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

valeur par défaut: False
--protocols

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

valeurs acceptées: http, https, ws, wss
--service-url

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

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

--subscription-key-query-param-name

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

--subscription-required

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

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

Modifier

Répertoriez les Gestion des API 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 en utilisant az configure --defaults group=<name>.

--service-name -n

Nom de l’instance de service Gestion des API.

Paramètres facultatifs

--filter-display-name

Filtre des API par displayName.

--skip

Nombre d’enregistrements à ignorer.

--top

Nombre d’enregistrements à renvoyer.

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 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 de service Gestion des API actuelle. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

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

Nom de l’instance de service Gestion des API.

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

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

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

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 or JSON string>.

valeur par défaut: []
--api-type

Type de l’API.

valeurs acceptées: graphql, http, soap, websocket
--description

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

--display-name

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

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

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.

valeur par défaut: False
--path

Obligatoire. URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API.

--protocols

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

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.

valeur par défaut: []
--service-url

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

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

valeur par défaut: []
--subscription-key-header-name

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

--subscription-key-query-param-name

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

--subscription-required

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

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 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 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. (généré automatiquement)

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

Paramètres obligatoires

--api-id

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

--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 en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--created

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

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

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

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

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.