az apic environment
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 d’environnement az apic. En savoir plus sur les extensions.
Commandes pour gérer les environnements dans le Centre DES API.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az apic environment create |
Créez un environnement ou mettez à jour un environnement existant. |
Extension | GA |
| az apic environment delete |
Supprimez l’environnement. |
Extension | GA |
| az apic environment list |
Répertorier une collection d’environnements. |
Extension | GA |
| az apic environment show |
Obtenez des détails sur l’environnement. |
Extension | GA |
| az apic environment update |
Mettez à jour l’environnement existant. |
Extension | GA |
az apic environment create
Créez un environnement ou mettez à jour un environnement existant.
az apic environment create --environment-id
--resource-group
--service-name
--title
--type {development, production, staging, testing}
[--custom-properties]
[--description]
[--onboarding]
[--server]Exemples
Créer l’environnement
az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"Paramètres obligatoires
ID de l’environnement.
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.
Titre de l’environnement.
Type d’environnement.
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 de l’environnement.
Fournissez une documentation d’intégration relative à votre environnement, par exemple {developerPortalUri :['https://developer.contoso.com],instructions :'instructions markdown'} Prennent en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.
Informations sur le serveur de l’environnement. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.
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 environment delete
Supprimez l’environnement.
az apic environment delete [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]Exemples
Supprimer un environnement
az apic environment delete -g api-center-test -n contosoeuap --environment-id publicParamètres facultatifs
ID de l’environnement.
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 environment list
Répertorier une collection d’environnements.
az apic environment list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]Exemples
Lister les environnements
az apic environment list -g api-center-test -n contosoeuapParamètres obligatoires
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 environment show
Obtenez des détails sur l’environnement.
az apic environment show [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]Exemples
Afficher les détails de l’environnement
az apic environment show -g api-center-test -n contosoeuap --environment-id publicParamètres facultatifs
ID de l’environnement.
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 environment update
Mettez à jour l’environnement existant.
az apic environment update [--add]
[--custom-properties]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--onboarding]
[--remove]
[--resource-group]
[--server]
[--service-name]
[--set]
[--subscription]
[--title]
[--type {development, production, staging, testing}]Exemples
Mettre à jour l’environnement
az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"Paramè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>.
Métadonnées personnalisées définies pour les entités du catalogue d’API. Prendre en charge json-file et yaml-file.
La description.
ID de l’environnement.
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 ».
{developerPortalUri :['https://developer.contoso.com],instructions :'instructions markdown'} Prise en charge de la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.
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>.
Informations sur le serveur de l’environnement. Prendre en charge la syntaxe abrégée, 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 de l’environnement.
Type d’environnement.
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