Condividi tramite

az apim api release

Gestire Gestione API di Azure versione API.

Comandi

Nome Descrizione Tipo Status
az apim api release create

Crea una nuova versione per l'API.

 Core GA
az apim api release delete

Elimina la versione specificata nell'API.

 Core GA
az apim api release list

Elenca tutte le versioni di un'API.

 Core GA
az apim api release show

Restituisce i dettagli di una versione dell'API.

 Core GA
az apim api release update

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

 Core GA

az apim api release create

Modifica

Crea una nuova versione per l'API.

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--if-match]
                           [--notes]
                           [--release-id]

Esempio

Crea una nuova versione per l'API.

az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes

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.

Proprietà Valore
Gruppo di parametri: API Arguments
--api-revision

Numero di revisione 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 facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--if-match

ETag dell'entità.

--notes

Note sulla versione.

--release-id

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Proprietà Valore
Valore predefinito: False

az apim api release delete

Modifica

Elimina la versione specificata nell'API.

az apim api release delete --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--if-match]

Esempio

Elimina la versione specificata nell'API.

az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

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.

Proprietà Valore
Gruppo di parametri: API Arguments
--release-id

Identificatore di versione all'interno di un'API. 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 facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--if-match

ETag dell'entità.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Proprietà Valore
Valore predefinito: False

az apim api release list

Modifica

Elenca tutte le versioni di un'API.

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

Esempio

Elenca tutte le versioni di un'API.

az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --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.

Proprietà Valore
Gruppo di parametri: API Arguments
--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.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Proprietà Valore
Valore predefinito: False

az apim api release show

Modifica

Restituisce i dettagli di una versione dell'API.

az apim api release show --api-id
                         --release-id
                         --resource-group
                         --service-name

Esempio

Restituisce i dettagli di una versione dell'API.

az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

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.

Proprietà Valore
Gruppo di parametri: API Arguments
--release-id

Identificatore di versione all'interno di un'API. 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.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Proprietà Valore
Valore predefinito: False

az apim api release update

Modifica

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

az apim api release update --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--add]
                           [--change-reference]
                           [--force-string]
                           [--if-match]
                           [--notes]
                           [--remove]
                           [--set]

Esempio

Aggiorna le note della versione dell'API specificata dal relativo identificatore.

az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes

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.

Proprietà Valore
Gruppo di parametri: API Arguments
--release-id

Identificatore di versione all'interno di un'API. 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 facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--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>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--force-string

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: False
--if-match

ETag dell'entità.

--notes

Note sulla versione.

--remove

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
--set

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Proprietà Valore
Valore predefinito: False