Condividi tramite

az apim

  • Riferimento

Gestire i servizi Gestione API di Azure.

Comandi

Nome Descrizione Tipo Stato
az apim api

Gestire l'API Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim api create

Creare un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api delete

Eliminare un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api export

Esportare un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api import

Importare un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api list

Elencare Gestione API API.

 Memoria centrale Disponibilità generale
az apim api operation

Gestire le operazioni api di Azure Gestione API.

 Memoria centrale Disponibilità generale
az apim api operation create

Crea una nuova operazione nell'API.

 Memoria centrale Disponibilità generale
az apim api operation delete

Elimina l'operazione specificata nell'API.

 Memoria centrale Disponibilità generale
az apim api operation list

Elencare una raccolta di operazioni per l'API specificata.

 Memoria centrale Disponibilità generale
az apim api operation show

Ottiene i dettagli dell'operazione API specificata dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim api operation update

Aggiornamenti i dettagli dell'operazione nell'API specificata dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim api release

Gestire la versione dell'API Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim api release create

Crea una nuova versione per l'API.

 Memoria centrale Disponibilità generale
az apim api release delete

Elimina la versione specificata nell'API.

 Memoria centrale Disponibilità generale
az apim api release list

Elenca tutte le versioni di un'API.

 Memoria centrale Disponibilità generale
az apim api release show

Restituisce i dettagli di una versione dell'API.

 Memoria centrale Disponibilità generale
az apim api release update

Aggiornamenti i dettagli della versione dell'API specificata dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim api revision

Gestire la revisione dell'API Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim api revision create

Creare una revisione dell'API.

 Memoria centrale Disponibilità generale
az apim api revision list

Elenca tutte le revisioni di un'API.

 Memoria centrale Disponibilità generale
az apim api schema

Gestire lo schema dell'API Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim api schema create

Creare uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema delete

Eliminare uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema get-etag

Ottenere l'etag di uno schema API Gestione API.

 Memoria centrale Disponibilità generale
az apim api schema list

Elencare Gestione API schema API.

 Memoria centrale Disponibilità generale
az apim api schema show

Visualizzare i dettagli di uno schema API Gestione API.

 Memoria centrale Disponibilità generale
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.

 Memoria centrale Disponibilità generale
az apim api show

Visualizzare i dettagli di un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api update

Aggiornare un'API Gestione API.

 Memoria centrale Disponibilità generale
az apim api versionset

Gestire il set di versioni dell'API Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim api versionset create

Crea un set di versioni api.

 Memoria centrale Disponibilità generale
az apim api versionset delete

Elimina un set di versioni dell'API specifico.

 Memoria centrale Disponibilità generale
az apim api versionset list

Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata.

 Memoria centrale Disponibilità generale
az apim api versionset show

Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim api versionset update

Aggiornamenti i dettagli dell'API VersionSet specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale
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.

 Memoria centrale Disponibilità generale
az apim apply-network-updates

Aggiornare la risorsa Gestione API in esecuzione nella rete virtuale per selezionare le impostazioni di rete aggiornate.

 Memoria centrale Disponibilità generale
az apim backup

Crea un backup del servizio Gestione API nell'account Archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

 Memoria centrale Disponibilità generale
az apim check-name

Verifica se un nome di servizio è disponibile per l'uso.

 Memoria centrale Disponibilità generale
az apim create

Creare una nuova istanza del servizio Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim delete

Elimina un servizio Gestione API.

 Memoria centrale Disponibilità generale
az apim deletedservice

Gestire i servizi di Azure Gestione API eliminati soft-delete.

 Memoria centrale Disponibilità generale
az apim deletedservice list

Elencare tutte le istanze dei servizi Gestione API eliminate soft disponibili per annullare l'eliminazione per la sottoscrizione specificata.

 Memoria centrale Disponibilità generale
az apim deletedservice purge

Ripulire l'istanza del servizio Gestione API eliminata temporanea (la elimina senza alcuna opzione per annullare l'eliminazione).

 Memoria centrale Disponibilità generale
az apim deletedservice show

Ottenere le istanze del servizio Gestione API eliminate soft disponibili per annullare l'eliminazione in base al nome.

 Memoria centrale Disponibilità generale
az apim graphql

Gestire l'API GraphQL di Azure Gestione API.

 Memoria centrale Disponibilità generale
az apim graphql resolver

Gestire i resolver dell'API GraphQL di Azure Gestione API.

 Memoria centrale Disponibilità generale
az apim graphql resolver create

Creare un nuovo sistema di risoluzione nell'API GraphQL o aggiornare uno esistente.

 Memoria centrale Disponibilità generale
az apim graphql resolver delete

Eliminare il resolver specificato nell'API GraphQL.

 Memoria centrale Disponibilità generale
az apim graphql resolver list

Elencare una raccolta dei resolver per l'API GraphQL specificata.

 Memoria centrale Disponibilità generale
az apim graphql resolver policy

Gestire i criteri resolver dell'API GraphQL di Azure Gestione API.

 Memoria centrale Disponibilità generale
az apim graphql resolver policy create

Creare o aggiornare la configurazione dei criteri per il livello del resolver dell'API GraphQL.

 Memoria centrale Disponibilità generale
az apim graphql resolver policy delete

Eliminare la configurazione dei criteri nel resolver api GraphQL.

 Memoria centrale Disponibilità generale
az apim graphql resolver policy list

Ottenere l'elenco della configurazione dei criteri a livello di resolver dell'API GraphQL.

 Memoria centrale Disponibilità generale
az apim graphql resolver policy show

Ottenere la configurazione dei criteri a livello di resolver API GraphQL.

 Memoria centrale Disponibilità generale
az apim graphql resolver show

Ottenere i dettagli del resolver dell'API GraphQL specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim list

Elencare Gestione API istanze del servizio.

 Memoria centrale Disponibilità generale
az apim nv

Gestire Azure Gestione API valori denominati.

 Memoria centrale Disponibilità generale
az apim nv create

Creare un Gestione API valore denominato.

 Memoria centrale Disponibilità generale
az apim nv delete

Eliminare un Gestione API valore denominato.

 Memoria centrale Disponibilità generale
az apim nv list

Elencare Gestione API valori denominati.

 Memoria centrale Disponibilità generale
az apim nv show

Mostra i dettagli di un Gestione API valore denominato.

 Memoria centrale Disponibilità generale
az apim nv show-secret

Ottiene il segreto di un valore denominato Gestione API.

 Memoria centrale Disponibilità generale
az apim nv update

Aggiornare un Gestione API valore denominato.

 Memoria centrale Disponibilità generale
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.

 Memoria centrale Disponibilità generale
az apim product

Gestire i prodotti azure Gestione API.

 Memoria centrale Disponibilità generale
az apim product api

Gestire le API del prodotto Gestione API di Azure.

 Memoria centrale Disponibilità generale
az apim product api add

Aggiungere un'API al prodotto specificato.

 Memoria centrale Disponibilità generale
az apim product api check

Verifica che l'entità API specificata dall'identificatore sia associata all'entità Product.

 Memoria centrale Disponibilità generale
az apim product api delete

Elimina l'API specificata dal prodotto specificato.

 Memoria centrale Disponibilità generale
az apim product api list

Elenca una raccolta delle API associate a un prodotto.

 Memoria centrale Disponibilità generale
az apim product create

Crea un prodotto.

 Memoria centrale Disponibilità generale
az apim product delete

Elimina prodotto.

 Memoria centrale Disponibilità generale
az apim product list

Elenca una raccolta di prodotti nell'istanza del servizio specificata.

 Memoria centrale Disponibilità generale
az apim product show

Ottiene i dettagli del prodotto specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim product update

Aggiornare i dettagli del prodotto esistenti.

 Memoria centrale Disponibilità generale
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.

 Memoria centrale Disponibilità generale
az apim restore

Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup sul servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

 Memoria centrale Disponibilità generale
az apim show

Visualizzare i dettagli di un'istanza del servizio Gestione API.

 Memoria centrale Disponibilità generale
az apim update

Aggiornare un'istanza del servizio Gestione API.

 Memoria centrale Disponibilità generale
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.

 Memoria centrale Disponibilità generale

az apim apply-network-updates

Modifica

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 della rete virtuale dell'istanza del servizio Gestione API

az apim apply-network-updates --name MyApim -g MyResourceGroup

Parametri necessari

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

Parametri facoltativi

--location -l

Posizione. Usare i valori ottenuti con az account list-locations. È possibile configurare la posizione predefinito con az configure --defaults location=<location>.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

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

Modifica

Crea un backup del servizio Gestione API nell'account 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
               --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

--backup-name

Nome del file di backup da creare.

--container-name --storage-account-container

Nome del contenitore dell'account di archiviazione usato per eseguire il backup.

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

--storage-account-key

Chiave di accesso dell'account di archiviazione usata per eseguire il backup.

--storage-account-name

Nome dell'account di archiviazione usato per eseguire il backup.

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

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 apim check-name

Modifica

Verifica se un nome di servizio è disponibile per l'uso.

az apim check-name --name

Parametri necessari

--name -n

Nome dell'istanza del servizio Gestione 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 apim create

Modifica

Creare una nuova istanza del servizio Gestione API di Azure.

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 di Gestione API livello sviluppatore.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Creare un servizio a consumo Gestione API.

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

--name -n

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.

--publisher-email

Indirizzo di posta elettronica per ricevere tutte le notifiche di sistema.

--publisher-name

Nome dell'organizzazione da usare nel portale per sviluppatori e notifiche tramite posta elettronica.

--resource-group -g

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

Parametri facoltativi

--disable-gateway

Disabilitare il gateway nell'area master. Valido solo per un servizio Gestione API distribuito in più posizioni.

valori accettati: false, true
--enable-client-certificate

Applica un certificato client da presentare a ogni richiesta al gateway e consente anche di autenticare il certificato nei criteri nel gateway.

valori accettati: false, true
--enable-managed-identity

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.

valori accettati: false, true
valore predefinito: False
--location -l

Posizione. Usare i valori ottenuti con az account list-locations. È possibile configurare la posizione predefinito con az configure --defaults location=<location>.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

valore predefinito: False
--public-network-access

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.

valori accettati: false, true
--sku-capacity

Numero di unità distribuite dello SKU.

valore predefinito: 1
--sku-name

SKU dell'istanza di Gestione API.

valori accettati: Basic, Consumption, Developer, Isolated, Premium, Standard
valore predefinito: Developer
--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

--virtual-network -v

Tipo di rete virtuale.

valori accettati: External, Internal, None
valore predefinito: None
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 apim delete

Modifica

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

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

valore predefinito: False
--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 apim list

Modifica

Elencare Gestione API istanze del servizio.

az apim list [--resource-group]

Parametri facoltativi

--resource-group -g

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

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

Modifica

Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup sul servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

az apim restore --backup-name
                --container-name
                --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

--backup-name

Nome del file di backup da ripristinare.

--container-name --storage-account-container

Nome del contenitore dell'account di archiviazione usato per recuperare il backup da.

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

--storage-account-key

Chiave di accesso dell'account di archiviazione usata per recuperare il backup.

--storage-account-name

Nome dell'account di archiviazione usato per recuperare il backup da .

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

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

Modifica

Visualizzare i dettagli di un'istanza del servizio Gestione API.

az apim show --name
             --resource-group

Parametri necessari

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

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

Modifica

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

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

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

valore predefinito: []
--disable-gateway

Disabilitare il gateway nell'area master. Valido solo per un servizio Gestione API distribuito in più posizioni.

valori accettati: false, true
--enable-client-certificate

Applica un certificato client da presentare a ogni richiesta al gateway e consente anche di autenticare il certificato nei criteri nel gateway.

valori accettati: false, true
--enable-managed-identity

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.

valori accettati: false, true
--force-string

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

valore predefinito: False
--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

valore predefinito: False
--public-network-access

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.

valori accettati: false, true
--publisher-email

Indirizzo di posta elettronica per ricevere tutte le notifiche di sistema.

--publisher-name

Nome dell'organizzazione da usare nel portale per sviluppatori e notifiche tramite posta elettronica.

--remove

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

valore predefinito: []
--set

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

valore predefinito: []
--sku-capacity

Numero di unità distribuite dello SKU.

--sku-name

SKU dell'istanza di Gestione API.

valori accettati: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

--virtual-network -v

Tipo di rete virtuale.

valori accettati: External, Internal, None
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 apim wait

Modifica

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

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

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

Parametri facoltativi

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendere l'eliminazione.

valore predefinito: False
--exists

Attendere che la risorsa esista.

valore predefinito: False
--interval

Intervallo di polling in secondi.

valore predefinito: 30
--timeout

Attesa massima in secondi.

valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

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.