Microsoft.Web kubeEnvironments 2021-01-01

Bicep resource definition

The kubeEnvironments resource type can be deployed to:

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

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.

Resource format

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

resource symbolicname 'Microsoft.Web/kubeEnvironments@2021-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  extendedLocation: {
    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'
    }
    internalLoadBalancerEnabled: bool
    staticIp: 'string'
  }
}

Property values

kubeEnvironments

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

ExtendedLocation

Name Description Value
name Name of extended location. string

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
internalLoadBalancerEnabled Only visible within Vnet/Subnet bool
staticIp Static IP of the KubeEnvironment string

AppLogsConfiguration

Name Description Value
destination string
logAnalyticsConfiguration LogAnalyticsConfiguration

LogAnalyticsConfiguration

Name Description Value
customerId string
sharedKey string

ArcConfiguration

Name Description Value
artifactsStorageType 'LocalNode'
'NetworkFileSystem'
artifactStorageAccessMode string
artifactStorageClassName string
artifactStorageMountPath string
artifactStorageNodeName string
frontEndServiceConfiguration FrontEndConfiguration
kubeConfig string

FrontEndConfiguration

Name Description Value
kind 'LoadBalancer'
'NodePort'

ARM template resource definition

The kubeEnvironments resource type can be deployed to:

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

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.

Resource format

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

{
  "type": "Microsoft.Web/kubeEnvironments",
  "apiVersion": "2021-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "extendedLocation": {
    "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"
    },
    "internalLoadBalancerEnabled": "bool",
    "staticIp": "string"
  }
}

Property values

kubeEnvironments

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

ExtendedLocation

Name Description Value
name Name of extended location. string

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
internalLoadBalancerEnabled Only visible within Vnet/Subnet bool
staticIp Static IP of the KubeEnvironment string

AppLogsConfiguration

Name Description Value
destination string
logAnalyticsConfiguration LogAnalyticsConfiguration

LogAnalyticsConfiguration

Name Description Value
customerId string
sharedKey string

ArcConfiguration

Name Description Value
artifactsStorageType 'LocalNode'
'NetworkFileSystem'
artifactStorageAccessMode string
artifactStorageClassName string
artifactStorageMountPath string
artifactStorageNodeName string
frontEndServiceConfiguration FrontEndConfiguration
kubeConfig string

FrontEndConfiguration

Name Description Value
kind 'LoadBalancer'
'NodePort'

Terraform (AzAPI provider) resource definition

The kubeEnvironments resource type can be deployed to:

  • 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@2021-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
      }
      internalLoadBalancerEnabled = bool
      staticIp = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
    }
  })
}

Property values

kubeEnvironments

Name Description Value
type The resource type "Microsoft.Web/kubeEnvironments@2021-01-01"
name The resource name string (required)
location Resource Location. 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.
kind Kind of resource. string
extendedLocation Extended Location. ExtendedLocation
properties KubeEnvironment resource specific properties KubeEnvironmentProperties

ExtendedLocation

Name Description Value
name Name of extended location. string

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
internalLoadBalancerEnabled Only visible within Vnet/Subnet bool
staticIp Static IP of the KubeEnvironment string

AppLogsConfiguration

Name Description Value
destination string
logAnalyticsConfiguration LogAnalyticsConfiguration

LogAnalyticsConfiguration

Name Description Value
customerId string
sharedKey string

ArcConfiguration

Name Description Value
artifactsStorageType "LocalNode"
"NetworkFileSystem"
artifactStorageAccessMode string
artifactStorageClassName string
artifactStorageMountPath string
artifactStorageNodeName string
frontEndServiceConfiguration FrontEndConfiguration
kubeConfig string

FrontEndConfiguration

Name Description Value
kind "LoadBalancer"
"NodePort"