Microsoft.App connectedEnvironments 2022-10-01

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-10-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    customDomainConfiguration: {
      certificatePassword: 'string'
      certificateValue: any(Azure.Bicep.Types.Concrete.AnyType)
      dnsSuffix: 'string'
    }
    daprAIConnectionString: 'string'
    staticIp: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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 any
dnsSuffix Dns suffix for the environment domain string

ExtendedLocation

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

Microsoft.App/connectedEnvironments

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

TrackedResourceTags

Name Description Value

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-10-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "customDomainConfiguration": {
      "certificatePassword": "string",
      "certificateValue": {},
      "dnsSuffix": "string"
    },
    "daprAIConnectionString": "string",
    "staticIp": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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 any
dnsSuffix Dns suffix for the environment domain string

ExtendedLocation

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

Microsoft.App/connectedEnvironments

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

TrackedResourceTags

Name Description Value

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-10-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      customDomainConfiguration = {
        certificatePassword = "string"
        certificateValue = ?
        dnsSuffix = "string"
      }
      daprAIConnectionString = "string"
      staticIp = "string"
    }
  })
}

Property values

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 any
dnsSuffix Dns suffix for the environment domain string

ExtendedLocation

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

Microsoft.App/connectedEnvironments

Name Description Value
extendedLocation The complex type of the extended location. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties ConnectedEnvironment resource specific properties ConnectedEnvironmentProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.App/connectedEnvironments@2022-10-01"

TrackedResourceTags

Name Description Value