Microsoft.App connectedEnvironments 2022-11-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.App/connectedEnvironments@2022-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  extendedLocation: {
    name: 'string'
    type: 'CustomLocation'
  }
  properties: {
    customDomainConfiguration: {
      certificatePassword: 'string'
      certificateValue: any()
      dnsSuffix: 'string'
    }
    daprAIConnectionString: 'string'
    staticIp: 'string'
  }
}

Property values

connectedEnvironments

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
extendedLocation The complex type of the extended location. ExtendedLocation
properties ConnectedEnvironment resource specific properties ConnectedEnvironmentProperties

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

ConnectedEnvironmentProperties

Name Description Value
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration
daprAIConnectionString Application Insights connection string used by Dapr to export Service to Service communication telemetry string

Constraints:
Sensitive value. Pass in as a secure parameter.
staticIp Static IP of the connectedEnvironment string

CustomDomainConfiguration

Name Description Value
certificatePassword Certificate password string

Constraints:
Sensitive value. Pass in as a secure parameter.
certificateValue PFX or PEM blob For Bicep, you can use the any() function.
dnsSuffix Dns suffix for the environment domain string

ARM template resource definition

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

{
  "type": "Microsoft.App/connectedEnvironments",
  "apiVersion": "2022-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "extendedLocation": {
    "name": "string",
    "type": "CustomLocation"
  },
  "properties": {
    "customDomainConfiguration": {
      "certificatePassword": "string",
      "certificateValue": {},
      "dnsSuffix": "string"
    },
    "daprAIConnectionString": "string",
    "staticIp": "string"
  }
}

Property values

connectedEnvironments

Name Description Value
type The resource type 'Microsoft.App/connectedEnvironments'
apiVersion The resource api version '2022-11-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
extendedLocation The complex type of the extended location. ExtendedLocation
properties ConnectedEnvironment resource specific properties ConnectedEnvironmentProperties

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

ConnectedEnvironmentProperties

Name Description Value
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration
daprAIConnectionString Application Insights connection string used by Dapr to export Service to Service communication telemetry string

Constraints:
Sensitive value. Pass in as a secure parameter.
staticIp Static IP of the connectedEnvironment string

CustomDomainConfiguration

Name Description Value
certificatePassword Certificate password string

Constraints:
Sensitive value. Pass in as a secure parameter.
certificateValue PFX or PEM blob
dnsSuffix Dns suffix for the environment domain string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/connectedEnvironments@2022-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customDomainConfiguration = {
        certificatePassword = "string"
        dnsSuffix = "string"
      }
      daprAIConnectionString = "string"
      staticIp = "string"
    }
    extendedLocation = {
      name = "string"
      type = "CustomLocation"
    }
  })
}

Property values

connectedEnvironments

Name Description Value
type The resource type "Microsoft.App/connectedEnvironments@2022-11-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
extendedLocation The complex type of the extended location. ExtendedLocation
properties ConnectedEnvironment resource specific properties ConnectedEnvironmentProperties

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. "CustomLocation"

ConnectedEnvironmentProperties

Name Description Value
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration
daprAIConnectionString Application Insights connection string used by Dapr to export Service to Service communication telemetry string

Constraints:
Sensitive value. Pass in as a secure parameter.
staticIp Static IP of the connectedEnvironment string

CustomDomainConfiguration

Name Description Value
certificatePassword Certificate password string

Constraints:
Sensitive value. Pass in as a secure parameter.
certificateValue PFX or PEM blob
dnsSuffix Dns suffix for the environment domain string