az apic environment

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 environment kommando. Läs mer om tillägg.

Kommandon för att hantera miljöer i API Center.

Kommandon

Name	Description	Typ	Status
az apic environment create	Skapa en ny miljö eller uppdatera en befintlig miljö.	Extension	GA
az apic environment delete	Ta bort miljön.	Extension	GA
az apic environment list	Visa en lista över en samling miljöer.	Extension	GA
az apic environment show	Få information om miljön.	Extension	GA
az apic environment update	Uppdatera befintlig miljö.	Extension	GA

az apic environment create

Skapa en ny miljö eller uppdatera en befintlig miljö.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Exempel

Skapa miljö

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Obligatoriska parametrar

--environment-id

ID:t för miljön.

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

--title

Miljörubrik.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--type

Miljötyp.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	development, production, staging, testing

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.

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

Miljöbeskrivning.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--onboarding

Ange dokumentation om registrering som rör din miljö, t.ex. {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Support shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--server

Serverinformation om miljön. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

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

Ta bort miljön.

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

Exempel

Radera miljö

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

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.

--environment-id

ID:t för miljön.

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

Visa en lista över en samling miljöer.

az apic environment list --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Exempel

Lista miljöer

az apic environment list -g api-center-test -n contosoeuap

Obligatoriska parametrar

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

Få information om miljön.

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

Exempel

Visa miljöinformation

az apic environment show -g api-center-test -n contosoeuap --environment-id public

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.

--environment-id

ID:t för miljön.

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

Uppdatera befintlig miljö.

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

Exempel

Uppdatera miljö

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

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.

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

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

Description.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--environment-id

ID:t för miljön.

Egenskap	Värde
Parametergrupp:	Resource Id 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

--onboarding

{developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties 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

Serverinformation om miljön. Stö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

Miljörubrik.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--type

Miljötyp.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	development, production, staging, testing

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