Condividi tramite

az apic api deployment

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 deployment . Altre informazioni 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.

 Extension GA
az apic api deployment delete

Eliminare la distribuzione dell'API.

 Extension GA
az apic api deployment list

Elencare una raccolta di distribuzioni api.

 Extension GA
az apic api deployment show

Ottenere i dettagli della distribuzione dell'API.

 Extension GA
az apic api deployment update

Aggiornare la distribuzione dell'API esistente.

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

Proprietà Valore
Gruppo di parametri: Properties Arguments
--deployment-id

ID della distribuzione dell'API.

--environment-id

ID risorsa dell'ambiente con ambito centro API.

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

Proprietà Valore
Gruppo di parametri: Properties Arguments
--service-name -n

Nome del servizio Centro API di Azure.

--title

Titolo della distribuzione.

Proprietà Valore
Gruppo di parametri: Properties Arguments

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.

--custom-properties

Metadati personalizzati definiti per le entità del catalogo API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--description

Descrizione della distribuzione.

Proprietà Valore
Gruppo di parametri: Properties 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 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

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

ID della distribuzione 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
--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 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

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

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

ID della distribuzione 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
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 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

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

Metadati personalizzati definiti per le entità del catalogo API. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--definition-id

ID risorsa definizione con ambito servizio.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--deployment-id

ID della distribuzione dell'API.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--description

Descrizione della distribuzione.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--environment-id

ID risorsa dell'ambiente con ambito servizio.

Proprietà Valore
Gruppo di parametri: Properties 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

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

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

Proprietà Valore
Gruppo di parametri: Properties 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

Title.

Proprietà Valore
Gruppo di parametri: Properties 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