az apim api schema

  • Riferimento

Gestire lo schema dell'API Gestione API di Azure.

Comandi

Nome Descrizione Tipo Stato
az apim api schema create

Creare uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema delete

Eliminare uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema get-etag

Ottenere l'etag di uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema list

Elencare Gestione API schema API.

 Memoria centrale Disponibilità generale
az apim api schema show

Visualizzare i dettagli di uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di uno schema apim.

 Memoria centrale Disponibilità generale

az apim api schema create

Modifica

Creare uno schema API Gestione 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]

Esempio

Creare uno schema API.

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

Parametri necessari

--api-id

Nome univoco dell'API per cui deve essere creato lo schema.

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--schema-id

Nome univoco dello schema api da creare.

Identificatore dello schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--schema-type

Tipo di schema (ad esempio application/json, application/vnd.ms-azure-apim.graphql.schema).

Deve essere un tipo di supporto valido usato in un'intestazione Content-Type, come definito nella RFC 2616. Tipo di supporto del documento dello schema.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

valore predefinito: False
--resource-type

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts".

--schema-content

Stringa con escape JSON che definisce il documento che rappresenta lo schema.

Specificare --schema-path o --schema-content non entrambi.

--schema-name

Nome della risorsa dello schema.

--schema-path

Percorso del file specificato per importare lo schema dell'API.

Specificare --schema-path o --schema-content non entrambi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api schema delete

Modifica

Eliminare uno schema API Gestione API.

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

Esempio

eliminare uno schema API.

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

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--schema-id

Identificatore dello schema. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--if-match

ETag dell'entità.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

valore predefinito: False
--yes -y

Indica che non è richiesta la conferma.

valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api schema get-etag

Modifica

Ottenere l'etag di uno schema API Gestione API.

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

Esempio

ottenere un tag di entità dello schema.

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

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--schema-id

Identificatore dello schema. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api schema list

Modifica

Elencare Gestione API schema API.

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

Esempio

Ottenere l'elenco degli schemi associati a un ID API.

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

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--filter-display-name

Filtro delle API in base a displayName.

--skip

Numero di record da ignorare.

--top

Numero di record da restituire.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api schema show

Modifica

Visualizzare i dettagli di uno schema API Gestione API.

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

Esempio

Ottenere uno schema API.

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

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--schema-id

Identificatore dello schema. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api schema wait

Modifica

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di uno schema apim.

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

Esempio

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di uno schema dell'APIm.

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

Parametri necessari

--api-id

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione. Obbligatorio.

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--schema-id

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API. Obbligatorio.

Parametri facoltativi

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendere l'eliminazione.

valore predefinito: False
--exists

Attendere che la risorsa esista.

valore predefinito: False
--interval

Intervallo di polling in secondi.

valore predefinito: 30
--timeout

Attesa massima in secondi.

valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.