Partager via

az apim api schema

  • Référence

Gérez les schémas d’API Azure Gestion des API.

Commandes

Nom Description Type Statut
az apim api schema create

Créez un schéma d’API Gestion des API.

 Core GA
az apim api schema delete

Supprimez un schéma d’API Gestion des API.

 Core GA
az apim api schema get-etag

Obtenir un etag d’un schéma d’API Gestion des API.

 Core GA
az apim api schema list

Répertoriez Gestion des API schéma d’API.

 Core GA
az apim api schema show

Afficher les détails d’un schéma d’API Gestion des API.

 Core GA
az apim api schema wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un schéma d’API apim soit remplie.

 Core GA

az apim api schema create

Modifier

Créez un schéma d’API Gestion des API.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Exemples

Créez un schéma d’API.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Paramètres obligatoires

--api-id

Nom unique de l’API pour laquelle le schéma doit être créé.

Identificateur de révision 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>.

--schema-id

Nom unique du schéma d’API à créer.

Identificateur de schéma. Doit être unique dans l’instance de service Gestion des API actuelle.

--schema-type

Type de schéma (par exemple, application/json, application/vnd.ms-azure-apim.graphql.schema).

Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans le RFC 2616. Type de média du document de schéma.

--service-name -n

Nom de l’instance de service Gestion des API.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--resource-type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft. Stockage/storageAccounts ».

--schema-content

Chaîne d’échappement JSON définissant le document représentant le schéma.

Spécifiez --schema-path ou --schema-content non les deux.

--schema-name

Nom de la ressource de schéma.

--schema-path

Chemin d’accès au fichier spécifié pour importer le schéma de l’API.

Spécifiez --schema-path ou --schema-content non les deux.

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

Modifier

Supprimez un schéma d’API Gestion des API.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Exemples

supprimez un schéma d’API.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificateur de schéma. 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.

--service-name -n

Nom de l’instance de service Gestion des API.

Paramètres facultatifs

--if-match

ETag de l’entité.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--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 apim api schema get-etag

Modifier

Obtenir un etag d’un schéma d’API Gestion des API.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Exemples

obtenir une balise d’entité de schéma.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificateur de schéma. 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.

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

Modifier

Répertoriez Gestion des API schéma d’API.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Exemples

Obtenir la liste des schémas associés à un ID d’API.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

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 facultatifs

--filter-display-name

Filtre des API par displayName.

--skip

Nombre d’enregistrements à ignorer.

--top

Nombre d’enregistrements à renvoyer.

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

Modifier

Afficher les détails d’un schéma d’API Gestion des API.

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

Exemples

Obtenir un schéma d’API.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificateur de schéma. 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.

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

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un schéma d’API apim soit remplie.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Exemples

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un schéma d’API apim soit remplie.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Paramètres obligatoires

--api-id

Identificateur de révision 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. Obligatoire.

--name -n

Nom de l’instance du service de gestion des API.

--resource-group -g

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

--schema-id

Identificateur d’ID de schéma. Doit être unique dans l’instance de service Gestion des API actuelle. Obligatoire.

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

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.