Partager via

az apim api release

  • Référence

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

Commandes

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

Modifier

Crée une nouvelle version de l’API.

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--if-match]
                           [--notes]
                           [--release-id]

Exemples

Crée une nouvelle version de l’API.

az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes

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.

--api-revision

Numéro de révision de 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

--if-match

ETag de l’entité.

--notes

Notes de publication.

--release-id

Identificateur de mise en production dans une API. Doit être unique dans l’instance de service Gestion des API actuelle.

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

Modifier

Supprime la version spécifiée dans l’API.

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

Exemples

Supprime la version spécifiée dans l’API.

az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

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.

--release-id

Identificateur de mise en production dans une API. Doit être unique dans l’instance de service Gestion des API actuelle.

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

--if-match

ETag de l’entité.

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

Modifier

Répertorie toutes les versions d’une API.

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

Exemples

Répertorie toutes les versions d’une API.

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

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

Modifier

Retourne les détails d’une version d’API.

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

Exemples

Retourne les détails d’une version d’API.

az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

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.

--release-id

Identificateur de mise en production dans une API. Doit être unique dans l’instance de service Gestion des API actuelle.

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

Modifier

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

az apim api release update --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--add]
                           [--force-string]
                           [--if-match]
                           [--notes]
                           [--remove]
                           [--set]

Exemples

Mises à jour les notes de la publication de l’API spécifiée par son identificateur.

az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes

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.

--release-id

Identificateur de mise en production dans une API. Doit être unique dans l’instance de service Gestion des API actuelle.

--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: []
--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é.

--notes

Notes de publication.

--remove

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

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

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