Share via

Microsoft.ApiManagement service/backends 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-07-07' = {
  parent: resourceSymbolicName
  host: 'string'
  name: 'string'
  skipCertificateChainValidation: bool
}

Property Values

Microsoft.ApiManagement/service/backends

Name Description Value
host Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. string

Constraints:
Min length = 1
Max length = 255 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[^*#&+:<>?]+$ (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
skipCertificateChainValidation Flag indicating whether SSL certificate chain 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-07-07",
  "name": "string",
  "host": "string",
  "skipCertificateChainValidation": "bool"
}

Property Values

Microsoft.ApiManagement/service/backends

Name Description Value
apiVersion The api version '2016-07-07'
host Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. string

Constraints:
Min length = 1
Max length = 255 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[^*#&+:<>?]+$ (required)
skipCertificateChainValidation Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. bool
type The resource type 'Microsoft.ApiManagement/service/backends'

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-07-07"
  name = "string"
  parent_id = "string"
  body = {
    host = "string"
    skipCertificateChainValidation = bool
  }
}

Property Values

Microsoft.ApiManagement/service/backends

Name Description Value
host Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. string

Constraints:
Min length = 1
Max length = 255 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
skipCertificateChainValidation Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. bool
type The resource type "Microsoft.ApiManagement/service/backends@2016-07-07"

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    = ["*"]
}
  • Last updated on