az apic api definition
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 api definition . Altre informazioni sulle estensioni.
Comandi per gestire le definizioni API nel Centro API.
Comandi
| Nome | Descrizione | Tipo | Stato |
|---|---|---|---|
| az apic api definition create |
Creare una nuova definizione API o aggiornare una definizione API esistente. |
Estensione | Disponibilità generale |
| az apic api definition delete |
Eliminare la definizione API specificata. |
Estensione | Disponibilità generale |
| az apic api definition export-specification |
Esporta la specifica dell'API. |
Estensione | Disponibilità generale |
| az apic api definition import-specification |
Importa la specifica dell'API. |
Estensione | Disponibilità generale |
| az apic api definition list |
Elencare una raccolta di definizioni API. |
Estensione | Disponibilità generale |
| az apic api definition show |
Ottenere i dettagli della definizione dell'API. |
Estensione | Disponibilità generale |
| az apic api definition update |
Aggiornare la definizione dell'API esistente. |
Estensione | Disponibilità generale |
az apic api definition create
Creare una nuova definizione API o aggiornare una definizione API esistente.
az apic api definition create --api-id
--definition-id
--resource-group
--service
--title
--version-id
[--description]Esempio
Creare la definizione dell'API
az apic api definition create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Parametri necessari
ID dell'API.
ID della definizione dell'API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Versione API.
ID della versione dell'API.
Parametri facoltativi
Descrizione della definizione DELL'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition delete
Eliminare la definizione API specificata.
az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]
[--yes]Esempio
Eliminare la definizione dell'API
az apic api definition delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Parametri facoltativi
ID dell'API.
ID della definizione dell'API.
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'.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
ID della versione dell'API.
Indica che non è richiesta la conferma.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition export-specification
Esporta la specifica dell'API.
az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--subscription]
[--version-id]Esempio
Specifica di esportazione
az apic api version definition export-specification -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id defaultParametri necessari
Nome del file in cui esportare la specifica.
Parametri facoltativi
ID dell'API.
ID della definizione dell'API.
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'.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
ID della versione dell'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition import-specification
Importa la specifica dell'API.
az apic api definition import-specification [--api-id]
[--definition-id]
[--file-name]
[--format {inline, link}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--specification]
[--subscription]
[--value]
[--version-id]Esempio
Esempio di specifica di importazione 1
az apic api definition import-specification -g api-center-test -s contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'Esempio di specifica di importazione 2
az apic api definition import-specification -g api-center-test -s contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'Parametri facoltativi
ID dell'API.
ID della definizione dell'API.
Nome del file da cui importare la specifica.
Formato dell'origine della specifica API.
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'.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Dettagli della specifica DELL'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Valore dell'origine della specifica API.
ID della versione dell'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition list
Elencare una raccolta di definizioni API.
az apic api definition list --api-id
--resource-group
--service
--version-id
[--filter]
[--max-items]
[--next-token]Esempio
Elencare le definizioni api
az apic api definition list -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01Parametri necessari
ID dell'API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
ID della versione dell'API.
Parametri facoltativi
Parametro di filtro OData.
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.
Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition show
Ottenere i dettagli della definizione dell'API.
az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]Esempio
Visualizzare i dettagli della definizione dell'API
az apic api definition show -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Parametri facoltativi
ID dell'API.
ID della definizione dell'API.
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'.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
ID della versione dell'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apic api definition update
Aggiornare la definizione dell'API esistente.
az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service]
[--set]
[--subscription]
[--title]
[--version-id]Esempio
Aggiornare la definizione dell'API
az apic api definition update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Parametri facoltativi
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.
ID dell'API.
ID della definizione dell'API.
Descrizione della definizione DELL'API.
Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.
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'.
Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list OR --remove propertyToRemove.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome del servizio Centro API.
Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Titolo della versione dell'API.
ID della versione dell'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per