backend

Creates, updates, deletes, gets or lists a backend resource.

Overview

Name	backend
Type	Resource
Id	azure.api_management.backend

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureRegion	string	Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer.
circuitBreaker	object	Backend Circuit Breaker Configuration.
credentials	object	Backend Credentials Contract Properties.
description	string	Backend Description.
pool	object	Backend Pool Properties.
properties	object	Backend Properties contract.
protocol	string	Backend communication protocol. Required when backend type is 'Single'. Known values are: "http" and "soap". (http, soap)
proxy	object	Backend gateway Contract Properties.
resourceId	string	Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Backend Title.
tls	object	Backend TLS Properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
url	string	Runtime Url of the Backend. Required when backend type is 'Single'.

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureRegion	string	Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer.
circuitBreaker	object	Backend Circuit Breaker Configuration.
credentials	object	Backend Credentials Contract Properties.
description	string	Backend Description.
pool	object	Backend Pool Properties.
properties	object	Backend Properties contract.
protocol	string	Backend communication protocol. Required when backend type is 'Single'. Known values are: "http" and "soap". (http, soap)
proxy	object	Backend gateway Contract Properties.
resourceId	string	Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Backend Title.
tls	object	Backend TLS Properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
url	string	Runtime Url of the Backend. Required when backend type is 'Single'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, backend_id, subscription_id		Gets the details of the backend specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of backends in the specified service instance.
create_or_update	insert	resource_group_name, service_name, backend_id, subscription_id		Creates or Updates a backend.
update	update	resource_group_name, service_name, backend_id, subscription_id		Updates an existing backend.
create_or_update	replace	resource_group_name, service_name, backend_id, subscription_id		Creates or Updates a backend.
delete	delete	resource_group_name, service_name, backend_id, subscription_id		Deletes the specified backend.
get_entity_tag	exec	resource_group_name, service_name, backend_id, subscription_id		Gets the entity state (Etag) version of the backend specified by its identifier.
reconnect	exec	resource_group_name, service_name, backend_id, subscription_id		Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backend_id	string	Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the backend specified by its identifier.

SELECT
id,
name,
azureRegion,
circuitBreaker,
credentials,
description,
pool,
properties,
protocol,
proxy,
resourceId,
systemData,
title,
tls,
type,
url
FROM azure.api_management.backend
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND backend_id = '{{ backend_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of backends in the specified service instance.

SELECT
id,
name,
azureRegion,
circuitBreaker,
credentials,
description,
pool,
properties,
protocol,
proxy,
resourceId,
systemData,
title,
tls,
type,
url
FROM azure.api_management.backend
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or Updates a backend.

INSERT INTO azure.api_management.backend (
properties,
resource_group_name,
service_name,
backend_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ backend_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: backend
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backend resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the backend resource.
  - name: backend_id
    value: "{{ backend_id }}"
    description: Required parameter for the backend resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backend resource.
  - name: properties
    description: |
      Backend entity contract properties.
    value:
      title: "{{ title }}"
      description: "{{ description }}"
      resourceId: "{{ resourceId }}"
      properties:
        serviceFabricCluster:
          clientCertificateId: "{{ clientCertificateId }}"
          clientCertificatethumbprint: "{{ clientCertificatethumbprint }}"
          maxPartitionResolutionRetries: {{ maxPartitionResolutionRetries }}
          managementEndpoints:
            - "{{ managementEndpoints }}"
          serverCertificateThumbprints:
            - "{{ serverCertificateThumbprints }}"
          serverX509Names:
            - name: "{{ name }}"
              issuerCertificateThumbprint: "{{ issuerCertificateThumbprint }}"
      credentials:
        certificateIds:
          - "{{ certificateIds }}"
        certificate:
          - "{{ certificate }}"
        query: "{{ query }}"
        header: "{{ header }}"
        authorization:
          scheme: "{{ scheme }}"
          parameter: "{{ parameter }}"
      proxy:
        url: "{{ url }}"
        username: "{{ username }}"
        password: "{{ password }}"
      tls:
        validateCertificateChain: {{ validateCertificateChain }}
        validateCertificateName: {{ validateCertificateName }}
        serverCertificateThumbprints:
          - "{{ serverCertificateThumbprints }}"
        serverX509Names:
          - name: "{{ name }}"
            issuerCertificateThumbprint: "{{ issuerCertificateThumbprint }}"
      circuitBreaker:
        rules:
          - name: "{{ name }}"
            failureCondition:
              count: {{ count }}
              percentage: {{ percentage }}
              interval: "{{ interval }}"
              statusCodeRanges:
                - min: {{ min }}
                  max: {{ max }}
              errorReasons:
                - "{{ errorReasons }}"
            tripDuration: "{{ tripDuration }}"
            acceptRetryAfter: {{ acceptRetryAfter }}
            failureResponse:
              statusCode: {{ statusCode }}
      azureRegion: "{{ azureRegion }}"
      pool:
        services:
          - id: "{{ id }}"
            weight: {{ weight }}
            priority: {{ priority }}
            preferredCarbonEmission: "{{ preferredCarbonEmission }}"
        failureResponse:
          statusCode: {{ statusCode }}
        sessionAffinity:
          sessionId:
            source: "{{ source }}"
            name: "{{ name }}"
      type: "{{ type }}"
      url: "{{ url }}"
      protocol: "{{ protocol }}"

UPDATE examples

update

Updates an existing backend.

UPDATE azure.api_management.backend
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND backend_id = '{{ backend_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or Updates a backend.

REPLACE azure.api_management.backend
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND backend_id = '{{ backend_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified backend.

DELETE FROM azure.api_management.backend
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND backend_id = '{{ backend_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the backend specified by its identifier.

EXEC azure.api_management.backend.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@backend_id='{{ backend_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reconnect

Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

EXEC azure.api_management.backend.reconnect 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@backend_id='{{ backend_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;