Condividi tramite

az apic api

  • 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 api . Altre informazioni sulle estensioni.

Comandi per gestire le API nel Centro API.

Comandi

Nome Descrizione Tipo Status
az apic api create

Registrare una nuova API o aggiornare un'API esistente.

 Estensione Disponibilità generale
az apic api definition

Comandi per gestire le definizioni API nel Centro API.

 Estensione Disponibilità generale
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 delete

Eliminare l'API specificata.

 Estensione Disponibilità generale
az apic api deployment

Comandi per gestire le distribuzioni API nel Centro API.

 Estensione Disponibilità generale
az apic api deployment create

Creare una nuova distribuzione api o aggiornare una distribuzione API esistente.

 Estensione Disponibilità generale
az apic api deployment delete

Eliminare la distribuzione dell'API.

 Estensione Disponibilità generale
az apic api deployment list

Elencare una raccolta di distribuzioni api.

 Estensione Disponibilità generale
az apic api deployment show

Ottenere i dettagli della distribuzione dell'API.

 Estensione Disponibilità generale
az apic api deployment update

Aggiornare la distribuzione dell'API esistente.

 Estensione Disponibilità generale
az apic api list

Elencare una raccolta di API.

 Estensione Disponibilità generale
az apic api register

Registra una nuova API con la versione, la definizione e le distribuzioni associate usando il file di specifica come origine della verità. Per il momento è supportato solo il formato JSON/YAML OpenAPI.

 Estensione Anteprima
az apic api show

Ottenere i dettagli dell'API.

 Estensione Disponibilità generale
az apic api update

Aggiornare l'API esistente.

 Estensione Disponibilità generale
az apic api version

Comandi per gestire le versioni dell'API nel Centro API.

 Estensione Disponibilità generale
az apic api version create

Creare una nuova versione dell'API o aggiornare una versione dell'API esistente.

 Estensione Disponibilità generale
az apic api version delete

Eliminare la versione dell'API specificata.

 Estensione Disponibilità generale
az apic api version list

Elencare una raccolta di versioni dell'API.

 Estensione Disponibilità generale
az apic api version show

Ottenere i dettagli della versione dell'API.

 Estensione Disponibilità generale
az apic api version update

Aggiornare la versione dell'API esistente.

 Estensione Disponibilità generale

az apic api create

Registrare una nuova API o aggiornare un'API esistente.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Esempio

Create API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Creare un'API con proprietà personalizzate

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Parametri necessari

--api-id

ID dell'API.

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

--title

Titolo API.

--type

Tipo di API.

Valori accettati: graphql, grpc, rest, soap, webhook, websocket

Parametri facoltativi

--contacts

Informazioni di contatto per l'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supporto di json-file e yaml-file.

--description

Descrizione dell'API.

--external-documentation

Documentazione esterna aggiuntiva per l'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--license

Informazioni sulla licenza per l'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--summary

Breve descrizione dell'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 apic api delete

Eliminare l'API specificata.

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

Esempio

Eliminare l'API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Parametri facoltativi

--api-id

ID dell'API.

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

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

Elencare una raccolta di API.

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

Esempio

Elencare le API

az apic api list -g contoso-resources -n contoso

Elencare le API con filtro

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

Anteprima

Questo comando è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Registra una nuova API con la versione, la definizione e le distribuzioni associate usando il file di specifica come origine della verità. Per il momento è supportato solo il formato JSON/YAML OpenAPI.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Esempio

Registrare l'API specificando il file delle specifiche.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Parametri necessari

--api-location -l

Percorso del file di specifiche.

--resource-group -g

Nome del gruppo di risorse.

--service-name -n

ApiCenter Catalog o Nome servizio.

Parametri facoltativi

--environment-id

ID dell'ambiente creato 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 api show

Ottenere i dettagli dell'API.

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

Esempio

Visualizzare i dettagli dell'API

az apic api show -g contoso-resources -n contoso --api-id echo-api

Parametri facoltativi

--api-id

ID dell'API.

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

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

Aggiornare l'API esistente.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Esempio

Aggiornare l'API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Aggiornare le proprietà personalizzate

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

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.

--api-id

ID dell'API.

--contacts

Informazioni di contatto per l'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supporto di json-file e yaml-file.

--description

Descrizione dell'API.

--external-documentation

Documentazione esterna aggiuntiva per l'API. 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'.

--license

Informazioni sulla licenza per l'API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

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

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

--summary

Breve descrizione dell'API.

--title

Titolo API.

--type

Tipo di API.

Valori accettati: graphql, grpc, rest, soap, webhook, websocket
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.