Condividi tramite

az apic api deployment

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione pic-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 deployment. Altre sulle estensioni.

Comandi per gestire le distribuzioni API nel Centro API.

Comandi

Nome Descrizione Tipo Status
az apic api deployment create

Creare una nuova distribuzione api o aggiornare una distribuzione API esistente.

 Estensione GA
az apic api deployment delete

Eliminare la distribuzione dell'API.

 Estensione GA
az apic api deployment list

Elencare una raccolta di distribuzioni api.

 Estensione GA
az apic api deployment show

Ottenere i dettagli della distribuzione dell'API.

 Estensione GA
az apic api deployment update

Aggiornare la distribuzione dell'API esistente.

 Estensione GA

az apic api deployment create

Creare una nuova distribuzione api o aggiornare una distribuzione API esistente.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Esempio

Creare la distribuzione

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Creare la distribuzione usando il file JSON del server

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Parametri necessari

--api-id

ID dell'API.

--definition-id

ID risorsa definizione con ambito centro API.

--deployment-id

ID della distribuzione dell'API.

--environment-id

ID risorsa dell'ambiente con ambito centro API.

--resource-group -g

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

--server

Server Support shorthand-syntax, json-file e yaml-file. Prova "??" per mostrare di più.

--service-name -n

Nome del servizio Centro API di Azure.

--title

Titolo della distribuzione.

Parametri facoltativi

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supporto di json-file e yaml-file.

--description

Descrizione della distribuzione.

Parametri globali
--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic api deployment delete

Eliminare la distribuzione dell'API.

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

Esempio

Eliminare la distribuzione dell'API

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

Parametri facoltativi

--api-id

ID dell'API.

--deployment-id

ID della distribuzione dell'API.

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

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

--subscription

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

--yes -y

Non richiedere conferma.

Valore predefinito: False
Parametri globali
--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic api deployment list

Elencare una raccolta di distribuzioni api.

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

Esempio

Elencare le distribuzioni dell'API

az apic api deployment list -g api-center-test -n contoso --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

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

--next-token

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

Parametri globali
--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic api deployment show

Ottenere i dettagli della distribuzione dell'API.

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

Esempio

Visualizzare i dettagli della distribuzione dell'API

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

Parametri facoltativi

--api-id

ID dell'API.

--deployment-id

ID della distribuzione dell'API.

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

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

--subscription

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

Parametri globali
--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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

az apic api deployment update

Aggiornare la distribuzione dell'API esistente.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

Esempio

Aggiornare la distribuzione dell'API

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

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

--api-id

ID dell'API.

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supporto di json-file e yaml-file.

--definition-id

ID risorsa definizione con ambito servizio.

--deployment-id

ID della distribuzione dell'API.

--description

Descrizione della distribuzione.

--environment-id

ID risorsa dell'ambiente con ambito servizio.

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

--remove

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

--resource-group -g

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

--server

Server Support shorthand-syntax, json-file e yaml-file. Prova "??" per mostrare di più.

--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=<value>.

--subscription

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

--title

Titolo.

Parametri globali
--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

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

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