az apic api

Note

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.	Extension	GA
az apic api definition	Comandi per gestire le definizioni API nel Centro API.	Extension	GA
az apic api definition create	Creare una nuova definizione API o aggiornare una definizione API esistente.	Extension	GA
az apic api definition delete	Eliminare la definizione API specificata.	Extension	GA
az apic api definition export-specification	Esporta la specifica dell'API.	Extension	GA
az apic api definition import-specification	Importa la specifica dell'API.	Extension	GA
az apic api definition list	Elencare una raccolta di definizioni API.	Extension	GA
az apic api definition show	Ottenere i dettagli della definizione dell'API.	Extension	GA
az apic api definition update	Aggiornare la definizione dell'API esistente.	Extension	GA
az apic api delete	Eliminare l'API specificata.	Extension	GA
az apic api deployment	Comandi per gestire le distribuzioni API nel Centro API.	Extension	GA
az apic api deployment create	Creare una nuova distribuzione api o aggiornare una distribuzione API esistente.	Extension	GA
az apic api deployment delete	Eliminare la distribuzione dell'API.	Extension	GA
az apic api deployment list	Elencare una raccolta di distribuzioni api.	Extension	GA
az apic api deployment show	Ottenere i dettagli della distribuzione dell'API.	Extension	GA
az apic api deployment update	Aggiornare la distribuzione dell'API esistente.	Extension	GA
az apic api list	Elencare una raccolta di API.	Extension	GA
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.	Extension	Preview
az apic api show	Ottenere i dettagli dell'API.	Extension	GA
az apic api update	Aggiornare l'API esistente.	Extension	GA
az apic api version	Comandi per gestire le versioni dell'API nel Centro API.	Extension	GA
az apic api version create	Creare una nuova versione dell'API o aggiornare una versione dell'API esistente.	Extension	GA
az apic api version delete	Eliminare la versione dell'API specificata.	Extension	GA
az apic api version list	Elencare una raccolta di versioni dell'API.	Extension	GA
az apic api version show	Ottenere i dettagli della versione dell'API.	Extension	GA
az apic api version update	Aggiornare la versione dell'API esistente.	Extension	GA

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

Creare un'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}'

Creare un'API con proprietà personalizzate usando il file JSON

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

Parametri necessari

--api-id

ID dell'API.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--title

Titolo API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--type

Tipo di API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	graphql, grpc, rest, soap, webhook, websocket

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--contacts

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--description

Descrizione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--external-documentation

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--license

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--summary

Breve descrizione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

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

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--yes -y

Non richiedere conferma.

Proprietà	Valore
Valore predefinito:	False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

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 usando az configure --defaults group=<name>.

--service-name -n

Nome del servizio Centro API di Azure.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--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 in --next-token argomento di un comando successivo.

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

--next-token

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

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

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

Registrare l'API specificando l'URL della specifica.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --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

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--environment-id

ID dell'ambiente creato in precedenza.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

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

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

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

Aggiornare le proprietà personalizzate usando il file JSON

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Aggiornare singoli metadati personalizzati

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--add

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

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--contacts

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--description

Descrizione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--external-documentation

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--force-string

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

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--ids

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--license

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

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--remove

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

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--set

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

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--subscription

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--summary

Breve descrizione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--title

Titolo API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--type

Tipo di API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	graphql, grpc, rest, soap, webhook, websocket

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

Commenti e suggerimenti

Questa pagina è stata utile?

Condividi tramite

az apic api

Comandi

az apic api create

Esempio

Parametri necessari

Parametri facoltativi

az apic api delete

Esempio

Parametri facoltativi

az apic api list

Esempio

Parametri necessari

Parametri facoltativi

az apic api register

Esempio

Parametri necessari

Parametri facoltativi

az apic api show

Esempio

Parametri facoltativi

az apic api update

Esempio

Parametri facoltativi

Commenti e suggerimenti