az apic api version

Note

Questo riferimento fa parte dell'estensione apic-extension per l'interfaccia della riga di comando di Azure (versione 2.57.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az apic api version. Altre informazioni sulle estensioni.

Comandi per gestire le versioni dell'API nel Centro API.

Comandi

Nome	Descrizione	Tipo	Status
az apic api version create	Creare una nuova versione dell'API o aggiornare una versione dell'API esistente.	Extension	GA
az apic api version delete	Eliminare la versione dell'API specificata.	Extension	GA
az apic api version list	Elencare una raccolta di versioni dell'API.	Extension	GA
az apic api version show	Ottenere i dettagli della versione dell'API.	Extension	GA
az apic api version update	Aggiornare la versione dell'API esistente.	Extension	GA

az apic api version create

Creare una nuova versione dell'API o aggiornare una versione dell'API esistente.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

Esempio

Creare la versione dell'API

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

Parametri necessari

--api-id

ID dell'API.

--lifecycle-stage

Fase corrente del ciclo di vita dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	deprecated, design, development, preview, production, retired, testing

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--title

Versione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--version-id

ID della versione dell'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 apic api version delete

Eliminare la versione dell'API specificata.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--version-id]
                           [--yes]

Esempio

Eliminare la versione dell'API

az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

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.

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--version-id

ID della versione dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--yes -y

Non richiedere conferma.

Proprietà	Valore
Valore predefinito:	False

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

az apic api version list

Elencare una raccolta di versioni dell'API.

az apic api version list --api-id
                         --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Esempio

Elencare le versioni dell'API

az apic api version list -g api-center-test -n contosoeuap --api-id echo-api

Parametri necessari

--api-id

ID dell'API.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

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.

--filter

Parametro di filtro OData.

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

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 apic api version show

Ottenere i dettagli della versione dell'API.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]
                         [--version-id]

Esempio

Visualizzare i dettagli della versione dell'API

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

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.

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--version-id

ID della versione dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

az apic api version update

Aggiornare la versione dell'API esistente.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Esempio

Aggiornare la versione dell'API

az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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.

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

--api-id

ID dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id 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
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--ids

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--lifecycle-stage

Fase corrente del ciclo di vita dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	deprecated, design, development, preview, production, retired, testing

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

--resource-group -g

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

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--service-name -n

Nome del servizio Centro API di Azure.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

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

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--title

Versione dell'API.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--version-id

ID della versione dell'API.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

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

--verbose

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

Proprietà	Valore
Valore predefinito:	False

Commenti e suggerimenti

Questa pagina è stata utile?

Condividi tramite

az apic api version

Comandi

az apic api version create

Esempio

Parametri necessari

az apic api version delete

Esempio

Parametri facoltativi

az apic api version list

Esempio

Parametri necessari

Parametri facoltativi

az apic api version show

Esempio

Parametri facoltativi

az apic api version update

Esempio

Parametri facoltativi

Commenti e suggerimenti