az apic
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 . Altre informazioni 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 | Disponibilità generale |
| 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 create |
Crea un'istanza o aggiorna un'istanza esistente di un servizio Centro API di Azure. |
Estensione | Disponibilità generale |
| az apic delete |
Elimina un'istanza di un servizio Centro API di Azure. |
Estensione | Disponibilità generale |
| az apic environment |
Comandi per gestire gli ambienti nel Centro API. |
Estensione | Disponibilità generale |
| az apic environment create |
Creare un nuovo ambiente o aggiornare un ambiente esistente. |
Estensione | Disponibilità generale |
| az apic environment delete |
Elimina l'ambiente. |
Estensione | Disponibilità generale |
| az apic environment list |
Elencare una raccolta di ambienti. |
Estensione | Disponibilità generale |
| az apic environment show |
Ottenere i dettagli dell'ambiente. |
Estensione | Disponibilità generale |
| az apic environment update |
Aggiornare l'ambiente esistente. |
Estensione | Disponibilità generale |
| az apic import-from-apim |
Importa le API da un'istanza del servizio Gestione API di Azure. |
Estensione | Disponibilità generale |
| az apic list |
Elenca i servizi del Centro API di Azure all'interno di una sottoscrizione di Azure. |
Estensione | Disponibilità generale |
| az apic metadata |
Comandi per gestire gli schemi di metadati nel Centro API. |
Estensione | Disponibilità generale |
| 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 show |
Visualizzare i dettagli di un'istanza del servizio Centro API di Azure. |
Estensione | Disponibilità generale |
| az apic update |
Aggiornare un'istanza di un servizio Centro API di Azure. |
Estensione | Disponibilità generale |
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 1
az apic create -g contoso-resources -n contoso -l eastusCreare un esempio di servizio 2
az apic create --resource-group contoso-resources --name contoso --location eastusParametri necessari
Nome del servizio Centro API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Parametri facoltativi
Identità del servizio gestito assegnate a questa risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
Posizione geografica in cui si trova la risorsa Se non specificato, verrà usata la posizione del gruppo di risorse.
Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
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 delete
Elimina un'istanza di un servizio Centro API di Azure.
az apic delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]Esempio
Delete service
az apic delete -n contoso -g contoso-resourcesParametri facoltativi
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 servizio Centro API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
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 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
API da importare. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
Nome dell'istanza di Gestione API di origine.
Parametri facoltativi
Gruppo di risorse dell'istanza di Gestione API di origine.
ID sottoscrizione dell'istanza di Gestione API di origine.
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 di Azure.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
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 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-resourcesParametri facoltativi
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.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
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 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 contosoParametri facoltativi
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 servizio Centro API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
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 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 contosoParametri 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.
Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.
Identità del servizio gestito assegnate a questa risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
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 servizio Centro API.
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>.
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.
Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.
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