Partager via

az apim api operation

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

Commandes

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

Modifier

Crée une opération dans l’API.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params --template-parameters]

Exemples

Crée une opération dans l’API avec plusieurs paramètres

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

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

Required. Nom de l’opération.

--method

Required. Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux.

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

--url-template

Modèle d’URL relative identifiant la ressource cible pour cette opération. Peut inclure des paramètres.

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.

--description

Description de l’opération. Peut inclure des balises de mise en forme HTML.

--if-match

ETag de l’entité.

--operation-id

Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.

--params --template-parameters -p

Collection de paramètres de modèle d’URL.

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

Modifier

Supprime l’opération spécifiée dans l’API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Exemples

Supprime l’opération spécifiée dans l’API.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

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

Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service 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>.

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

--if-match

ETag de l’entité.

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

Modifier

Répertorier une collection des opérations pour l’API spécifiée.

az apim api operation list --api-id
                           --resource-group
                           --service-name

Exemples

Répertorier une collection des opérations pour l’API spécifiée.

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

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

Modifier

Obtient les détails de l’opération d’API spécifiée par son identificateur.

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

Exemples

Obtient les détails de l’opération d’API spécifiée par son identificateur.

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

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

Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service 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>.

--service-name -n

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

Modifier

Met à jour les détails de l’opération dans l’API spécifiée par son identificateur.

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Exemples

Méthode de mise à jour, nom d’affichage, description de l’opération dans l’API spécifiée par son identificateur.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

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

Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service 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>.

--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: []
--description

Description de l’opération. Peut inclure des balises de mise en forme HTML.

--display-name

Required. Nom de l’opération.

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

--method

Required. Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux.

--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: []
--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: []
--url-template

Modèle d’URL relative identifiant la ressource cible pour cette opération. Peut inclure des paramètres.

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