Accounts - Create
Creates the specified Data Lake Store account.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}?api-version=2016-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of the Data Lake Store account. |
resource
|
path | True |
string |
The name of the Azure resource group. |
subscription
|
path | True |
string |
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client Api Version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
location | True |
string |
The resource location. |
identity |
The Key Vault encryption identity, if any. |
||
properties.defaultGroup |
string |
The default owner group for all new folders and files created in the Data Lake Store account. |
|
properties.encryptionConfig |
The Key Vault encryption configuration. |
||
properties.encryptionState |
The current state of encryption for this Data Lake Store account. |
||
properties.firewallAllowAzureIps |
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. |
||
properties.firewallRules |
The list of firewall rules associated with this Data Lake Store account. |
||
properties.firewallState |
The current state of the IP address firewall for this Data Lake Store account. |
||
properties.newTier |
The commitment tier to use for next month. |
||
properties.trustedIdProviderState |
The current state of the trusted identity provider feature for this Data Lake Store account. |
||
properties.trustedIdProviders |
The list of trusted identity providers associated with this Data Lake Store account. |
||
properties.virtualNetworkRules |
The list of virtual network rules associated with this Data Lake Store account. |
||
tags |
object |
The resource tags. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully created the account. |
|
201 Created |
Successfully initiated creation of the account. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Creates the specified Data Lake Store account
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeStore/accounts/contosoadla?api-version=2016-11-01
{
"location": "eastus2",
"tags": {
"test_key": "test_value"
},
"identity": {
"type": "SystemAssigned"
},
"properties": {
"encryptionState": "Enabled",
"encryptionConfig": {
"type": "UserManaged",
"keyVaultMetaInfo": {
"keyVaultResourceId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"encryptionKeyName": "test_encryption_key_name",
"encryptionKeyVersion": "encryption_key_version"
}
},
"firewallState": "Enabled",
"firewallRules": [
{
"name": "test_rule",
"properties": {
"startIpAddress": "1.1.1.1",
"endIpAddress": "2.2.2.2"
}
}
],
"trustedIdProviderState": "Enabled",
"trustedIdProviders": [
{
"name": "test_trusted_id_provider_name",
"properties": {
"idProvider": "https://sts.windows.net/ea9ec534-a3e3-4e45-ad36-3afc5bb291c1"
}
}
],
"defaultGroup": "test_default_group",
"newTier": "Consumption",
"firewallAllowAzureIps": "Enabled"
}
}
Sample response
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "contosoadla",
"type": "test_type",
"location": "eastus2",
"tags": {
"test_key": "test_value"
},
"identity": {
"type": "SystemAssigned",
"principalId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"tenantId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab346"
},
"properties": {
"provisioningState": "Succeeded",
"state": "Active",
"creationTime": "2017-04-14T13:21:56.6819037-07:00",
"lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
"endpoint": "testadlfs17607.azuredatalakestore.net",
"accountId": "94f4bf5d-78a9-4c31-8aa7-b34d07bad898",
"encryptionState": "Enabled",
"encryptionProvisioningState": "Succeeded",
"encryptionConfig": {
"type": "UserManaged",
"keyVaultMetaInfo": {
"keyVaultResourceId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"encryptionKeyName": "test_encryption_key_name",
"encryptionKeyVersion": "encryption_key_version"
}
},
"firewallState": "Enabled",
"firewallRules": [
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "test_rule",
"type": "test_type",
"properties": {
"startIpAddress": "1.1.1.1",
"endIpAddress": "2.2.2.2"
}
}
],
"trustedIdProviderState": "Enabled",
"trustedIdProviders": [
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "test_trusted_id_provider_name",
"type": "test_type",
"properties": {
"idProvider": "https://sts.windows.net/ea9ec534-a3e3-4e45-ad36-3afc5bb291c1"
}
}
],
"defaultGroup": "test_default_group",
"newTier": "Consumption",
"currentTier": "Consumption",
"firewallAllowAzureIps": "Enabled"
}
}
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "contosoadla",
"type": "test_type",
"location": "eastus2",
"tags": {
"test_key": "test_value"
},
"identity": {
"type": "SystemAssigned",
"principalId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"tenantId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab346"
},
"properties": {
"provisioningState": "Succeeded",
"state": "Active",
"creationTime": "2017-04-14T13:21:56.6819037-07:00",
"lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
"endpoint": "testadlfs17607.azuredatalakestore.net",
"accountId": "94f4bf5d-78a9-4c31-8aa7-b34d07bad898",
"encryptionState": "Enabled",
"encryptionProvisioningState": "Succeeded",
"encryptionConfig": {
"type": "UserManaged",
"keyVaultMetaInfo": {
"keyVaultResourceId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"encryptionKeyName": "test_encryption_key_name",
"encryptionKeyVersion": "encryption_key_version"
}
},
"firewallState": "Enabled",
"firewallRules": [
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "test_rule",
"type": "test_type",
"properties": {
"startIpAddress": "1.1.1.1",
"endIpAddress": "2.2.2.2"
}
}
],
"trustedIdProviderState": "Enabled",
"trustedIdProviders": [
{
"id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"name": "test_trusted_id_provider_name",
"type": "test_type",
"properties": {
"idProvider": "https://sts.windows.net/ea9ec534-a3e3-4e45-ad36-3afc5bb291c1"
}
}
],
"defaultGroup": "test_default_group",
"newTier": "Consumption",
"currentTier": "Consumption",
"firewallAllowAzureIps": "Enabled"
}
}
Definitions
Name | Description |
---|---|
Create |
|
Create |
The parameters used to create a new firewall rule while creating a new Data Lake Store account. |
Create |
The parameters used to create a new trusted identity provider while creating a new Data Lake Store account. |
Create |
The parameters used to create a new virtual network rule while creating a new Data Lake Store account. |
Data |
Data Lake Store account information. |
Data |
The state of the Data Lake Store account. |
Data |
The provisioning status of the Data Lake Store account. |
Encryption |
The encryption configuration for the account. |
Encryption |
The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. |
Encryption |
The encryption identity properties. |
Encryption |
The type of encryption being used. Currently the only supported type is 'SystemAssigned'. |
Encryption |
The current state of encryption provisioning for this Data Lake Store account. |
Encryption |
The current state of encryption for this Data Lake Store account. |
Firewall |
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. |
Firewall |
Data Lake Store firewall rule information. |
Firewall |
The current state of the IP address firewall for this Data Lake Store account. |
Key |
Metadata information used by account encryption. |
Tier |
The commitment tier to use for next month. |
Trusted |
Data Lake Store trusted identity provider information. |
Trusted |
The current state of the trusted identity provider feature for this Data Lake Store account. |
Virtual |
Data Lake Store virtual network rule information. |
CreateDataLakeStoreAccountParameters
Name | Type | Description |
---|---|---|
identity |
The Key Vault encryption identity, if any. |
|
location |
string |
The resource location. |
properties.defaultGroup |
string |
The default owner group for all new folders and files created in the Data Lake Store account. |
properties.encryptionConfig |
The Key Vault encryption configuration. |
|
properties.encryptionState |
The current state of encryption for this Data Lake Store account. |
|
properties.firewallAllowAzureIps |
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. |
|
properties.firewallRules |
The list of firewall rules associated with this Data Lake Store account. |
|
properties.firewallState |
The current state of the IP address firewall for this Data Lake Store account. |
|
properties.newTier |
The commitment tier to use for next month. |
|
properties.trustedIdProviderState |
The current state of the trusted identity provider feature for this Data Lake Store account. |
|
properties.trustedIdProviders |
The list of trusted identity providers associated with this Data Lake Store account. |
|
properties.virtualNetworkRules |
The list of virtual network rules associated with this Data Lake Store account. |
|
tags |
object |
The resource tags. |
CreateFirewallRuleWithAccountParameters
The parameters used to create a new firewall rule while creating a new Data Lake Store account.
Name | Type | Description |
---|---|---|
name |
string |
The unique name of the firewall rule to create. |
properties.endIpAddress |
string |
The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. |
properties.startIpAddress |
string |
The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. |
CreateTrustedIdProviderWithAccountParameters
The parameters used to create a new trusted identity provider while creating a new Data Lake Store account.
Name | Type | Description |
---|---|---|
name |
string |
The unique name of the trusted identity provider to create. |
properties.idProvider |
string |
The URL of this trusted identity provider. |
CreateVirtualNetworkRuleWithAccountParameters
The parameters used to create a new virtual network rule while creating a new Data Lake Store account.
Name | Type | Description |
---|---|---|
name |
string |
The unique name of the virtual network rule to create. |
properties.subnetId |
string |
The resource identifier for the subnet. |
DataLakeStoreAccount
Data Lake Store account information.
Name | Type | Description |
---|---|---|
id |
string |
The resource identifier. |
identity |
The Key Vault encryption identity, if any. |
|
location |
string |
The resource location. |
name |
string |
The resource name. |
properties.accountId |
string |
The unique identifier associated with this Data Lake Store account. |
properties.creationTime |
string |
The account creation time. |
properties.currentTier |
The commitment tier in use for the current month. |
|
properties.defaultGroup |
string |
The default owner group for all new folders and files created in the Data Lake Store account. |
properties.encryptionConfig |
The Key Vault encryption configuration. |
|
properties.encryptionProvisioningState |
The current state of encryption provisioning for this Data Lake Store account. |
|
properties.encryptionState |
The current state of encryption for this Data Lake Store account. |
|
properties.endpoint |
string |
The full CName endpoint for this account. |
properties.firewallAllowAzureIps |
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. |
|
properties.firewallRules |
The list of firewall rules associated with this Data Lake Store account. |
|
properties.firewallState |
The current state of the IP address firewall for this Data Lake Store account. |
|
properties.lastModifiedTime |
string |
The account last modified time. |
properties.newTier |
The commitment tier to use for next month. |
|
properties.provisioningState |
The provisioning status of the Data Lake Store account. |
|
properties.state |
The state of the Data Lake Store account. |
|
properties.trustedIdProviderState |
The current state of the trusted identity provider feature for this Data Lake Store account. |
|
properties.trustedIdProviders |
The list of trusted identity providers associated with this Data Lake Store account. |
|
properties.virtualNetworkRules |
The list of virtual network rules associated with this Data Lake Store account. |
|
tags |
object |
The resource tags. |
type |
string |
The resource type. |
DataLakeStoreAccountState
The state of the Data Lake Store account.
Name | Type | Description |
---|---|---|
Active |
string |
|
Suspended |
string |
DataLakeStoreAccountStatus
The provisioning status of the Data Lake Store account.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleted |
string |
|
Deleting |
string |
|
Failed |
string |
|
Patching |
string |
|
Resuming |
string |
|
Running |
string |
|
Succeeded |
string |
|
Suspending |
string |
|
Undeleting |
string |
EncryptionConfig
The encryption configuration for the account.
Name | Type | Description |
---|---|---|
keyVaultMetaInfo |
The Key Vault information for connecting to user managed encryption keys. |
|
type |
The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. |
EncryptionConfigType
The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.
Name | Type | Description |
---|---|---|
ServiceManaged |
string |
|
UserManaged |
string |
EncryptionIdentity
The encryption identity properties.
Name | Type | Description |
---|---|---|
principalId |
string |
The principal identifier associated with the encryption. |
tenantId |
string |
The tenant identifier associated with the encryption. |
type |
The type of encryption being used. Currently the only supported type is 'SystemAssigned'. |
EncryptionIdentityType
The type of encryption being used. Currently the only supported type is 'SystemAssigned'.
Name | Type | Description |
---|---|---|
SystemAssigned |
string |
EncryptionProvisioningState
The current state of encryption provisioning for this Data Lake Store account.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Succeeded |
string |
EncryptionState
The current state of encryption for this Data Lake Store account.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
FirewallAllowAzureIpsState
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
FirewallRule
Data Lake Store firewall rule information.
Name | Type | Description |
---|---|---|
id |
string |
The resource identifier. |
name |
string |
The resource name. |
properties.endIpAddress |
string |
The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. |
properties.startIpAddress |
string |
The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. |
type |
string |
The resource type. |
FirewallState
The current state of the IP address firewall for this Data Lake Store account.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
KeyVaultMetaInfo
Metadata information used by account encryption.
Name | Type | Description |
---|---|---|
encryptionKeyName |
string |
The name of the user managed encryption key. |
encryptionKeyVersion |
string |
The version of the user managed encryption key. |
keyVaultResourceId |
string |
The resource identifier for the user managed Key Vault being used to encrypt. |
TierType
The commitment tier to use for next month.
Name | Type | Description |
---|---|---|
Commitment_100TB |
string |
|
Commitment_10TB |
string |
|
Commitment_1PB |
string |
|
Commitment_1TB |
string |
|
Commitment_500TB |
string |
|
Commitment_5PB |
string |
|
Consumption |
string |
TrustedIdProvider
Data Lake Store trusted identity provider information.
Name | Type | Description |
---|---|---|
id |
string |
The resource identifier. |
name |
string |
The resource name. |
properties.idProvider |
string |
The URL of this trusted identity provider. |
type |
string |
The resource type. |
TrustedIdProviderState
The current state of the trusted identity provider feature for this Data Lake Store account.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
VirtualNetworkRule
Data Lake Store virtual network rule information.
Name | Type | Description |
---|---|---|
id |
string |
The resource identifier. |
name |
string |
The resource name. |
properties.subnetId |
string |
The resource identifier for the subnet. |
type |
string |
The resource type. |