Microsoft.DataLakeStore accounts 2016-11-01

The accounts resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DataLakeStore/accounts resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DataLakeStore/accounts@2016-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'SystemAssigned'
  }
  properties: {
    defaultGroup: 'string'
    encryptionConfig: {
      keyVaultMetaInfo: {
        encryptionKeyName: 'string'
        encryptionKeyVersion: 'string'
        keyVaultResourceId: 'string'
      }
      type: 'string'
    }
    encryptionState: 'string'
    firewallAllowAzureIps: 'string'
    firewallRules: [
      {
        name: 'string'
        properties: {
          endIpAddress: 'string'
          startIpAddress: 'string'
        }
      }
    ]
    firewallState: 'string'
    newTier: 'string'
    trustedIdProviders: [
      {
        name: 'string'
        properties: {
          idProvider: 'string'
        }
      }
    ]
    trustedIdProviderState: 'string'
    virtualNetworkRules: [
      {
        name: 'string'
        properties: {
          subnetId: 'string'
        }
      }
    ]
  }
}

Property values

accounts

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataLakeStore/accounts'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2016-11-01'
name The resource name string (required)
location The resource location. string (required)
tags The resource tags. Dictionary of tag names and values. See Tags in templates
identity The encryption identity properties. EncryptionIdentity
properties Data Lake Store account properties information. CreateDataLakeStoreAccountProperties

EncryptionIdentity

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

CreateDataLakeStoreAccountProperties

Name Description Value
defaultGroup The default owner group for all new folders and files created in the Data Lake Store account. string
encryptionConfig The encryption configuration for the account. EncryptionConfig
encryptionState The current state of encryption for this Data Lake Store account. 'Disabled'
'Enabled'
firewallAllowAzureIps The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. 'Disabled'
'Enabled'
firewallRules The list of firewall rules associated with this Data Lake Store account. CreateFirewallRuleWithAccountParameters[]
firewallState The current state of the IP address firewall for this Data Lake Store account. 'Disabled'
'Enabled'
newTier The commitment tier to use for next month. 'Commitment_100TB'
'Commitment_10TB'
'Commitment_1PB'
'Commitment_1TB'
'Commitment_500TB'
'Commitment_5PB'
'Consumption'
trustedIdProviders The list of trusted identity providers associated with this Data Lake Store account. CreateTrustedIdProviderWithAccountParameters[]
trustedIdProviderState The current state of the trusted identity provider feature for this Data Lake Store account. 'Disabled'
'Enabled'
virtualNetworkRules The list of virtual network rules associated with this Data Lake Store account. CreateVirtualNetworkRuleWithAccountParameters[]

EncryptionConfig

Name Description Value
keyVaultMetaInfo Metadata information used by account encryption. KeyVaultMetaInfo
type The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. 'ServiceManaged'
'UserManaged'

KeyVaultMetaInfo

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

CreateFirewallRuleWithAccountParameters

Name Description Value
name The resource name. string (required)
properties The firewall rule properties. CreateOrUpdateFirewallRuleProperties (required)

CreateOrUpdateFirewallRuleProperties

Name Description Value
endIpAddress The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. string (required)
startIpAddress The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. string (required)

CreateTrustedIdProviderWithAccountParameters

Name Description Value
name The resource name. string (required)
properties The trusted identity provider properties. CreateOrUpdateTrustedIdProviderProperties (required)

CreateOrUpdateTrustedIdProviderProperties

Name Description Value
idProvider The URL of this trusted identity provider. string (required)

CreateVirtualNetworkRuleWithAccountParameters

Name Description Value
name The resource name. string (required)
properties The virtual network rule properties. CreateOrUpdateVirtualNetworkRuleProperties (required)

CreateOrUpdateVirtualNetworkRuleProperties

Name Description Value
subnetId The resource identifier for the subnet. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Data Lake Analytics on new Data Lake Store

Deploy to Azure
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)

Deploy to Azure
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)

Deploy to Azure
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 Azure Data Lake Store with no data encryption

Deploy to Azure
This template allows you to deploy an Azure Data Lake Store account with data encryption disabled.
Deploy HDInsight on new Data Lake Store and Storage

Deploy to Azure
This template allows you to deploy a new Linux HDInsight cluster with new Data Lake Store and Storage accounts.