Share via

Microsoft.Web kubeEnvironments 2021-01-01

  • Article

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:

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@2021-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'
    }
    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.

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
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:

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": "2021-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"
    },
    "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.

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
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 '2021-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@2021-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"
      }
      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.

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
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@2021-01-01"

ResourceTags

Name Description Value