az apic api deployment
Remarque
Cette référence fait partie de l’extension apic-extension pour Azure CLI (version 2.57.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de déploiement d’API az apic. En savoir plus sur les extensions.
Commandes pour gérer les déploiements d’API dans le Centre DES API.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az apic api deployment create |
Créez un déploiement d’API ou mettez à jour un déploiement d’API existant. |
Extension | GA |
| az apic api deployment delete |
Supprimer le déploiement d’API. |
Extension | GA |
| az apic api deployment list |
Répertorier une collection de déploiements d’API. |
Extension | GA |
| az apic api deployment show |
Obtenez des détails sur le déploiement de l’API. |
Extension | GA |
| az apic api deployment update |
Mettez à jour le déploiement d’API existant. |
Extension | GA |
az apic api deployment create
Créez un déploiement d’API ou mettez à jour un déploiement d’API existant.
az apic api deployment create --api-id
--definition-id
--deployment-id
--environment-id
--resource-group
--server
--service-name
--title
[--custom-properties]
[--description]Exemples
Créer un déploiement
az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'Paramètres obligatoires
ID de l’API.
ID de ressource de définition au centre d’API.
ID du déploiement de l’API.
ID de ressource d’environnement au centre d’API.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.
Server Support shorthand-syntax, json-file et yaml-file. Essayez « ?? » pour en montrer plus.
Nom du service Du Centre des API Azure.
Titre du déploiement.
Paramètres facultatifs
Métadonnées personnalisées définies pour les entités du catalogue d’API. Prendre en charge json-file et yaml-file.
Description du déploiement.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az apic api deployment delete
Supprimer le déploiement d’API.
az apic api deployment delete [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]Exemples
Supprimer le déploiement d’API
az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-apiParamètres facultatifs
ID de l’API.
ID du déploiement de l’API.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.
Nom du service Du Centre des API Azure.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Ne pas demander de confirmation.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az apic api deployment list
Répertorier une collection de déploiements d’API.
az apic api deployment list --api-id
--resource-group
--service-name
[--filter]
[--max-items]
[--next-token]Exemples
Répertorier les déploiements d’API
az apic api deployment list -g api-center-test -n contoso --api-id echo-apiParamètres obligatoires
ID de l’API.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.
Nom du service Du Centre des API Azure.
Paramètres facultatifs
Paramètre de filtre OData.
Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.
Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az apic api deployment show
Obtenez des détails sur le déploiement de l’API.
az apic api deployment show [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]Exemples
Afficher les détails du déploiement d’API
az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-apiParamètres facultatifs
ID de l’API.
ID du déploiement de l’API.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.
Nom du service Du Centre des API Azure.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az apic api deployment update
Mettez à jour le déploiement d’API existant.
az apic api deployment update [--add]
[--api-id]
[--custom-properties]
[--definition-id]
[--deployment-id]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--server]
[--service-name]
[--set]
[--subscription]
[--title]Exemples
Mettre à jour le déploiement d’API
az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-apiParamètres facultatifs
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 ou JSON string>.
ID de l’API.
Métadonnées personnalisées définies pour les entités du catalogue d’API. Prendre en charge json-file et yaml-file.
ID de ressource de définition délimitée par le service.
ID du déploiement de l’API.
Description du déploiement.
ID de ressource d’environnement délimité par le service.
Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.
Server Support shorthand-syntax, json-file et yaml-file. Essayez « ?? » pour en montrer plus.
Nom du service Du Centre des API Azure.
Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Titre.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour