az apim backend

Hantera Azure API Management serverdelar.

Kommandon

Name	Description	Typ	Status
az apim backend create	Skapa eller uppdatera en API Management-serverdel.	Kärna	GA
az apim backend delete	Ta bort en API Management-serverdel.	Kärna	GA
az apim backend list	Lista API Management-serverdelar.	Kärna	GA
az apim backend show	Visa information om en API Management-serverdel.	Kärna	GA
az apim backend update	Uppdatera en API Management-serverdel.	Kärna	GA

az apim backend create

Redigera

Skapa eller uppdatera en API Management-serverdel.

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

Exempel

Skapa en serverdel.

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

Obligatoriska parametrar

--backend-id

Unikt namn för serverdelen som ska skapas eller uppdateras.

Måste vara unikt i den aktuella API Management-tjänstinstansen.

Egenskap	Värde
Parametergrupp:	Backend Arguments

--protocol

Det protokoll som används för att kommunicera med serverdelstjänsten.

Egenskap	Värde
Godkända värden:	http, soap

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

--url

URL:en för serverdelstjä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.

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

--description

Beskrivning av serverdelen. Kan innehålla HTML-formateringstaggar.

--if-match

ETag för enheten.

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 apim backend delete

Redigera

Ta bort en API Management-serverdel.

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

Exempel

Ta bort en serverdel i en APIM-instans.

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Obligatoriska parametrar

--backend-id

Identifierare för serverdelen.

Egenskap	Värde
Parametergrupp:	Backend Arguments

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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

--if-match

ETag för enheten.

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

--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 apim backend list

Redigera

Lista API Management-serverdelar.

az apim backend list --resource-group
                     --service-name

Exempel

Visa en lista över alla serverdelar i en APIM-instans.

az apim backend list --resource-group MyResourceGroup --service-name MyServiceName

Obligatoriska parametrar

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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 apim backend show

Redigera

Visa information om en API Management-serverdel.

az apim backend show --backend-id
                     --resource-group
                     --service-name

Exempel

Visa information om en serverdel i en APIM-instans.

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Obligatoriska parametrar

--backend-id

Identifierare för serverdelen.

Egenskap	Värde
Parametergrupp:	Backend Arguments

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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 apim backend update

Redigera

Uppdatera en API Management-serverdel.

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

Exempel

Uppdatera en serverdel.

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

Obligatoriska parametrar

--backend-id

Unikt namn på serverdelen som ska uppdateras.

Måste vara unikt i den aktuella API Management-tjänstinstansen.

Egenskap	Värde
Parametergrupp:	Backend Arguments

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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
Standardvärde:	[]

--change-reference

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

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--description

Beskrivning av serverdelen. Kan innehålla HTML-formateringstaggar.

--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
Standardvärde:	False

--if-match

ETag för enheten. Krävs inte när du skapar en entitet, men krävs när du uppdaterar en entitet. Standardvärdet är Ingen.

--protocol

Protokoll som används för att kommunicera med serverdelstjänsten. Möjliga värden är: http, soap.

Egenskap	Värde
Godkända värden:	http, soap

--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
Standardvärde:	[]

--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
Standardvärde:	[]

--url

Url för serverdelstjänsten.

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

Feedback

Var den här sidan till hjälp?