Microsoft.Web kubeEnvironments 2023-01-01

Article
10/25/2024

Remarks

This resource type has migrated to the Microsoft.App namespace. For the new resource type, see Microsoft.App managedEnvironments.

For information about the migration, see Action Required: Namespace migration from Microsoft.Web to Microsoft.App in March 2022.

Bicep resource definition

The kubeEnvironments resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.Web/kubeEnvironments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/kubeEnvironments@2023-01-01' = {
  extendedLocation: {
    name: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    aksResourceID: 'string'
    appLogsConfiguration: {
      destination: 'string'
      logAnalyticsConfiguration: {
        customerId: 'string'
        sharedKey: 'string'
      }
    }
    arcConfiguration: {
      artifactsStorageType: 'string'
      artifactStorageAccessMode: 'string'
      artifactStorageClassName: 'string'
      artifactStorageMountPath: 'string'
      artifactStorageNodeName: 'string'
      frontEndServiceConfiguration: {
        kind: 'string'
      }
      kubeConfig: 'string'
    }
    containerAppsConfiguration: {
      appSubnetResourceId: 'string'
      controlPlaneSubnetResourceId: 'string'
      daprAIInstrumentationKey: 'string'
      dockerBridgeCidr: 'string'
      platformReservedCidr: 'string'
      platformReservedDnsIP: 'string'
    }
    environmentType: 'string'
    internalLoadBalancerEnabled: bool
    staticIp: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AppLogsConfiguration

Name	Description	Value
destination		string
logAnalyticsConfiguration		LogAnalyticsConfiguration

ArcConfiguration

Name	Description	Value
artifactsStorageType		'LocalNode' 'NetworkFileSystem'
artifactStorageAccessMode		string
artifactStorageClassName		string
artifactStorageMountPath		string
artifactStorageNodeName		string
frontEndServiceConfiguration		FrontEndConfiguration
kubeConfig		string Constraints: Sensitive value. Pass in as a secure parameter.

ContainerAppsConfiguration

Name	Description	Value
appSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
controlPlaneSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
daprAIInstrumentationKey	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry	string
dockerBridgeCidr	CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.	string
platformReservedCidr	IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.	string
platformReservedDnsIP	An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

FrontEndConfiguration

Name	Description	Value
kind		'LoadBalancer' 'NodePort'

KubeEnvironmentProperties

Name	Description	Value
aksResourceID		string
appLogsConfiguration	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported	AppLogsConfiguration
arcConfiguration	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.	ArcConfiguration
containerAppsConfiguration	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration	ContainerAppsConfiguration
environmentType	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed	string
internalLoadBalancerEnabled	Only visible within Vnet/Subnet	bool
staticIp	Static IP of the KubeEnvironment	string

LogAnalyticsConfiguration

Name	Description	Value
customerId		string
sharedKey		string Constraints: Sensitive value. Pass in as a secure parameter.

Microsoft.Web/kubeEnvironments

Name	Description	Value
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	KubeEnvironment resource specific properties	KubeEnvironmentProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

ARM template resource definition

The kubeEnvironments resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.Web/kubeEnvironments resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/kubeEnvironments",
  "apiVersion": "2023-01-01",
  "name": "string",
  "extendedLocation": {
    "name": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "aksResourceID": "string",
    "appLogsConfiguration": {
      "destination": "string",
      "logAnalyticsConfiguration": {
        "customerId": "string",
        "sharedKey": "string"
      }
    },
    "arcConfiguration": {
      "artifactsStorageType": "string",
      "artifactStorageAccessMode": "string",
      "artifactStorageClassName": "string",
      "artifactStorageMountPath": "string",
      "artifactStorageNodeName": "string",
      "frontEndServiceConfiguration": {
        "kind": "string"
      },
      "kubeConfig": "string"
    },
    "containerAppsConfiguration": {
      "appSubnetResourceId": "string",
      "controlPlaneSubnetResourceId": "string",
      "daprAIInstrumentationKey": "string",
      "dockerBridgeCidr": "string",
      "platformReservedCidr": "string",
      "platformReservedDnsIP": "string"
    },
    "environmentType": "string",
    "internalLoadBalancerEnabled": "bool",
    "staticIp": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AppLogsConfiguration

Name	Description	Value
destination		string
logAnalyticsConfiguration		LogAnalyticsConfiguration

ArcConfiguration

Name	Description	Value
artifactsStorageType		'LocalNode' 'NetworkFileSystem'
artifactStorageAccessMode		string
artifactStorageClassName		string
artifactStorageMountPath		string
artifactStorageNodeName		string
frontEndServiceConfiguration		FrontEndConfiguration
kubeConfig		string Constraints: Sensitive value. Pass in as a secure parameter.

ContainerAppsConfiguration

Name	Description	Value
appSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
controlPlaneSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
daprAIInstrumentationKey	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry	string
dockerBridgeCidr	CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.	string
platformReservedCidr	IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.	string
platformReservedDnsIP	An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

FrontEndConfiguration

Name	Description	Value
kind		'LoadBalancer' 'NodePort'

KubeEnvironmentProperties

Name	Description	Value
aksResourceID		string
appLogsConfiguration	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported	AppLogsConfiguration
arcConfiguration	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.	ArcConfiguration
containerAppsConfiguration	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration	ContainerAppsConfiguration
environmentType	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed	string
internalLoadBalancerEnabled	Only visible within Vnet/Subnet	bool
staticIp	Static IP of the KubeEnvironment	string

LogAnalyticsConfiguration

Name	Description	Value
customerId		string
sharedKey		string Constraints: Sensitive value. Pass in as a secure parameter.

Microsoft.Web/kubeEnvironments

Name	Description	Value
apiVersion	The api version	'2023-01-01'
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	KubeEnvironment resource specific properties	KubeEnvironmentProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Web/kubeEnvironments'

ResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/kubeEnvironments@2023-01-01"
  name = "string"
  extendedLocation = {
    name = "string"
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      aksResourceID = "string"
      appLogsConfiguration = {
        destination = "string"
        logAnalyticsConfiguration = {
          customerId = "string"
          sharedKey = "string"
        }
      }
      arcConfiguration = {
        artifactsStorageType = "string"
        artifactStorageAccessMode = "string"
        artifactStorageClassName = "string"
        artifactStorageMountPath = "string"
        artifactStorageNodeName = "string"
        frontEndServiceConfiguration = {
          kind = "string"
        }
        kubeConfig = "string"
      }
      containerAppsConfiguration = {
        appSubnetResourceId = "string"
        controlPlaneSubnetResourceId = "string"
        daprAIInstrumentationKey = "string"
        dockerBridgeCidr = "string"
        platformReservedCidr = "string"
        platformReservedDnsIP = "string"
      }
      environmentType = "string"
      internalLoadBalancerEnabled = bool
      staticIp = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

AppLogsConfiguration

Name	Description	Value
destination		string
logAnalyticsConfiguration		LogAnalyticsConfiguration

ArcConfiguration

Name	Description	Value
artifactsStorageType		'LocalNode' 'NetworkFileSystem'
artifactStorageAccessMode		string
artifactStorageClassName		string
artifactStorageMountPath		string
artifactStorageNodeName		string
frontEndServiceConfiguration		FrontEndConfiguration
kubeConfig		string Constraints: Sensitive value. Pass in as a secure parameter.

ContainerAppsConfiguration

Name	Description	Value
appSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
controlPlaneSubnetResourceId	Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.	string
daprAIInstrumentationKey	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry	string
dockerBridgeCidr	CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.	string
platformReservedCidr	IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.	string
platformReservedDnsIP	An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

FrontEndConfiguration

Name	Description	Value
kind		'LoadBalancer' 'NodePort'

KubeEnvironmentProperties

Name	Description	Value
aksResourceID		string
appLogsConfiguration	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported	AppLogsConfiguration
arcConfiguration	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.	ArcConfiguration
containerAppsConfiguration	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration	ContainerAppsConfiguration
environmentType	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed	string
internalLoadBalancerEnabled	Only visible within Vnet/Subnet	bool
staticIp	Static IP of the KubeEnvironment	string

LogAnalyticsConfiguration

Name	Description	Value
customerId		string
sharedKey		string Constraints: Sensitive value. Pass in as a secure parameter.

Microsoft.Web/kubeEnvironments

Name	Description	Value
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	KubeEnvironment resource specific properties	KubeEnvironmentProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Web/kubeEnvironments@2023-01-01"

ResourceTags

Name	Description	Value

Share via

Microsoft.Web kubeEnvironments 2023-01-01

Remarks

Bicep resource definition

Resource format

Property values

AppLogsConfiguration

ArcConfiguration

ContainerAppsConfiguration

ExtendedLocation

FrontEndConfiguration

KubeEnvironmentProperties

LogAnalyticsConfiguration

Microsoft.Web/kubeEnvironments

ResourceTags

ARM template resource definition

Resource format

Property values

AppLogsConfiguration

ArcConfiguration

ContainerAppsConfiguration

ExtendedLocation

FrontEndConfiguration

KubeEnvironmentProperties

LogAnalyticsConfiguration

Microsoft.Web/kubeEnvironments

ResourceTags

Terraform (AzAPI provider) resource definition

Resource format

Property values

AppLogsConfiguration

ArcConfiguration

ContainerAppsConfiguration

ExtendedLocation

FrontEndConfiguration

KubeEnvironmentProperties

LogAnalyticsConfiguration

Microsoft.Web/kubeEnvironments

ResourceTags

Feedback

Additional resources