backends

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

Overview

Name	backends
Type	Resource
Id	azure.api_management.backends

Fields

vw_backends

Name	Datatype	Description
description	text	field from the properties object
backendId	text	field from the properties object
circuit_breaker	text	field from the properties object
credentials	text	field from the properties object
pool	text	field from the properties object
properties	text	Parameters supplied to the Create Backend operation.
protocol	text	field from the properties object
proxy	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_id	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
title	text	field from the properties object
tls	text	field from the properties object
type	text	field from the properties object
url	text	field from the properties object

backends

Name	Datatype	Description
properties	object	Parameters supplied to the Create Backend operation.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	backendId, resourceGroupName, serviceName, subscriptionId	Gets the details of the backend specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of backends in the specified service instance.
create_or_update	INSERT	backendId, resourceGroupName, serviceName, subscriptionId	Creates or Updates a backend.
delete	DELETE	If-Match, backendId, resourceGroupName, serviceName, subscriptionId	Deletes the specified backend.
update	UPDATE	If-Match, backendId, resourceGroupName, serviceName, subscriptionId	Updates an existing backend.
reconnect	EXEC	backendId, resourceGroupName, serviceName, subscriptionId	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.

SELECT examples

Lists a collection of backends in the specified service instance.

vw_backends

SELECT
description,
backendId,
circuit_breaker,
credentials,
pool,
properties,
protocol,
proxy,
resourceGroupName,
resource_id,
serviceName,
subscriptionId,
title,
tls,
type,
url
FROM azure.api_management.vw_backends
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

backends

SELECT
properties
FROM azure.api_management.backends
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new backends resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.backends (
backendId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ backendId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: url
          value: string
        - name: protocol
          value: string
        - name: title
          value: string
        - name: description
          value: string
        - name: resourceId
          value: string
        - name: properties
          value:
            - name: serviceFabricCluster
              value:
                - name: clientCertificateId
                  value: string
                - name: clientCertificatethumbprint
                  value: string
                - name: maxPartitionResolutionRetries
                  value: integer
                - name: managementEndpoints
                  value:
                    - string
                - name: serverCertificateThumbprints
                  value:
                    - string
                - name: serverX509Names
                  value:
                    - - name: name
                        value: string
                      - name: issuerCertificateThumbprint
                        value: string
        - name: credentials
          value:
            - name: certificateIds
              value:
                - string
            - name: certificate
              value:
                - string
            - name: query
              value: object
            - name: header
              value: object
            - name: authorization
              value:
                - name: scheme
                  value: string
                - name: parameter
                  value: string
        - name: proxy
          value:
            - name: url
              value: string
            - name: username
              value: string
            - name: password
              value: string
        - name: tls
          value:
            - name: validateCertificateChain
              value: boolean
            - name: validateCertificateName
              value: boolean
        - name: circuitBreaker
          value:
            - name: rules
              value:
                - - name: name
                    value: string
                  - name: failureCondition
                    value:
                      - name: count
                        value: integer
                      - name: percentage
                        value: integer
                      - name: interval
                        value: string
                      - name: statusCodeRanges
                        value:
                          - - name: min
                              value: integer
                            - name: max
                              value: integer
                      - name: errorReasons
                        value:
                          - string
                  - name: tripDuration
                    value: string
                  - name: acceptRetryAfter
                    value: boolean
        - name: pool
          value: string
        - name: type
          value: string

UPDATE example

Updates a backends resource.

/*+ update */
UPDATE azure.api_management.backends
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND backendId = '{{ backendId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified backends resource.

/*+ delete */
DELETE FROM azure.api_management.backends
WHERE If-Match = '{{ If-Match }}'
AND backendId = '{{ backendId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';