Share via

Microsoft.ApiManagement service/gateways/hostnameConfigurations

  • Article

Bicep resource definition

The service/gateways/hostnameConfigurations 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/gateways/hostnameConfigurations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    certificateId: 'string'
    hostname: 'string'
    http2Enabled: bool
    negotiateClientCertificate: bool
    tls10Enabled: bool
    tls11Enabled: bool
  }
}

Property values

GatewayHostnameConfigurationContractProperties

Name Description Value
certificateId Identifier of Certificate entity that will be used for TLS connection establishment string
hostname Hostname value. Supports valid domain name, partial or full wildcard string
http2Enabled Specifies if HTTP/2.0 is supported bool
negotiateClientCertificate Determines whether gateway requests client certificate bool
tls10Enabled Specifies if TLS 1.0 is supported bool
tls11Enabled Specifies if TLS 1.1 is supported bool

Microsoft.ApiManagement/service/gateways/hostnameConfigurations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (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/gateways
properties Gateway hostname configuration details. GatewayHostnameConfigurationContractProperties

ARM template resource definition

The service/gateways/hostnameConfigurations 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/gateways/hostnameConfigurations resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "certificateId": "string",
    "hostname": "string",
    "http2Enabled": "bool",
    "negotiateClientCertificate": "bool",
    "tls10Enabled": "bool",
    "tls11Enabled": "bool"
  }
}

Property values

GatewayHostnameConfigurationContractProperties

Name Description Value
certificateId Identifier of Certificate entity that will be used for TLS connection establishment string
hostname Hostname value. Supports valid domain name, partial or full wildcard string
http2Enabled Specifies if HTTP/2.0 is supported bool
negotiateClientCertificate Determines whether gateway requests client certificate bool
tls10Enabled Specifies if TLS 1.0 is supported bool
tls11Enabled Specifies if TLS 1.1 is supported bool

Microsoft.ApiManagement/service/gateways/hostnameConfigurations

Name Description Value
apiVersion The api version '2024-06-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
properties Gateway hostname configuration details. GatewayHostnameConfigurationContractProperties
type The resource type 'Microsoft.ApiManagement/service/gateways/hostnameConfigurations'

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      certificateId = "string"
      hostname = "string"
      http2Enabled = bool
      negotiateClientCertificate = bool
      tls10Enabled = bool
      tls11Enabled = bool
    }
  })
}

Property values

GatewayHostnameConfigurationContractProperties

Name Description Value
certificateId Identifier of Certificate entity that will be used for TLS connection establishment string
hostname Hostname value. Supports valid domain name, partial or full wildcard string
http2Enabled Specifies if HTTP/2.0 is supported bool
negotiateClientCertificate Determines whether gateway requests client certificate bool
tls10Enabled Specifies if TLS 1.0 is supported bool
tls11Enabled Specifies if TLS 1.1 is supported bool

Microsoft.ApiManagement/service/gateways/hostnameConfigurations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/gateways
properties Gateway hostname configuration details. GatewayHostnameConfigurationContractProperties
type The resource type "Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2024-06-01-preview"