Condividi tramite

az apim product api

  • Riferimento

Gestire le API del prodotto Gestione API di Azure.

Comandi

Nome Descrizione Tipo Status
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 api add

Modifica

Aggiungere un'API al prodotto specificato.

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

Esempio

Aggiungere un'API al prodotto specificato.

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--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 usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim product api check

Modifica

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

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

Esempio

Controllare se l'API è associata al prodotto.

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--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 usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim product api delete

Modifica

Elimina l'API specificata dal prodotto specificato.

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

Esempio

Elimina l'API specificata dal prodotto specificato.

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parametri necessari

--api-id

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

--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 usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim product api list

Modifica

Elenca una raccolta delle API associate a un prodotto.

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

Esempio

Elencare tutte le API associate a un prodotto.

az apim product api list --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 usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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