Microsoft.ApiManagement service/backends 2016-10-10

• Latest
• 2024-10-01-preview
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep resource definition

The service/backends resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/backends resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2016-10-10' = {
  parent: resourceSymbolicName
  certificate: [
    'string'
  ]
  description: 'string'
  header: {
    {customized property}: [
      'string'
    ]
  }
  name: 'string'
  parameter: 'string'
  password: 'string'
  properties: {
    skipCertificateChainValidation: bool
    skipCertificateNameValidation: bool
  }
  protocol: 'string'
  query: {
    {customized property}: [
      'string'
    ]
  }
  resourceId: 'string'
  scheme: 'string'
  title: 'string'
  url: 'string'
  username: 'string'
}

Property Values

Microsoft.ApiManagement/service/backends

Name	Description	Value
certificate	List of Client Certificate Thumbprint.	string[]
description	Backend Description.	string Constraints: Min length = 1 Max length = 2000
header	Header Parameter description.	BackendCredentialsContractHeader
name	The resource name	string Constraints: Min length = 1 Max length = 255 Pattern = ^[^*#&+:<>?]+$ (required)
parameter	Authentication Parameter value.	string Constraints: Min length = 1 Max length = 300 (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: service
password	Password to connect to the WebProxy Server	string
properties	Properties specific to a Backend.	BackendProperties
protocol	Backend communication protocol.	'http' 'soap' (required)
query	Query Parameter description.	BackendCredentialsContractQuery
resourceId	Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.	string Constraints: Min length = 1 Max length = 2000
scheme	Authentication Scheme name.	string Constraints: Min length = 1 Max length = 100 (required)
title	Backend Title.	string Constraints: Min length = 1 Max length = 300
url	WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.	string Constraints: Min length = 1 Max length = 2000 (required)
username	Username to connect to the WebProxy server	string

BackendCredentialsContractHeader

Name	Description	Value

BackendCredentialsContractQuery

Name	Description	Value

BackendProperties

Name	Description	Value
skipCertificateChainValidation	Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.	bool
skipCertificateNameValidation	Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host.	bool

ARM template resource definition

The service/backends resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/backends resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2016-10-10",
  "name": "string",
  "certificate": [ "string" ],
  "description": "string",
  "header": {
    "{customized property}": [ "string" ]
  },
  "parameter": "string",
  "password": "string",
  "properties": {
    "skipCertificateChainValidation": "bool",
    "skipCertificateNameValidation": "bool"
  },
  "protocol": "string",
  "query": {
    "{customized property}": [ "string" ]
  },
  "resourceId": "string",
  "scheme": "string",
  "title": "string",
  "url": "string",
  "username": "string"
}

Property Values

Microsoft.ApiManagement/service/backends

Name	Description	Value
apiVersion	The api version	'2016-10-10'
certificate	List of Client Certificate Thumbprint.	string[]
description	Backend Description.	string Constraints: Min length = 1 Max length = 2000
header	Header Parameter description.	BackendCredentialsContractHeader
name	The resource name	string Constraints: Min length = 1 Max length = 255 Pattern = ^[^*#&+:<>?]+$ (required)
parameter	Authentication Parameter value.	string Constraints: Min length = 1 Max length = 300 (required)
password	Password to connect to the WebProxy Server	string
properties	Properties specific to a Backend.	BackendProperties
protocol	Backend communication protocol.	'http' 'soap' (required)
query	Query Parameter description.	BackendCredentialsContractQuery
resourceId	Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.	string Constraints: Min length = 1 Max length = 2000
scheme	Authentication Scheme name.	string Constraints: Min length = 1 Max length = 100 (required)
title	Backend Title.	string Constraints: Min length = 1 Max length = 300
type	The resource type	'Microsoft.ApiManagement/service/backends'
url	WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.	string Constraints: Min length = 1 Max length = 2000 (required)
username	Username to connect to the WebProxy server	string

BackendCredentialsContractHeader

Name	Description	Value

BackendCredentialsContractQuery

Name	Description	Value

BackendProperties

Name	Description	Value
skipCertificateChainValidation	Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.	bool
skipCertificateNameValidation	Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host.	bool

Usage Examples

Terraform (AzAPI provider) resource definition

The service/backends resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/backends resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2016-10-10"
  name = "string"
  parent_id = "string"
  body = {
    certificate = [
      "string"
    ]
    description = "string"
    header = {
      {customized property} = [
        "string"
      ]
    }
    parameter = "string"
    password = "string"
    properties = {
      skipCertificateChainValidation = bool
      skipCertificateNameValidation = bool
    }
    protocol = "string"
    query = {
      {customized property} = [
        "string"
      ]
    }
    resourceId = "string"
    scheme = "string"
    title = "string"
    url = "string"
    username = "string"
  }
}

Property Values

Microsoft.ApiManagement/service/backends

Name	Description	Value
certificate	List of Client Certificate Thumbprint.	string[]
description	Backend Description.	string Constraints: Min length = 1 Max length = 2000
header	Header Parameter description.	BackendCredentialsContractHeader
name	The resource name	string Constraints: Min length = 1 Max length = 255 Pattern = ^[^*#&+:<>?]+$ (required)
parameter	Authentication Parameter value.	string Constraints: Min length = 1 Max length = 300 (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: service
password	Password to connect to the WebProxy Server	string
properties	Properties specific to a Backend.	BackendProperties
protocol	Backend communication protocol.	'http' 'soap' (required)
query	Query Parameter description.	BackendCredentialsContractQuery
resourceId	Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.	string Constraints: Min length = 1 Max length = 2000
scheme	Authentication Scheme name.	string Constraints: Min length = 1 Max length = 100 (required)
title	Backend Title.	string Constraints: Min length = 1 Max length = 300
type	The resource type	"Microsoft.ApiManagement/service/backends@2016-10-10"
url	WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.	string Constraints: Min length = 1 Max length = 2000 (required)
username	Username to connect to the WebProxy server	string

BackendCredentialsContractHeader

Name	Description	Value

BackendCredentialsContractQuery

Name	Description	Value

BackendProperties

Name	Description	Value
skipCertificateChainValidation	Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.	bool
skipCertificateNameValidation	Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host.	bool

Usage Examples

Terraform Samples

A basic example of deploying backend within an API Management Service.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backend" {
  type      = "Microsoft.ApiManagement/service/backends@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      protocol = "http"
      url      = "https://acctest"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}