Condividi tramite

az apim api versionset

  • Riferimento

Gestire il set di versioni dell'API Gestione API di Azure.

Comandi

Nome Descrizione Tipo Status
az apim api versionset create

Crea un set di versioni api.

 Memoria centrale Disponibilità generale
az apim api versionset delete

Elimina un set di versioni dell'API specifico.

 Memoria centrale Disponibilità generale
az apim api versionset list

Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata.

 Memoria centrale Disponibilità generale
az apim api versionset show

Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale
az apim api versionset update

Aggiornamenti i dettagli dell'API VersionSet specificato dal relativo identificatore.

 Memoria centrale Disponibilità generale

az apim api versionset create

Modifica

Crea un set di versioni api.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Esempio

Crea un set di versioni api con lo schema della versione come intestazione.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Crea un set di versioni api con lo schema della versione come query.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Parametri necessari

--display-name

Obbligatorio. Nome del set di versioni 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 dell'istanza del servizio Gestione API.

--versioning-scheme

Obbligatorio. Valore che determina la posizione in cui l'identificatore della versione dell'API si troverà in una richiesta HTTP. I valori possibili includono: 'Segment', 'Query', 'Header'.

Parametri facoltativi

--description

Descrizione del set di versioni dell'API.

--if-match

ETag dell'entità.

--version-header-name

Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header.

--version-query-name

Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query.

--version-set-id

Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.

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 api versionset delete

Modifica

Elimina un set di versioni dell'API specifico.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Esempio

Elimina un set di versioni dell'API specifico.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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.

--version-set-id

Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.

Parametri facoltativi

--if-match

ETag dell'entità.

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 api versionset list

Modifica

Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata.

az apim api versionset list --resource-group
                            --service-name

Esempio

Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata.

az apim api versionset 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 api versionset show

Modifica

Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Esempio

Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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.

--version-set-id

Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.

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 api versionset update

Modifica

Aggiornamenti i dettagli dell'API VersionSet specificato dal relativo identificatore.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Esempio

Aggiornamenti la descrizione, nome visualizzato dell'Api VersionSet specificato dal relativo identificatore.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Aggiornamenti lo schema della versione dell'Api VersionSet specificato dal relativo identificatore.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

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.

--version-set-id

Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.

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

Descrizione del set di versioni dell'API.

--display-name

Obbligatorio. Nome del set di versioni dell'API.

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

--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: []
--version-header-name

Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header.

--version-query-name

Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query.

--versioning-scheme

Obbligatorio. Valore che determina la posizione in cui l'identificatore della versione dell'API si troverà in una richiesta HTTP. I valori possibili includono: 'Segment', 'Query', 'Header'.

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.