Microsoft.DataLakeStore accounts 2015-10-01-preview

Article
12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.DataLakeStore/accounts@2015-10-01-preview' = {
  identity: {
    type: 'SystemAssigned'
  }
  location: 'string'
  name: 'string'
  properties: {
    defaultGroup: 'string'
    encryptionConfig: {
      keyVaultMetaInfo: {
        encryptionKeyName: 'string'
        encryptionKeyVersion: 'string'
        keyVaultResourceId: 'string'
      }
      type: 'string'
    }
    encryptionState: 'string'
    endpoint: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

DataLakeStoreAccountProperties

Name	Description	Value
defaultGroup	the default owner group for all new folders and files created in the Data Lake Store account.	string
encryptionConfig	The Key vault encryption configuration.	EncryptionConfig
encryptionState	The current state of encryption for this Data Lake store account.	'Disabled' 'Enabled'
endpoint	the gateway host.	string

DataLakeStoreAccountTags

Name	Description	Value

EncryptionConfig

Name	Description	Value
keyVaultMetaInfo	The Key vault information for connecting to user managed encryption keys.	KeyVaultMetaInfo
type	The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.	'ServiceManaged' 'UserManaged'

EncryptionIdentity

Name	Description	Value
type	The type of encryption being used. Currently the only supported type is 'SystemAssigned'.	'SystemAssigned'

KeyVaultMetaInfo

Name	Description	Value
encryptionKeyName	The name of the user managed encryption key.	string
encryptionKeyVersion	The version of the user managed encryption key.	string
keyVaultResourceId	The resource identifier for the user managed Key Vault being used to encrypt.	string

Microsoft.DataLakeStore/accounts

Name	Description	Value
identity	The Key vault encryption identity, if any.	EncryptionIdentity
location	the account regional location.	string
name	The resource name	string (required)
properties	the Data Lake Store account properties.	DataLakeStoreAccountProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Deploy Data Lake Store account with encryption(Data Lake)	This template allows you to deploy an Azure Data Lake Store account with data encryption enabled. This account uses the Data Lake store account to manage the encryption key.

ARM template resource definition

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

{
  "type": "Microsoft.DataLakeStore/accounts",
  "apiVersion": "2015-10-01-preview",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "string",
  "properties": {
    "defaultGroup": "string",
    "encryptionConfig": {
      "keyVaultMetaInfo": {
        "encryptionKeyName": "string",
        "encryptionKeyVersion": "string",
        "keyVaultResourceId": "string"
      },
      "type": "string"
    },
    "encryptionState": "string",
    "endpoint": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

DataLakeStoreAccountProperties

Name	Description	Value
defaultGroup	the default owner group for all new folders and files created in the Data Lake Store account.	string
encryptionConfig	The Key vault encryption configuration.	EncryptionConfig
encryptionState	The current state of encryption for this Data Lake store account.	'Disabled' 'Enabled'
endpoint	the gateway host.	string

DataLakeStoreAccountTags

Name	Description	Value

EncryptionConfig

Name	Description	Value
keyVaultMetaInfo	The Key vault information for connecting to user managed encryption keys.	KeyVaultMetaInfo
type	The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.	'ServiceManaged' 'UserManaged'

EncryptionIdentity

Name	Description	Value
type	The type of encryption being used. Currently the only supported type is 'SystemAssigned'.	'SystemAssigned'

KeyVaultMetaInfo

Name	Description	Value
encryptionKeyName	The name of the user managed encryption key.	string
encryptionKeyVersion	The version of the user managed encryption key.	string
keyVaultResourceId	The resource identifier for the user managed Key Vault being used to encrypt.	string

Microsoft.DataLakeStore/accounts

Name	Description	Value
apiVersion	The api version	'2015-10-01-preview'
identity	The Key vault encryption identity, if any.	EncryptionIdentity
location	the account regional location.	string
name	The resource name	string (required)
properties	the Data Lake Store account properties.	DataLakeStoreAccountProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DataLakeStore/accounts'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Azure Data Lake Store with no data encryption	This template allows you to deploy an Azure Data Lake Store account with data encryption disabled.
Deploy Data Lake Analytics on new Data Lake Store	This template allows you to deploy a new Data Lake Analytics account on a new Data Lake Store account.
Deploy Data Lake Store account with encryption(Data Lake)	This template allows you to deploy an Azure Data Lake Store account with data encryption enabled. This account uses the Data Lake store account to manage the encryption key.
Deploy Data Lake Store account with encryption(Key Vault)	This template allows you to deploy an Azure Data Lake Store account with data encryption enabled. This account uses Azure Key Vault to manage the encryption key.
Deploy HDInsight on new Data Lake Store and Storage	This template allows you to deploy a new Linux HDInsight cluster with new Data Lake Store and Storage accounts.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataLakeStore/accounts@2015-10-01-preview"
  name = "string"
  identity = {
    type = "SystemAssigned"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      defaultGroup = "string"
      encryptionConfig = {
        keyVaultMetaInfo = {
          encryptionKeyName = "string"
          encryptionKeyVersion = "string"
          keyVaultResourceId = "string"
        }
        type = "string"
      }
      encryptionState = "string"
      endpoint = "string"
    }
  })
}

Property values

DataLakeStoreAccountProperties

Name	Description	Value
defaultGroup	the default owner group for all new folders and files created in the Data Lake Store account.	string
encryptionConfig	The Key vault encryption configuration.	EncryptionConfig
encryptionState	The current state of encryption for this Data Lake store account.	'Disabled' 'Enabled'
endpoint	the gateway host.	string

DataLakeStoreAccountTags

Name	Description	Value

EncryptionConfig

Name	Description	Value
keyVaultMetaInfo	The Key vault information for connecting to user managed encryption keys.	KeyVaultMetaInfo
type	The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.	'ServiceManaged' 'UserManaged'

EncryptionIdentity

Name	Description	Value
type	The type of encryption being used. Currently the only supported type is 'SystemAssigned'.	'SystemAssigned'

KeyVaultMetaInfo

Name	Description	Value
encryptionKeyName	The name of the user managed encryption key.	string
encryptionKeyVersion	The version of the user managed encryption key.	string
keyVaultResourceId	The resource identifier for the user managed Key Vault being used to encrypt.	string

Microsoft.DataLakeStore/accounts

Name	Description	Value
identity	The Key vault encryption identity, if any.	EncryptionIdentity
location	the account regional location.	string
name	The resource name	string (required)
properties	the Data Lake Store account properties.	DataLakeStoreAccountProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DataLakeStore/accounts@2015-10-01-preview"

Share via

Microsoft.DataLakeStore accounts 2015-10-01-preview

Bicep resource definition

Resource format

Property values

DataLakeStoreAccountProperties

DataLakeStoreAccountTags

EncryptionConfig

EncryptionIdentity

KeyVaultMetaInfo

Microsoft.DataLakeStore/accounts

Quickstart samples

ARM template resource definition

Resource format

Property values

DataLakeStoreAccountProperties

DataLakeStoreAccountTags

EncryptionConfig

EncryptionIdentity

KeyVaultMetaInfo

Microsoft.DataLakeStore/accounts

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

DataLakeStoreAccountProperties

DataLakeStoreAccountTags

EncryptionConfig

EncryptionIdentity

KeyVaultMetaInfo

Microsoft.DataLakeStore/accounts

Feedback

Additional resources