az apic

Nota

Questo riferimento fa parte dell'estensione pic-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 . Altre sulle estensioni.

Gestire i servizi del Centro API di Azure.

Comandi

Nome	Descrizione	Tipo	Status
az apic api	Comandi per gestire le API nel Centro API.	Estensione	GA
az apic api create	Registrare una nuova API o aggiornare un'API esistente.	Estensione	GA
az apic api definition	Comandi per gestire le definizioni API nel Centro API.	Estensione	GA
az apic api definition create	Creare una nuova definizione API o aggiornare una definizione API esistente.	Estensione	GA
az apic api definition delete	Eliminare la definizione API specificata.	Estensione	GA
az apic api definition export-specification	Esporta la specifica dell'API.	Estensione	GA
az apic api definition import-specification	Importa la specifica dell'API.	Estensione	GA
az apic api definition list	Elencare una raccolta di definizioni API.	Estensione	GA
az apic api definition show	Ottenere i dettagli della definizione dell'API.	Estensione	GA
az apic api definition update	Aggiornare la definizione dell'API esistente.	Estensione	GA
az apic api delete	Eliminare l'API specificata.	Estensione	GA
az apic api deployment	Comandi per gestire le distribuzioni API nel Centro API.	Estensione	GA
az apic api deployment create	Creare una nuova distribuzione api o aggiornare una distribuzione API esistente.	Estensione	GA
az apic api deployment delete	Eliminare la distribuzione dell'API.	Estensione	GA
az apic api deployment list	Elencare una raccolta di distribuzioni api.	Estensione	GA
az apic api deployment show	Ottenere i dettagli della distribuzione dell'API.	Estensione	GA
az apic api deployment update	Aggiornare la distribuzione dell'API esistente.	Estensione	GA
az apic api list	Elencare una raccolta di API.	Estensione	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.	Estensione	Anteprima
az apic api show	Ottenere i dettagli dell'API.	Estensione	GA
az apic api update	Aggiornare l'API esistente.	Estensione	GA
az apic api version	Comandi per gestire le versioni dell'API nel Centro API.	Estensione	GA
az apic api version create	Creare una nuova versione dell'API o aggiornare una versione dell'API esistente.	Estensione	GA
az apic api version delete	Eliminare la versione dell'API specificata.	Estensione	GA
az apic api version list	Elencare una raccolta di versioni dell'API.	Estensione	GA
az apic api version show	Ottenere i dettagli della versione dell'API.	Estensione	GA
az apic api version update	Aggiornare la versione dell'API esistente.	Estensione	GA
az apic create	Crea un'istanza o aggiorna un'istanza esistente di un servizio Centro API di Azure.	Estensione	GA
az apic delete	Elimina un'istanza di un servizio Centro API di Azure.	Estensione	GA
az apic environment	Comandi per gestire gli ambienti nel Centro API.	Estensione	GA
az apic environment create	Creare un nuovo ambiente o aggiornare un ambiente esistente.	Estensione	GA
az apic environment delete	Eliminare l'ambiente.	Estensione	GA
az apic environment list	Elencare una raccolta di ambienti.	Estensione	GA
az apic environment show	Ottenere i dettagli dell'ambiente.	Estensione	GA
az apic environment update	Aggiornare l'ambiente esistente.	Estensione	GA
az apic import	Gestire i servizi del Centro API di Azure.	Estensione	GA
az apic import-from-apim	Importa le API da un'istanza del servizio Gestione API di Azure.	Estensione	GA
az apic import aws	Importare un'origine API di Amazon API Gateway.	Estensione	Anteprima
az apic integration	Gestisce le integrazioni nel Centro API di Azure.	Estensione	Anteprima
az apic integration create	Gestire i servizi del Centro API di Azure.	Estensione	Anteprima
az apic integration create apim	Aggiungere Gestione API di Azure come origine API.	Estensione	Anteprima
az apic integration create aws	Aggiungere Amazon API Gateway come origine API.	Estensione	Anteprima
az apic integration delete	Eliminare l'origine API specificata.	Estensione	Anteprima
az apic integration list	Elencare una raccolta di origini API.	Estensione	Anteprima
az apic integration show	Ottenere i dettagli dell'origine API.	Estensione	Anteprima
az apic list	Elenca i servizi del Centro API di Azure all'interno di una sottoscrizione di Azure.	Estensione	GA
az apic metadata	Comandi per gestire gli schemi di metadati nel Centro API.	Estensione	GA
az apic metadata create	Creare un nuovo schema di metadati o aggiornare uno schema di metadati esistente.	Estensione	GA
az apic metadata delete	Eliminare lo schema dei metadati specificato.	Estensione	GA
az apic metadata export	Esporta lo schema dei metadati.	Estensione	GA
az apic metadata list	Elencare una raccolta di schemi di metadati.	Estensione	GA
az apic metadata show	Ottenere i dettagli dello schema dei metadati.	Estensione	GA
az apic metadata update	Aggiornare lo schema dei metadati esistente.	Estensione	GA
az apic show	Visualizzare i dettagli di un'istanza del servizio Centro API di Azure.	Estensione	GA
az apic update	Aggiornare un'istanza di un servizio Centro API di Azure.	Estensione	GA

az apic create

Crea un'istanza o aggiorna un'istanza esistente di un servizio Centro API di Azure.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Esempio

Esempio di creazione del servizio

az apic create -g contoso-resources -n contoso -l eastus

Esempio di creazione del servizio con identità assegnata dal sistema

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

Parametri necessari

--name -n

Nome del servizio Centro API.

--resource-group -g

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

Parametri facoltativi

--identity

Identità del servizio gestito assegnate a questa risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--location -l

Posizione geografica in cui si trova la risorsa Se non specificato, verrà usata la posizione del gruppo di risorse.

--tags

Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic delete

Elimina un'istanza di un servizio Centro API di Azure.

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

Esempio

Eliminare il servizio

az apic delete -n contoso -g contoso-resources

Parametri facoltativi

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

--name -n

Nome del servizio Centro API.

--resource-group -g

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

--subscription

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

--yes -y

Non richiedere conferma.

Valore predefinito: False

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic import-from-apim

Importa le API da un'istanza del servizio Gestione API di Azure.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Esempio

Importare tutte le API da Gestione API nello stesso gruppo di risorse

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importare le API selezionate da Gestione API nello stesso gruppo di risorse

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importare tutte le API da Gestione API in un'altra sottoscrizione e in un altro gruppo di risorse

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Parametri necessari

--apim-apis

API da importare. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--apim-name

Nome dell'istanza di Gestione API di origine.

Parametri facoltativi

--apim-resource-group

Gruppo di risorse dell'istanza di Gestione API di origine.

--apim-subscription

ID sottoscrizione dell'istanza di Gestione API di origine.

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

--no-wait

Non attendere il completamento 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 usando 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

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic list

Elenca i servizi del Centro API di Azure all'interno di una sottoscrizione di Azure.

Esiste un problema noto che elenca tutte le risorse in una sottoscrizione non funziona. Elencare le risorse per gruppo di risorse.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Esempio

Elencare i servizi nel gruppo di risorse

az apic list -g contoso-resources

Parametri facoltativi

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

--next-token

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

--resource-group -g

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

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic show

Visualizzare i dettagli di un'istanza del servizio Centro API di Azure.

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

Esempio

Mostra i dettagli del servizio

az apic show -g contoso-resources -n contoso

Parametri facoltativi

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

--name -n

Nome del servizio Centro API.

--resource-group -g

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

--subscription

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

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic update

Aggiornare un'istanza di un servizio Centro API di Azure.

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

Esempio

Aggiornare i dettagli del servizio

az apic update -g contoso-resources -n contoso

Esempio di aggiornamento del servizio con identità assegnata dal sistema

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

Parametri facoltativi

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

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

--identity

Identità del servizio gestito assegnate a questa risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

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

--name -n

Nome del servizio Centro API.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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