Condividi tramite

az apic metadata

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione apic-extension per l'interfaccia della riga di comando di Azure (versione 2.57.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az apic metadata . Altre informazioni sulle estensioni.

Comandi per gestire gli schemi di metadati nel Centro API.

Comandi

Nome Descrizione Tipo Status
az apic metadata create

Creare un nuovo schema di metadati o aggiornare uno schema di metadati esistente.

 Estensione Disponibilità generale
az apic metadata delete

Eliminare lo schema dei metadati specificato.

 Estensione Disponibilità generale
az apic metadata export

Esporta lo schema dei metadati.

 Estensione Disponibilità generale
az apic metadata list

Elencare una raccolta di schemi di metadati.

 Estensione Disponibilità generale
az apic metadata show

Ottenere i dettagli dello schema dei metadati.

 Estensione Disponibilità generale
az apic metadata update

Aggiornare lo schema dei metadati esistente.

 Estensione Disponibilità generale

az apic metadata create

Creare un nuovo schema di metadati o aggiornare uno schema di metadati esistente.

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

Esempio

Esempio di creazione di metadati 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Esempio di creazione di metadati 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

Parametri necessari

--assignments

Definisce l'ambito di assegnazione per i metadati personalizzati, ad esempio "[{entity:api,required:true,deprecato:false}]". I valori di entità disponibili sono: api, distribuzione, ambiente. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--metadata-name

Nome dello schema dei metadati.

--resource-group -g

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

--schema

Schema JSON che definisce il tipo.

--service-name -n

Nome del servizio Centro API di Azure.

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 apic metadata delete

Eliminare lo schema dei metadati specificato.

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

Esempio

Eliminare lo schema dei metadati

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

Elimina schema

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--metadata-name

Nome dello schema dei metadati.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--subscription

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

--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 apic metadata export

Esporta lo schema dei metadati.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

Esempio

Esportare lo schema dei metadati assegnato all'API

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

Esportare lo schema dei metadati assegnato alla distribuzione

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

Esportare lo schema dei metadati assegnato all'ambiente

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

Parametri necessari

--assignments

È richiesta un'entità per cui viene richiesto lo schema dei metadati.

Valori accettati: api, deployment, environment
--file-name

Nome del file in cui esportare lo schema dei metadati.

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--no-wait

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

Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Nome del servizio Centro API.

--subscription

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

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

Elencare una raccolta di schemi di metadati.

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

Esempio

Elencare gli schemi

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

Parametri necessari

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

Parametri facoltativi

--filter

Parametro di filtro OData.

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token nell'argomento --next-token di un comando successivo.

--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

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 apic metadata show

Ottenere i dettagli dello schema dei metadati.

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

Esempio

Mostra i dettagli dello schema 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

Mostra i dettagli dello schema 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--metadata-name

Nome dello schema dei metadati.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--subscription

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

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 apic metadata update

Aggiornare lo schema dei metadati esistente.

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

Esempio

Aggiornare lo schema

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

Parametri facoltativi

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, stringa o stringa> JSON.

--assignments

Definisce l'ambito di assegnazione per i metadati personalizzati, ad esempio "[{entity:api,required:true,deprecato:false}]". I valori di entità disponibili sono: api, distribuzione, ambiente. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--metadata-name

Nome dello schema dei metadati.

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--schema

Schema YAML che definisce il tipo.

--service-name -n

Nome del servizio Centro API di Azure.

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=.

--subscription

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

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.