az apim
Gestire i servizi Gestione API di Azure.
Comandi
Nome | Descrizione | Tipo | Status |
---|---|---|---|
az apim api |
Gestire l'API Gestione API di Azure. |
Nucleo | GA |
az apim api create |
Creare un'API di Gestione API. |
Nucleo | GA |
az apim api delete |
Eliminare un'API di Gestione API. |
Nucleo | GA |
az apim api export |
Esportare un'API di Gestione API. |
Nucleo | GA |
az apim api import |
Importare un'API di Gestione API. |
Nucleo | GA |
az apim api list |
Elencare le API di Gestione API. |
Nucleo | GA |
az apim api operation |
Gestire le operazioni api di Gestione API di Azure. |
Nucleo | GA |
az apim api operation create |
Crea una nuova operazione nell'API. |
Nucleo | GA |
az apim api operation delete |
Elimina l'operazione specificata nell'API. |
Nucleo | GA |
az apim api operation list |
Elencare una raccolta di operazioni per l'API specificata. |
Nucleo | GA |
az apim api operation show |
Ottiene i dettagli dell'operazione API specificata dal relativo identificatore. |
Nucleo | GA |
az apim api operation update |
Aggiorna i dettagli dell'operazione nell'API specificata dal relativo identificatore. |
Nucleo | GA |
az apim api release |
Gestire la versione dell'API Gestione API di Azure. |
Nucleo | GA |
az apim api release create |
Crea una nuova versione per l'API. |
Nucleo | GA |
az apim api release delete |
Elimina la versione specificata nell'API. |
Nucleo | GA |
az apim api release list |
Elenca tutte le versioni di un'API. |
Nucleo | GA |
az apim api release show |
Restituisce i dettagli di una versione dell'API. |
Nucleo | GA |
az apim api release update |
Aggiorna i dettagli della versione dell'API specificata dal relativo identificatore. |
Nucleo | GA |
az apim api revision |
Gestire la revisione dell'API gestione API di Azure. |
Nucleo | GA |
az apim api revision create |
Creare una revisione dell'API. |
Nucleo | GA |
az apim api revision list |
Elenca tutte le revisioni di un'API. |
Nucleo | GA |
az apim api schema |
Gestire gli schemi API di Gestione API di Azure. |
Nucleo | GA |
az apim api schema create |
Creare uno schema api di Gestione API. |
Nucleo | GA |
az apim api schema delete |
Eliminare uno schema api di Gestione API. |
Nucleo | GA |
az apim api schema get-etag |
Ottenere l'etag di uno schema api di Gestione API. |
Nucleo | GA |
az apim api schema list |
Elencare gli schemi api di Gestione API. |
Nucleo | GA |
az apim api schema show |
Visualizzare i dettagli di uno schema api di Gestione API. |
Nucleo | GA |
az apim api schema wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di uno schema apim. |
Nucleo | GA |
az apim api show |
Visualizzare i dettagli di un'API di Gestione API. |
Nucleo | GA |
az apim api update |
Aggiornare un'API di Gestione API. |
Nucleo | GA |
az apim api versionset |
Gestire il set di versioni dell'API Gestione API di Azure. |
Nucleo | GA |
az apim api versionset create |
Crea un set di versioni api. |
Nucleo | GA |
az apim api versionset delete |
Elimina un set di versioni dell'API specifico. |
Nucleo | GA |
az apim api versionset list |
Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata. |
Nucleo | GA |
az apim api versionset show |
Ottiene i dettagli del set di versioni api specificato dal relativo identificatore. |
Nucleo | GA |
az apim api versionset update |
Aggiorna i dettagli dell'API VersionSet specificato dal relativo identificatore. |
Nucleo | GA |
az apim api wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di apim. |
Nucleo | GA |
az apim apply-network-updates |
Aggiornare la risorsa gestione API in esecuzione nella rete virtuale per selezionare le impostazioni di rete aggiornate. |
Nucleo | GA |
az apim backup |
Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti. |
Nucleo | GA |
az apim check-name |
Verifica se un nome di servizio è disponibile per l'uso. |
Nucleo | GA |
az apim create |
Creare un'istanza del servizio Gestione API. |
Nucleo | GA |
az apim delete |
Elimina un servizio Gestione API. |
Nucleo | GA |
az apim deletedservice |
Gestire i servizi di Gestione API di Azure eliminati soft-delete. |
Nucleo | GA |
az apim deletedservice list |
Elencare tutte le istanze dei servizi Gestione API eliminate soft disponibili per annullare l'eliminazione per la sottoscrizione specificata. |
Nucleo | GA |
az apim deletedservice purge |
Ripulire l'istanza del servizio Gestione API eliminata temporanea (la elimina senza alcuna opzione per annullare l'eliminazione). |
Nucleo | GA |
az apim deletedservice show |
Ottenere le istanze del servizio Gestione API eliminate soft disponibili per annullare l'eliminazione in base al nome. |
Nucleo | GA |
az apim graphql |
Gestire l'API GraphQL di Gestione API di Azure. |
Nucleo | GA |
az apim graphql resolver |
Gestire i resolver dell'API GraphQL di Gestione API di Azure. |
Nucleo | GA |
az apim graphql resolver create |
Creare un nuovo sistema di risoluzione nell'API GraphQL o aggiornare uno esistente. |
Nucleo | GA |
az apim graphql resolver delete |
Eliminare il resolver specificato nell'API GraphQL. |
Nucleo | GA |
az apim graphql resolver list |
Elencare una raccolta dei resolver per l'API GraphQL specificata. |
Nucleo | GA |
az apim graphql resolver policy |
Gestire i criteri resolver dell'API GraphQL di Gestione API di Azure. |
Nucleo | GA |
az apim graphql resolver policy create |
Creare o aggiornare la configurazione dei criteri per il livello del resolver dell'API GraphQL. |
Nucleo | GA |
az apim graphql resolver policy delete |
Eliminare la configurazione dei criteri nel resolver api GraphQL. |
Nucleo | GA |
az apim graphql resolver policy list |
Ottenere l'elenco della configurazione dei criteri a livello di resolver dell'API GraphQL. |
Nucleo | GA |
az apim graphql resolver policy show |
Ottenere la configurazione dei criteri a livello di resolver API GraphQL. |
Nucleo | GA |
az apim graphql resolver show |
Ottenere i dettagli del resolver dell'API GraphQL specificato dal relativo identificatore. |
Nucleo | GA |
az apim list |
Elencare le istanze del servizio Gestione API. |
Nucleo | GA |
az apim nv |
Gestire i valori denominati di Gestione API di Azure. |
Nucleo | GA |
az apim nv create |
Creare un valore denominato di Gestione API. |
Nucleo | GA |
az apim nv delete |
Eliminare un valore denominato di Gestione API. |
Nucleo | GA |
az apim nv list |
Elencare i valori denominati di Gestione API. |
Nucleo | GA |
az apim nv show |
Visualizzare i dettagli di un valore denominato di Gestione API. |
Nucleo | GA |
az apim nv show-secret |
Ottiene il segreto di un valore denominato di Gestione API. |
Nucleo | GA |
az apim nv update |
Aggiornare un valore denominato di Gestione API. |
Nucleo | GA |
az apim nv wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un valore denominato apim. |
Nucleo | GA |
az apim product |
Gestire i prodotti Gestione API di Azure. |
Nucleo | GA |
az apim product api |
Gestire le API del prodotto Gestione API di Azure. |
Nucleo | GA |
az apim product api add |
Aggiungere un'API al prodotto specificato. |
Nucleo | GA |
az apim product api check |
Verifica che l'entità API specificata dall'identificatore sia associata all'entità Product. |
Nucleo | GA |
az apim product api delete |
Elimina l'API specificata dal prodotto specificato. |
Nucleo | GA |
az apim product api list |
Elenca una raccolta delle API associate a un prodotto. |
Nucleo | GA |
az apim product create |
Crea un prodotto. |
Nucleo | GA |
az apim product delete |
Elimina prodotto. |
Nucleo | GA |
az apim product list |
Elenca una raccolta di prodotti nell'istanza del servizio specificata. |
Nucleo | GA |
az apim product show |
Ottiene i dettagli del prodotto specificato dal relativo identificatore. |
Nucleo | GA |
az apim product update |
Aggiornare i dettagli del prodotto esistenti. |
Nucleo | GA |
az apim product wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un prodotto apim. |
Nucleo | GA |
az apim restore |
Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti. |
Nucleo | GA |
az apim show |
Visualizzare i dettagli di un'istanza del servizio Gestione API. |
Nucleo | GA |
az apim update |
Aggiornare un'istanza del servizio Gestione API. |
Nucleo | GA |
az apim wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un apim. |
Nucleo | GA |
az apim apply-network-updates
Aggiornare la risorsa gestione API in esecuzione nella rete virtuale per selezionare le impostazioni di rete aggiornate.
az apim apply-network-updates --name
--resource-group
[--location]
[--no-wait]
Esempio
Aggiornare le impostazioni di rete virtuale dell'istanza del servizio Gestione API
az apim apply-network-updates --name MyApim -g MyResourceGroup
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri facoltativi
Ubicazione. Usare i valori ottenuti con az account list-locations
. È possibile configurare il percorso predefinito usando az configure --defaults location=<location>
.
Non attendere il completamento dell'operazione a esecuzione prolungata.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim backup
Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
az apim backup --backup-name
--container-name --storage-account-container
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Esempio
Creare un backup dell'istanza del servizio Gestione API
az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Parametri necessari
Nome del file di backup da creare.
Nome del contenitore dell'account di archiviazione usato per eseguire il backup.
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Chiave di accesso dell'account di archiviazione usata per eseguire il backup.
Nome dell'account di archiviazione usato per eseguire il backup.
Parametri facoltativi
Non attendere il completamento dell'operazione a esecuzione prolungata.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim check-name
Verifica se un nome di servizio è disponibile per l'uso.
az apim check-name --name
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim create
Creare un'istanza del servizio Gestione API.
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Esempio
Creare un servizio Gestione API livello sviluppatore.
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft
Creare un servizio Gestione API a livello di consumo.
az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
--publisher-email email@mydomain.com --publisher-name Microsoft
Parametri necessari
Nome univoco dell'istanza del servizio da creare.
Il nome deve essere univoco a livello globale perché verrà incluso come nome host del gateway come" https://my-api-servicename.azure-api.net'. Vedere esempi.
Indirizzo di posta elettronica per ricevere tutte le notifiche di sistema.
Nome dell'organizzazione da usare nel portale per sviluppatori e notifiche tramite posta elettronica.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri facoltativi
Disabilitare il gateway nell'area master. Valido solo per un servizio Gestione API distribuito in più posizioni.
Applica un certificato client da presentare a ogni richiesta al gateway e consente anche di autenticare il certificato nei criteri nel gateway.
Creare un'identità gestita per il servizio Gestione API per accedere ad altre risorse di Azure. Deve essere usato solo per il servizio SKU a consumo.
Ubicazione. Usare i valori ottenuti con az account list-locations
. È possibile configurare il percorso predefinito usando az configure --defaults location=<location>
.
Non attendere il completamento dell'operazione a esecuzione prolungata.
Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Se impostato su true, gli endpoint privati sono il metodo di accesso esclusivo.
Numero di unità distribuite dello SKU.
SKU dell'istanza di Gestione API.
Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.
Tipo di rete virtuale.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim delete
Elimina un servizio Gestione API.
az apim delete --name
--resource-group
[--no-wait]
[--yes]
Esempio
Eliminare un servizio Gestione API.
az apim delete -n MyApim -g MyResourceGroup
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri facoltativi
Non attendere il completamento dell'operazione a esecuzione prolungata.
Non richiedere conferma.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim list
Elencare le istanze del servizio Gestione API.
az apim list [--resource-group]
Parametri facoltativi
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim restore
Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
az apim restore --backup-name
--container-name --storage-account-container
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Esempio
Ripristina un backup dell'istanza del servizio Gestione API
az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Parametri necessari
Nome del file di backup da ripristinare.
Nome del contenitore dell'account di archiviazione usato per recuperare il backup da.
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Chiave di accesso dell'account di archiviazione usata per recuperare il backup.
Nome dell'account di archiviazione usato per recuperare il backup da .
Parametri facoltativi
Non attendere il completamento dell'operazione a esecuzione prolungata.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim show
Visualizzare i dettagli di un'istanza del servizio Gestione API.
az apim show --name
--resource-group
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim update
Aggiornare un'istanza del servizio Gestione API.
az apim update --name
--resource-group
[--add]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--publisher-email]
[--publisher-name]
[--remove]
[--set]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri facoltativi
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>
.
Disabilitare il gateway nell'area master. Valido solo per un servizio Gestione API distribuito in più posizioni.
Applica un certificato client da presentare a ogni richiesta al gateway e consente anche di autenticare il certificato nei criteri nel gateway.
Creare un'identità gestita per il servizio Gestione API per accedere ad altre risorse di Azure. Deve essere usato solo per il servizio SKU a consumo.
Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.
Non attendere il completamento dell'operazione a esecuzione prolungata.
Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Se impostato su true, gli endpoint privati sono il metodo di accesso esclusivo.
Indirizzo di posta elettronica per ricevere tutte le notifiche di sistema.
Nome dell'organizzazione da usare nel portale per sviluppatori e notifiche tramite posta elettronica.
Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>
.
Numero di unità distribuite dello SKU.
SKU dell'istanza di Gestione API.
Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.
Tipo di rete virtuale.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim wait
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un apim.
az apim wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Esempio
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un apim. (generato automaticamente)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Parametri necessari
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>
.
Parametri facoltativi
Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.
Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Attendere l'eliminazione.
Attendere che la risorsa esista.
Intervallo di polling in secondi.
Attesa massima in secondi.
Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.
Parametri globali
Aumentare la verbosità dei log per visualizzare tutti i log di debug.
Mostra questo messaggio Guida, esci.
Mostra solo gli errori, eliminando gli avvisi.
Formato dell'output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID
.
Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.