Backend - List By Service

Lists a collection of backends in the specified service instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

$filter
query

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 |

$skip
query

integer

int32

Number of records to skip.

$top
query

integer

int32

Number of records to return.

Responses

Name Type Description
200 OK

BackendCollection

Lists a collection of Backend entities.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementListBackends

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends?api-version=2021-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
      "type": "Microsoft.ApiManagement/service/backends",
      "name": "proxybackend",
      "properties": {
        "description": "description5308",
        "url": "https://backendname2644/",
        "protocol": "http",
        "credentials": {
          "query": {
            "sv": [
              "xx",
              "bb",
              "cc"
            ]
          },
          "header": {
            "x-my-1": [
              "val1",
              "val2"
            ]
          },
          "authorization": {
            "scheme": "Basic",
            "parameter": "opensesma"
          }
        },
        "proxy": {
          "url": "http://192.168.1.1:8080",
          "username": "Contoso\\admin",
          "password": "<password>"
        },
        "tls": {
          "validateCertificateChain": false,
          "validateCertificateName": false
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
      "type": "Microsoft.ApiManagement/service/backends",
      "name": "sfbackend",
      "properties": {
        "description": "Service Fabric Test App 1",
        "url": "fabric:/mytestapp/mytestservice",
        "protocol": "http",
        "properties": {
          "serviceFabricCluster": {
            "managementEndpoints": [
              "https://somecluster.com"
            ],
            "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
            "serverX509Names": [
              {
                "name": "ServerCommonName1",
                "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
              }
            ],
            "maxPartitionResolutionRetries": 5
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definitions

Name Description
BackendAuthorizationHeaderCredentials

Authorization header information.

BackendCollection

Paged Backend list representation.

BackendContract

Backend details.

BackendCredentialsContract

Details of the Credentials used to connect to Backend.

BackendProperties

Properties specific to the Backend Type.

BackendProtocol

Backend communication protocol.

BackendProxyContract

Details of the Backend WebProxy Server to use in the Request to Backend.

BackendServiceFabricClusterProperties

Properties of the Service Fabric Type Backend.

BackendTlsProperties

Properties controlling TLS Certificate Validation.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

X509CertificateName

Properties of server X509Names.

BackendAuthorizationHeaderCredentials

Authorization header information.

Name Type Description
parameter

string

Authentication Parameter value.

scheme

string

Authentication Scheme name.

BackendCollection

Paged Backend list representation.

Name Type Description
count

integer

Total record count number across all pages.

nextLink

string

Next page link if any.

value

BackendContract[]

Backend values.

BackendContract

Backend details.

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

properties.credentials

BackendCredentialsContract

Backend Credentials Contract Properties

properties.description

string

Backend Description.

properties.properties

BackendProperties

Backend Properties contract

properties.protocol

BackendProtocol

Backend communication protocol.

properties.proxy

BackendProxyContract

Backend Proxy Contract Properties

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.

properties.title

string

Backend Title.

properties.tls

BackendTlsProperties

Backend TLS Properties

properties.url

string

Runtime Url of the Backend.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Details of the Credentials used to connect to Backend.

Name Type Description
authorization

BackendAuthorizationHeaderCredentials

Authorization header authentication

certificate

string[]

List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

certificateIds

string[]

List of Client Certificate Ids.

header

object

Header Parameter description.

query

object

Query Parameter description.

BackendProperties

Properties specific to the Backend Type.

Name Type Description
serviceFabricCluster

BackendServiceFabricClusterProperties

Backend Service Fabric Cluster Properties

BackendProtocol

Backend communication protocol.

Name Type Description
http

string

The Backend is a RESTful service.

soap

string

The Backend is a SOAP service.

BackendProxyContract

Details of the Backend WebProxy Server to use in the Request to Backend.

Name Type Description
password

string

Password to connect to the WebProxy Server

url

string

WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

username

string

Username to connect to the WebProxy server

BackendServiceFabricClusterProperties

Properties of the Service Fabric Type Backend.

Name Type Description
clientCertificateId

string

The client certificate id for the management endpoint.

clientCertificatethumbprint

string

The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided

managementEndpoints

string[]

The cluster management endpoint.

maxPartitionResolutionRetries

integer

Maximum number of retries while attempting resolve the partition.

serverCertificateThumbprints

string[]

Thumbprints of certificates cluster management service uses for tls communication

serverX509Names

X509CertificateName[]

Server X509 Certificate Names Collection

BackendTlsProperties

Properties controlling TLS Certificate Validation.

Name Type Default value Description
validateCertificateChain

boolean

True

Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.

validateCertificateName

boolean

True

Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.

X509CertificateName

Properties of server X509Names.

Name Type Description
issuerCertificateThumbprint

string

Thumbprint for the Issuer of the Certificate.

name

string

Common Name of the Certificate.