Condividi tramite

az apic api version

  • Riferimento

Nota

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.

 Estensione Disponibilità generale
az apic api version delete

Eliminare la versione dell'API specificata.

 Estensione Disponibilità generale
az apic api version list

Elencare una raccolta di versioni dell'API.

 Estensione Disponibilità generale
az apic api version show

Ottenere i dettagli della versione dell'API.

 Estensione Disponibilità generale
az apic api version update

Aggiornare la versione dell'API esistente.

 Estensione Disponibilità generale

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.

Valori accettati: deprecated, design, development, preview, production, retired, testing
--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--title

Versione API.

--version-id

ID della versione dell'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 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

--api-id

ID dell'API.

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--subscription

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

--version-id

ID della versione dell'API.

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

--service-name -n

Nome del servizio Centro API di Azure.

Parametri facoltativi

--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 nell'argomento --next-token di un comando successivo.

--next-token

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

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

--api-id

ID dell'API.

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--subscription

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

--version-id

ID della versione dell'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 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

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, stringa o stringa> JSON.

--api-id

ID dell'API.

--force-string

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

Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--lifecycle-stage

Fase corrente del ciclo di vita dell'API.

Valori accettati: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

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

--service-name -n

Nome del servizio Centro API di Azure.

--set

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

--subscription

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

--title

Versione API.

--version-id

ID della versione dell'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.