Share via

Microsoft.ApiManagement gateways/hostnameBindings 2025-03-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/gateways/hostnameBindings@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    hostname: 'string'
    keyVault: {
      identityClientId: 'string'
      lastStatus: {}
      secretId: 'string'
    }
  }
}

Property Values

Microsoft.ApiManagement/gateways/hostnameBindings

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 45
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (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: gateways
properties Properties of the API Management gateway hostname binding. GatewayHostnameBindingBaseProperties (required)

GatewayHostnameBindingBaseProperties

Name Description Value
hostname The default hostname of the data-plane gateway. string (required)
keyVault The link to the API Management service workspace. GatewayHostnameBindingKeyVault (required)

GatewayHostnameBindingKeyVault

Name Description Value
identityClientId The default hostname of the data-plane gateway. string
lastStatus The last status of the Key Vault certificate fetch process. GatewayHostnameBindingKeyVaultLastStatus
secretId The current provisioning state of the API Management gateway hostname binding. string (required)

GatewayHostnameBindingKeyVaultLastStatus

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.ApiManagement/gateways/hostnameBindings",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "hostname": "string",
    "keyVault": {
      "identityClientId": "string",
      "lastStatus": {
      },
      "secretId": "string"
    }
  }
}

Property Values

Microsoft.ApiManagement/gateways/hostnameBindings

Name Description Value
apiVersion The api version '2025-03-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 45
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required)
properties Properties of the API Management gateway hostname binding. GatewayHostnameBindingBaseProperties (required)
type The resource type 'Microsoft.ApiManagement/gateways/hostnameBindings'

GatewayHostnameBindingBaseProperties

Name Description Value
hostname The default hostname of the data-plane gateway. string (required)
keyVault The link to the API Management service workspace. GatewayHostnameBindingKeyVault (required)

GatewayHostnameBindingKeyVault

Name Description Value
identityClientId The default hostname of the data-plane gateway. string
lastStatus The last status of the Key Vault certificate fetch process. GatewayHostnameBindingKeyVaultLastStatus
secretId The current provisioning state of the API Management gateway hostname binding. string (required)

GatewayHostnameBindingKeyVaultLastStatus

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/gateways/hostnameBindings@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      hostname = "string"
      keyVault = {
        identityClientId = "string"
        lastStatus = {
        }
        secretId = "string"
      }
    }
  }
}

Property Values

Microsoft.ApiManagement/gateways/hostnameBindings

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 45
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: gateways
properties Properties of the API Management gateway hostname binding. GatewayHostnameBindingBaseProperties (required)
type The resource type "Microsoft.ApiManagement/gateways/hostnameBindings@2025-03-01-preview"

GatewayHostnameBindingBaseProperties

Name Description Value
hostname The default hostname of the data-plane gateway. string (required)
keyVault The link to the API Management service workspace. GatewayHostnameBindingKeyVault (required)

GatewayHostnameBindingKeyVault

Name Description Value
identityClientId The default hostname of the data-plane gateway. string
lastStatus The last status of the Key Vault certificate fetch process. GatewayHostnameBindingKeyVaultLastStatus
secretId The current provisioning state of the API Management gateway hostname binding. string (required)

GatewayHostnameBindingKeyVaultLastStatus

Name Description Value
  • Last updated on