az apic api deployment

Note

Den här referensen är en del av tillägget apic-extension för Azure CLI (version 2.57.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az apic API-distributionskommando . Läs mer om tillägg.

Kommandon för att hantera API-distributioner i API Center.

Kommandon

Name Description Typ Status
az apic api deployment create

Skapa en ny API-distribution eller uppdatera en befintlig API-distribution.

 Extension GA
az apic api deployment delete

Ta bort API-distribution.

 Extension GA
az apic api deployment list

Lista en samling API-distributioner.

 Extension GA
az apic api deployment show

Hämta information om API-distributionen.

 Extension GA
az apic api deployment update

Uppdatera befintlig API-distribution.

 Extension GA

az apic api deployment create

Skapa en ny API-distribution eller uppdatera en befintlig API-distribution.

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

Exempel

Skapa distribution

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"]}'

Skapa distribution med hjälp av serverns json-fil

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'

Obligatoriska parametrar

--api-id

ID:t för API:et.

--definition-id

RESURS-ID för API Center-omfångsbegränsad definition.

Egenskap Värde
Parametergrupp: Properties Arguments
--deployment-id

ID:t för API-distributionen.

--environment-id

RESURS-ID för API Center-omfångsmiljö.

Egenskap Värde
Parametergrupp: Properties Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--server

ServerStöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

--title

Distributionsrubrik.

Egenskap Värde
Parametergrupp: Properties Arguments

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--description

Beskrivning av distributionen.

Egenskap Värde
Parametergrupp: Properties Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apic api deployment delete

Ta bort API-distribution.

az apic api deployment delete [--acquire-policy-token]
                              [--api-id]
                              [--change-reference]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

Exempel

Ta bort API-distribution

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--deployment-id

ID:t för API-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apic api deployment list

Lista en samling API-distributioner.

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

Exempel

Lista API-distributioner

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

Obligatoriska parametrar

--api-id

ID:t för API:et.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på Azure API Center-tjänsten.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--filter

OData-filterparameter.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

Egenskap Värde
Parametergrupp: Pagination Arguments
--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

Egenskap Värde
Parametergrupp: Pagination Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apic api deployment show

Hämta information om API-distributionen.

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

Exempel

Visa information om API-distribution

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--deployment-id

ID:t för API-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apic api deployment update

Uppdatera befintlig API-distribution.

az apic api deployment update [--acquire-policy-token]
                              [--add]
                              [--api-id]
                              [--change-reference]
                              [--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]

Exempel

Uppdatera API-distribution

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--definition-id

Resurs-ID för tjänstomfattningsdefinition.

Egenskap Värde
Parametergrupp: Properties Arguments
--deployment-id

ID:t för API-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--description

Beskrivning av distributionen.

Egenskap Värde
Parametergrupp: Properties Arguments
--environment-id

Resurs-ID för tjänstomfattningsmiljö.

Egenskap Värde
Parametergrupp: Properties Arguments
--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap Värde
Parametergrupp: Generic Update Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--server

ServerStöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--title

Title.

Egenskap Värde
Parametergrupp: Properties Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False