Partager via

az apic environment

Note

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 un environnement az apic commande. Apprenez-en davantage 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 un environnement

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Paramètres obligatoires

--environment-id

ID de l’environnement.

--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 du service Du Centre des API Azure.

--title

Titre de l’environnement.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--type

Type d’environnement.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: development, production, staging, testing

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.

--custom-properties

Métadonnées personnalisées définies pour les entités du catalogue d’API. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--description

Description de l’environnement.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--onboarding

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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--server

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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
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 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 public

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.

--environment-id

ID de l’environnement.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id 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>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name -n

Nom du service Du Centre des API Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
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/.

--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 apic environment list

Répertorier une collection d’environnements.

az apic environment list --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Exemples

Liste des environnements

az apic environment list -g api-center-test -n contosoeuap

Paramètres obligatoires

--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 du service Du Centre des API Azure.

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.

--filter

Paramètre de filtre OData.

--max-items

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 argument d’une commande suivante.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--next-token

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.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
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 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 public

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.

--environment-id

ID de l’environnement.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id 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>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name -n

Nom du service Du Centre des API Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
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/.

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

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

Métadonnées personnalisées définies pour les entités du catalogue d’API. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--description

Description.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--environment-id

ID de l’environnement.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--onboarding

{developerPortalUri :['https://developer.contoso.com'],instructions :'instructions markdown'} Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--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
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--server

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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--service-name -n

Nom du service Du Centre des API Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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
--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.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--title

Titre de l’environnement.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--type

Type d’environnement.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: development, production, staging, testing
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/.

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