Condividi tramite

az apim product

  • Riferimento

Gestire i prodotti azure Gestione API.

Comandi

Nome Descrizione Tipo Stato
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 product create

Modifica

Crea un prodotto.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Esempio

Crea un prodotto.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Parametri necessari

--product-name

Nome del prodotto.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--approval-required

Indica se è necessaria l'approvazione della sottoscrizione. Se false, le nuove sottoscrizioni verranno approvate automaticamente consentendo agli sviluppatori di chiamare le API del prodotto immediatamente dopo la sottoscrizione. Se true, gli amministratori devono approvare manualmente la sottoscrizione prima che lo sviluppatore possa usare qualsiasi API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.

valori accettati: false, true
--description

Descrizione del prodotto. Può includere tag di formattazione HTML.

--legal-terms

Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.

--no-wait

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

valore predefinito: False
--product-id

Identificatore del prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--state

Indica se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non èPubblicato. I valori possibili includono: 'not Published', 'published'.

valori accettati: notPublished, published
--subscription-required -s

Indica se è necessaria una sottoscrizione di prodotto per l'accesso alle API incluse in questo prodotto.

valori accettati: false, true
--subscriptions-limit

Indica se il numero di sottoscrizioni che un utente può avere contemporaneamente a questo prodotto. Impostare su null o omettere per consentire sottoscrizioni illimitate per utente. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore 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 product delete

Modifica

Elimina prodotto.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Esempio

Eliminare il prodotto con tutte le sottoscrizioni al prodotto.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

Parametri necessari

--product-id

Identificatore del prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--delete-subscriptions

Eliminare o meno le sottoscrizioni esistenti associate al prodotto.

--if-match

ETag dell'entità.

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

Modifica

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

az apim product list --resource-group
                     --service-name

Esempio

Elencare tutti i prodotti per questa istanza di Gestione API.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Parametri necessari

--resource-group -g

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

--service-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 product show

Modifica

Ottiene i dettagli del prodotto specificato dal relativo identificatore.

az apim product show --product-id
                     --resource-group
                     --service-name

Esempio

Ottiene i dettagli del prodotto specificato dal relativo identificatore.

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

Parametri necessari

--product-id

Identificatore del prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-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 product update

Modifica

Aggiornare i dettagli del prodotto esistenti.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Esempio

Aggiornare i dettagli del prodotto esistenti.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

Parametri necessari

--product-id

Identificatore del prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

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: []
--approval-required

Indica se è necessaria l'approvazione della sottoscrizione. Se false, le nuove sottoscrizioni verranno approvate automaticamente consentendo agli sviluppatori di chiamare le API del prodotto immediatamente dopo la sottoscrizione. Se true, gli amministratori devono approvare manualmente la sottoscrizione prima che lo sviluppatore possa usare qualsiasi API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.

valori accettati: false, true
--description

Descrizione del prodotto. Può includere tag di formattazione HTML.

--force-string

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

valore predefinito: False
--if-match

ETag dell'entità.

--legal-terms

Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.

--no-wait

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

valore predefinito: False
--product-name

Nome del prodotto.

--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: []
--state

Indica se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non èPubblicato. I valori possibili includono: 'not Published', 'published'.

valori accettati: notPublished, published
--subscription-required -s

Indica se è necessaria una sottoscrizione di prodotto per l'accesso alle API incluse in questo prodotto.

valori accettati: false, true
--subscriptions-limit

Indica se il numero di sottoscrizioni che un utente può avere contemporaneamente a questo prodotto. Impostare su null o omettere per consentire sottoscrizioni illimitate per utente. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore 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 product wait

Modifica

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un prodotto apim.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--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 product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

Parametri necessari

--product-id

Identificatore del prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

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.