Partager via

az spring api-portal

  • Référence

Remarque

Cette référence fait partie de l’extension spring pour Azure CLI (version 2.56.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az spring api-portal . En savoir plus sur les extensions.

(Niveau Entreprise uniquement) Commandes pour gérer le portail d’API dans Azure Spring Apps.

Commandes

Nom Description Type Statut
az spring api-portal clear

Effacez tous les paramètres du portail d’API.

 Extension GA
az spring api-portal create

Créez le portail d’API.

 Extension GA
az spring api-portal custom-domain

Commandes permettant de gérer des domaines personnalisés pour le portail d’API.

 Extension GA
az spring api-portal custom-domain bind

Lier un domaine personnalisé au portail d’API.

 Extension GA
az spring api-portal custom-domain list

Répertoriez tous les domaines personnalisés du portail d’API.

 Extension GA
az spring api-portal custom-domain show

Afficher les détails d’un domaine personnalisé.

 Extension GA
az spring api-portal custom-domain unbind

Dissociez un domaine personnalisé du portail d’API.

 Extension GA
az spring api-portal custom-domain update

Mettez à jour un domaine personnalisé du portail d’API.

 Extension GA
az spring api-portal delete

Supprimer le portail d’API.

 Extension GA
az spring api-portal show

Affichez les paramètres, l’état d’approvisionnement et l’état d’exécution du portail d’API.

 Extension GA
az spring api-portal update

Mettez à jour les propriétés existantes du portail d’API.

 Extension GA

az spring api-portal clear

Effacez tous les paramètres du portail d’API.

az spring api-portal clear --resource-group
                           --service

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide d’az configure --defaults spring=.

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 spring api-portal create

Créez le portail d’API.

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Exemples

Créez le portail d’API.

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide d’az configure --defaults spring=.

Paramètres facultatifs

--instance-count

Nombre d’instances.

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 spring api-portal delete

Supprimer le portail d’API.

az spring api-portal delete --resource-group
                            --service
                            [--yes]

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide d’az configure --defaults spring=.

Paramètres facultatifs

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
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 spring api-portal show

Affichez les paramètres, l’état d’approvisionnement et l’état d’exécution du portail d’API.

az spring api-portal show --resource-group
                          --service

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide d’az configure --defaults spring=.

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 spring api-portal update

Mettez à jour les propriétés existantes du portail d’API.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Exemples

Mettre à jour la propriété du portail d’API.

az spring api-portal update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide d’az configure --defaults spring=.

Paramètres facultatifs

--assign-endpoint

Si la valeur est true, affectez l’URL du point de terminaison pour l’accès direct.

valeurs acceptées: false, true
--client-id

Identificateur public de l’application.

--client-secret

Secret connu uniquement pour l’application et le serveur d’autorisation.

--enable-api-try-out

Essayez l’API en envoyant des demandes et en affichant des réponses dans le portail d’API.

valeurs acceptées: false, true
--https-only

Si la valeur est true, accédez au point de terminaison via https.

valeurs acceptées: false, true
--instance-count

Nombre d’instances.

--issuer-uri

URI de l’identificateur de l’émetteur.

--scope

La liste séparée par des virgules des applications d’actions spécifiques peut être autorisée à effectuer au nom d’un utilisateur.

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.