Partager via

az apim api schema

Gérer le schéma de l’API Gestion des API Azure.

Commandes

Nom Description Type État
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épertorier les schémas de l’API Gestion des 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 actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: API 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>.

--schema-id

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

Schema identifier. Doit être unique dans l’instance actuelle du service Gestion des API.

Propriété Valeur
Parameter group: Schema Arguments
--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.

Propriété Valeur
Parameter group: Schema Arguments
--service-name -n

Nom de l’instance du service Gestion des API.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Propriété Valeur
Valeur par défaut: False
--resource-type

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

Propriété Valeur
Parameter group: Schema Arguments
--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 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

Output format.

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

API identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: API 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>.

--schema-id

Schema identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: Schema Arguments
--service-name -n

Nom de l’instance du service Gestion des API.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

ETag de l’entité.

--no-wait

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

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

Output format.

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

API identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: API 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>.

--schema-id

Schema identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: Schema Arguments
--service-name -n

Nom de l’instance du service Gestion des API.

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

Output format.

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

Modifier

Répertorier les schémas de l’API Gestion des 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

API identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: API 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>.

--service-name -n

Nom de l’instance du service Gestion des API.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter-display-name

Filtre des API par displayName.

Propriété Valeur
Parameter group: Schema Arguments
--skip

Nombre d’enregistrements à ignorer.

--top

Nombre d’enregistrements à retourner.

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

Output format.

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

API identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: API 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>.

--schema-id

Schema identifier. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Parameter group: Schema Arguments
--service-name -n

Nom de l’instance du service Gestion des API.

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

Output format.

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 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 actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision. Required.

--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 à l’aide de az configure --defaults group=<name>.

--schema-id

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Propriété Valeur
Parameter group: Wait Condition Arguments
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'].

Propriété Valeur
Parameter group: Wait Condition Arguments
--deleted

Attendez la suppression.

Propriété Valeur
Parameter group: Wait Condition Arguments
Valeur par défaut: False
--exists

Attendez que la ressource existe.

Propriété Valeur
Parameter group: Wait Condition Arguments
Valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

Propriété Valeur
Parameter group: Wait Condition Arguments
Valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

Propriété Valeur
Parameter group: Wait Condition Arguments
Valeur par défaut: 3600
--updated

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

Propriété Valeur
Parameter group: Wait Condition Arguments
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

Output format.

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