az apim backend

Beheer Azure API Management back-ends.

Opdracht

Name	Description	Type	Status
az apim backend create	Een API Management-back-end maken of bijwerken.	Core	GA
az apim backend delete	Een API Management-back-end verwijderen.	Core	GA
az apim backend list	Maak een lijst met API Management-back-ends.	Core	GA
az apim backend show	Details van een API Management-back-end weergeven.	Core	GA
az apim backend update	Een API Management-back-end bijwerken.	Core	GA

az apim backend create

Bewerken

Een API Management-back-end maken of bijwerken.

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

Voorbeelden

Maak een back-end.

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

Vereiste parameters

--backend-id

Unieke naam voor het maken of bijwerken van de back-end.

Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

Eigenschap	Waarde
Parametergroep:	Backend Arguments

--protocol

Het protocol dat wordt gebruikt om te communiceren met de back-endservice.

Eigenschap	Waarde
Geaccepteerde waarden:	http, soap

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

--url

De URL van de back-endservice.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--description

Beschrijving van de back-end. Kan HTML-opmaaktags bevatten.

--if-match

ETag van de entiteit.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

az apim backend delete

Bewerken

Een API Management-back-end verwijderen.

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

Voorbeelden

Een back-end verwijderen in een APIM-exemplaar.

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

Vereiste parameters

--backend-id

Id van de back-end.

Eigenschap	Waarde
Parametergroep:	Backend Arguments

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--if-match

ETag van de entiteit.

--yes -y

Niet vragen om bevestiging.

Eigenschap	Waarde
Default value:	False

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

az apim backend list

Bewerken

Maak een lijst met API Management-back-ends.

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

Voorbeelden

Alle back-ends in een APIM-exemplaar weergeven.

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

Vereiste parameters

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

az apim backend show

Bewerken

Details van een API Management-back-end weergeven.

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

Voorbeelden

Details van een back-end weergeven in een APIM-exemplaar.

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

Vereiste parameters

--backend-id

Id van de back-end.

Eigenschap	Waarde
Parametergroep:	Backend Arguments

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

az apim backend update

Bewerken

Een API Management-back-end bijwerken.

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]

Voorbeelden

Een back-end bijwerken.

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

Vereiste parameters

--backend-id

Unieke naam van de back-end die moet worden bijgewerkt.

Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

Eigenschap	Waarde
Parametergroep:	Backend Arguments

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments
Default value:	[]

--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap	Waarde
Parametergroep:	Global Policy Arguments

--description

Beschrijving van de back-end. Kan HTML-opmaaktags bevatten.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments
Default value:	False

--if-match

ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar wel bij het bijwerken van een entiteit. De standaardwaarde is Geen.

--protocol

Protocol dat wordt gebruikt om te communiceren met de back-endservice. Mogelijke waarden zijn: http, soap.

Eigenschap	Waarde
Geaccepteerde waarden:	http, soap

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments
Default value:	[]

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments
Default value:	[]

--url

URL van back-endservice.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

Feedback

Is deze pagina nuttig?