az apim backend

Manage Azure API Management Backends.

Commands

Name	Description	Type	Status
az apim backend create	Create or Update an API Management Backend.	Core	GA
az apim backend delete	Delete an API Management Backend.	Core	GA
az apim backend list	List API Management Backends.	Core	GA
az apim backend show	Show details of an API Management Backend.	Core	GA
az apim backend update	Update an API Management Backend.	Core	GA

az apim backend create

Edit

Create or Update an API Management Backend.

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

Examples

Create a Backend.

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

Required Parameters

--backend-id

Unique name for the Backend to be created or updated.

Must be unique in the current API Management service instance.

Property	Value
Parameter group:	Backend Arguments

--protocol

The protocol used to communicate with the backend service.

Property	Value
Accepted values:	http, soap

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

--url

The URL of the backend service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--description

Description of the Backend. May include HTML formatting tags.

--if-match

ETag of the Entity.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az apim backend delete

Edit

Delete an API Management Backend.

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

Examples

Delete a Backend in an APIM instance.

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

Required Parameters

--backend-id

Identifier of the Backend.

Property	Value
Parameter group:	Backend Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--if-match

ETag of the Entity.

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az apim backend list

Edit

List API Management Backends.

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

Examples

List all Backends in an APIM instance.

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

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az apim backend show

Edit

Show details of an API Management Backend.

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

Examples

Show details of a Backend in an APIM instance.

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

Required Parameters

--backend-id

Identifier of the Backend.

Property	Value
Parameter group:	Backend Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az apim backend update

Edit

Update an API Management Backend.

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]

Examples

Update a Backend.

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

Required Parameters

--backend-id

Unique name of the Backend to be updated.

Must be unique in the current API Management service instance.

Property	Value
Parameter group:	Backend Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--description

Description of the Backend. May include HTML formatting tags.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	False

--if-match

ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

--protocol

Protocol used to communicate with the backend service. Possible values include: http, soap.

Property	Value
Accepted values:	http, soap

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--url

Backend service URL.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az apim backend

Commands

az apim backend create

Examples

Required Parameters

Optional Parameters

az apim backend delete

Examples

Required Parameters

Optional Parameters

az apim backend list

Examples

Required Parameters

az apim backend show

Examples

Required Parameters

az apim backend update

Examples

Required Parameters

Optional Parameters

Feedback