Microsoft.DataLakeStore (stable:2016-11-01)

2025/09/19 • 26 new, 29 deleted methods

Accounts_List (new)
Description :  Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/accounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter. Optional. ,
Required: False ,
}
string ,
$top:
{
Description: The number of items to return. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip over before returning elements. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. ,
Required: False ,
}
string ,
$orderby:
{
Description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. ,
Required: False ,
}
string ,
$count:
{
Description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The basic Data Lake Store account properties. ,
Required: False ,
}
{
accountId:
{
Description: The unique identifier associated with this Data Lake Store account. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the Data Lake Store account. ,
Enum:
{
Failed: No description available. ,
Creating: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Patching: No description available. ,
Suspending: No description available. ,
Resuming: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Undeleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the Data Lake Store account. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: The account creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The full CName endpoint for this account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Accounts_ListByResourceGroup (new)
Description :  Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter. Optional. ,
Required: False ,
}
string ,
$top:
{
Description: The number of items to return. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip over before returning elements. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. ,
Required: False ,
}
string ,
$orderby:
{
Description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. ,
Required: False ,
}
string ,
$count:
{
Description: A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The basic Data Lake Store account properties. ,
Required: False ,
}
{
accountId:
{
Description: The unique identifier associated with this Data Lake Store account. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the Data Lake Store account. ,
Enum:
{
Failed: No description available. ,
Creating: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Patching: No description available. ,
Suspending: No description available. ,
Resuming: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Undeleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the Data Lake Store account. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: The account creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The full CName endpoint for this account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Accounts_Create (new)
Description :  Creates the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: The resource location. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties to use for creating. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the firewall rule to create. ,
Required: True ,
}
string ,
properties:
{
Description: The firewall rule properties to use when creating a new firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the virtual network rule to create. ,
Required: True ,
}
string ,
properties:
{
Description: The virtual network rule properties to use when creating a new virtual network rule. ,
Required: True ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: True ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the trusted identity provider to create. ,
Required: True ,
}
string ,
properties:
{
Description: The trusted identity provider properties to use when creating a new trusted identity provider. ,
Required: True ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: True ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Get (new)
Description :  Gets the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Update (new)
Description :  Updates the specified Data Lake Store account information.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the Data Lake Store account. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The Data Lake Store account properties to update. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: Used for rotation of user managed Key Vault keys. Can only be used to rotate a user managed encryption Key Vault key. ,
Required: False ,
}
{
keyVaultMetaInfo:
{
Description: The updated Key Vault key to use in user managed key rotation. ,
Required: False ,
}
{
encryptionKeyVersion:
{
Description: The version of the user managed encryption key to update through a key rotation. ,
Required: False ,
}
string ,
}
,
}
,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the firewall rule to update. ,
Required: True ,
}
string ,
properties:
{
Description: The firewall rule properties to use when updating a firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the virtual network rule to update. ,
Required: True ,
}
string ,
properties:
{
Description: The virtual network rule properties to use when updating a virtual network rule. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the trusted identity provider to update. ,
Required: True ,
}
string ,
properties:
{
Description: The trusted identity provider properties to use when updating a trusted identity provider. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Delete (new)
Description :  Deletes the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Accounts_EnableKeyVault (new)
Description :  Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/enableKeyVault
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
FirewallRules_ListByAccount (new)
Description :  Lists the Data Lake Store firewall rules within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update the firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The firewall rule properties to use when creating a new firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Get (new)
Description :  Gets the specified Data Lake Store firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Update (new)
Description :  Updates the specified firewall rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the firewall rule. ,
Required: False ,
}
{
properties:
{
Description: The firewall rule properties to use when updating a firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes the specified firewall rule from the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
VirtualNetworkRules_ListByAccount (new)
Description :  Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
VirtualNetworkRules_CreateOrUpdate (new)
Description :  Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update the virtual network rule. ,
Required: True ,
}
{
properties:
{
Description: The virtual network rule properties to use when creating a new virtual network rule. ,
Required: True ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Get (new)
Description :  Gets the specified Data Lake Store virtual network rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Update (new)
Description :  Updates the specified virtual network rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the virtual network rule. ,
Required: False ,
}
{
properties:
{
Description: The virtual network rule properties to use when updating a virtual network rule. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Delete (new)
Description :  Deletes the specified virtual network rule from the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
TrustedIdProviders_ListByAccount (new)
Description :  Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
TrustedIdProviders_CreateOrUpdate (new)
Description :  Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider. This is used for differentiation of providers in the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or replace the trusted identity provider. ,
Required: True ,
}
{
properties:
{
Description: The trusted identity provider properties to use when creating a new trusted identity provider. ,
Required: True ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Get (new)
Description :  Gets the specified Data Lake Store trusted identity provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Update (new)
Description :  Updates the specified trusted identity provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider. This is used for differentiation of providers in the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the trusted identity provider. ,
Required: False ,
}
{
properties:
{
Description: The trusted identity provider properties to use when updating a trusted identity provider. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Delete (new)
Description :  Deletes the specified trusted identity provider from the specified Data Lake Store account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Operations_List (new)
Description :  Lists all of the available Data Lake Store REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataLakeStore/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display information for the operation. ,
Required: False ,
}
{
provider:
{
Description: The resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The resource type of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: A friendly name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: A friendly description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Locations_GetCapability (new)
Description :  Gets subscription-level properties and limits for Data Lake Store specified by resource location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/capability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The subscription credentials that uniquely identifies the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
state:
{
Description: The subscription state. ,
Enum:
{
Registered: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
maxAccountCount:
{
Description: The maximum supported number of accounts under this subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
accountCount:
{
Description: The current number of accounts under this subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationState:
{
Description: The Boolean value of true or false to indicate the maintenance state. ,
Required: False ,
}
boolean ,
}

⚐ Response (404)

{}
Locations_GetUsage (new)
Description :  Gets the current usage count and the limit for the resources of the location under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/usages
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of Storage Resource Usages. ,
Required: False ,
}
[
{
unit:
{
Description: Gets the unit of measurement. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountsPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
currentValue:
{
Description: Gets the current count of the allocated resources in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Gets the maximum count of the resources that can be allocated in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the name of the type of usage. ,
Required: False ,
}
{
value:
{
Description: Gets a string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Gets a localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Accounts_CheckNameAvailability (new)
Description :  Checks whether the specified account name is available or taken.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to check the Data Lake Store account name availability. ,
Required: True ,
}
{
name:
{
Description: The Data Lake Store name to check availability for. ,
Required: True ,
}
string ,
type:
{
Description: The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts ,
Enum:
{
Microsoft.DataLakeStore/accounts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The Boolean value of true or false to indicate whether the Data Lake Store account name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the Data Lake Store account name is not available, if nameAvailable is false. ,
Required: False ,
}
string ,
message:
{
Description: The message describing why the Data Lake Store account name is not available, if nameAvailable is false. ,
Required: False ,
}
string ,
}
FileSystem_SetFileExpiry (removed)
Description :  Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.
Reference :  Link ¶

⚼ Request

PUT:  /WebHdfsExt/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the file on which to set or remove the expiration time. ,
Required: True ,
}
string ,
expiryOption:
{
Description: Indicates the type of expiration to use for the file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is an integer in milliseconds representing the expiration date relative to when file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an integer in milliseconds representing the expiration date relative to file creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00. ,
Required: True ,
}
string ,
expireTime:
{
Description: The time that the file will expire, corresponding to the ExpiryOption that was set. ,
Format: int64 ,
Required: False ,
}
integer ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
remoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
FileSystem_ConcurrentAppend (removed)
Description :  Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.
Reference :  Link ¶

⚼ Request

POST:  /WebHdfsExt/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the file to which to append using concurrent append. ,
Required: True ,
}
string ,
streamContents:
{
Description: The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks. ,
Required: True ,
}
object ,
appendMode:
{
Description: Indicates the concurrent append call should create the file if it doesn't exist or just open the existing file for append ,
Required: False ,
}
string ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
Transfer-Encoding:
{
Description: Indicates the data being sent to the server is being streamed in chunks. ,
Required: True ,
}
string ,
syncFlag:
{
Description: Optionally indicates what to do after completion of the concurrent append. DATA indicates that more data will be sent immediately by the client, the file handle should remain open/locked, and file metadata (including file length, last modified time) should NOT get updated. METADATA indicates that more data will be sent immediately by the client, the file handle should remain open/locked, and file metadata should get updated. CLOSE indicates that the client is done sending data, the file handle should be closed/unlocked, and file metadata should get updated. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
remoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
FileSystem_CheckAccess (removed)
Description :  Checks if the specified access is available at the given path.
Reference :  Link ¶

⚼ Request

GET:  /webhdfs/v1/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the file or directory for which to check access. ,
Required: True ,
}
string ,
fsaction:
{
Description: File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}' ,
Required: True ,
}
string ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
remoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
Accounts_List (removed)
Description :  Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/accounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter. Optional. ,
Required: False ,
}
string ,
$top:
{
Description: The number of items to return. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip over before returning elements. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. ,
Required: False ,
}
string ,
$orderby:
{
Description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. ,
Required: False ,
}
string ,
$count:
{
Description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The basic Data Lake Store account properties. ,
Required: False ,
}
{
accountId:
{
Description: The unique identifier associated with this Data Lake Store account. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the Data Lake Store account. ,
Enum:
{
Failed: No description available. ,
Creating: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Patching: No description available. ,
Suspending: No description available. ,
Resuming: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Undeleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the Data Lake Store account. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: The account creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The full CName endpoint for this account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Accounts_ListByResourceGroup (removed)
Description :  Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter. Optional. ,
Required: False ,
}
string ,
$top:
{
Description: The number of items to return. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip over before returning elements. Optional. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. ,
Required: False ,
}
string ,
$orderby:
{
Description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. ,
Required: False ,
}
string ,
$count:
{
Description: A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The basic Data Lake Store account properties. ,
Required: False ,
}
{
accountId:
{
Description: The unique identifier associated with this Data Lake Store account. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the Data Lake Store account. ,
Enum:
{
Failed: No description available. ,
Creating: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Patching: No description available. ,
Suspending: No description available. ,
Resuming: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Undeleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the Data Lake Store account. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: The account creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The full CName endpoint for this account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Accounts_Create (removed)
Description :  Creates the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: The resource location. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties to use for creating. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the firewall rule to create. ,
Required: True ,
}
string ,
properties:
{
Description: The firewall rule properties to use when creating a new firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the virtual network rule to create. ,
Required: True ,
}
string ,
properties:
{
Description: The virtual network rule properties to use when creating a new virtual network rule. ,
Required: True ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: True ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the trusted identity provider to create. ,
Required: True ,
}
string ,
properties:
{
Description: The trusted identity provider properties to use when creating a new trusted identity provider. ,
Required: True ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: True ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Get (removed)
Description :  Gets the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Update (removed)
Description :  Updates the specified Data Lake Store account information.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the Data Lake Store account. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The Data Lake Store account properties to update. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: Used for rotation of user managed Key Vault keys. Can only be used to rotate a user managed encryption Key Vault key. ,
Required: False ,
}
{
keyVaultMetaInfo:
{
Description: The updated Key Vault key to use in user managed key rotation. ,
Required: False ,
}
{
encryptionKeyVersion:
{
Description: The version of the user managed encryption key to update through a key rotation. ,
Required: False ,
}
string ,
}
,
}
,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the firewall rule to update. ,
Required: True ,
}
string ,
properties:
{
Description: The firewall rule properties to use when updating a firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the virtual network rule to update. ,
Required: True ,
}
string ,
properties:
{
Description: The virtual network rule properties to use when updating a virtual network rule. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
name:
{
Description: The unique name of the trusted identity provider to update. ,
Required: True ,
}
string ,
properties:
{
Description: The trusted identity provider properties to use when updating a trusted identity provider. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The Key Vault encryption identity, if any. ,
Required: False ,
}
{
type:
{
Description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier associated with the encryption. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The Data Lake Store account properties. ,
Required: False ,
}
{
defaultGroup:
{
Description: The default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
encryptionConfig:
{
Description: The Key Vault encryption configuration. ,
Required: False ,
}
{
type:
{
Description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. ,
Enum:
{
UserManaged: No description available. ,
ServiceManaged: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultMetaInfo:
{
Description: The Key Vault information for connecting to user managed encryption keys. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: The resource identifier for the user managed Key Vault being used to encrypt. ,
Required: True ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: True ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: True ,
}
string ,
}
,
}
,
encryptionState:
{
Description: The current state of encryption for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProvisioningState:
{
Description: The current state of encryption provisioning for this Data Lake Store account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
firewallRules:
{
Description: The list of firewall rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
firewallState:
{
Description: The current state of the IP address firewall for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
firewallAllowAzureIps:
{
Description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trustedIdProviders:
{
Description: The list of trusted identity providers associated with this Data Lake Store account. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
trustedIdProviderState:
{
Description: The current state of the trusted identity provider feature for this Data Lake Store account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
newTier:
{
Description: The commitment tier to use for next month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
currentTier:
{
Description: The commitment tier in use for the current month. ,
Enum:
{
Consumption: No description available. ,
Commitment_1TB: No description available. ,
Commitment_10TB: No description available. ,
Commitment_100TB: No description available. ,
Commitment_500TB: No description available. ,
Commitment_1PB: No description available. ,
Commitment_5PB: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Accounts_Delete (removed)
Description :  Deletes the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Accounts_EnableKeyVault (removed)
Description :  Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/enableKeyVault
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
FirewallRules_ListByAccount (removed)
Description :  Lists the Data Lake Store firewall rules within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
FirewallRules_CreateOrUpdate (removed)
Description :  Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update the firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The firewall rule properties to use when creating a new firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Get (removed)
Description :  Gets the specified Data Lake Store firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Update (removed)
Description :  Updates the specified firewall rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the firewall rule. ,
Required: False ,
}
{
properties:
{
Description: The firewall rule properties to use when updating a firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The firewall rule properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Delete (removed)
Description :  Deletes the specified firewall rule from the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
VirtualNetworkRules_ListByAccount (removed)
Description :  Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
VirtualNetworkRules_CreateOrUpdate (removed)
Description :  Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update the virtual network rule. ,
Required: True ,
}
{
properties:
{
Description: The virtual network rule properties to use when creating a new virtual network rule. ,
Required: True ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Get (removed)
Description :  Gets the specified Data Lake Store virtual network rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Update (removed)
Description :  Updates the specified virtual network rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the virtual network rule. ,
Required: False ,
}
{
properties:
{
Description: The virtual network rule properties to use when updating a virtual network rule. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The virtual network rule properties. ,
Required: False ,
}
{
subnetId:
{
Description: The resource identifier for the subnet. ,
Required: False ,
}
string ,
}
,
}
VirtualNetworkRules_Delete (removed)
Description :  Deletes the specified virtual network rule from the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
TrustedIdProviders_ListByAccount (removed)
Description :  Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
TrustedIdProviders_CreateOrUpdate (removed)
Description :  Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider. This is used for differentiation of providers in the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or replace the trusted identity provider. ,
Required: True ,
}
{
properties:
{
Description: The trusted identity provider properties to use when creating a new trusted identity provider. ,
Required: True ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Get (removed)
Description :  Gets the specified Data Lake Store trusted identity provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Update (removed)
Description :  Updates the specified trusted identity provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider. This is used for differentiation of providers in the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the trusted identity provider. ,
Required: False ,
}
{
properties:
{
Description: The trusted identity provider properties to use when updating a trusted identity provider. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The trusted identity provider properties. ,
Required: False ,
}
{
idProvider:
{
Description: The URL of this trusted identity provider. ,
Required: False ,
}
string ,
}
,
}
TrustedIdProviders_Delete (removed)
Description :  Deletes the specified trusted identity provider from the specified Data Lake Store account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account. ,
Required: True ,
}
string ,
trustedIdProviderName:
{
Description: The name of the trusted identity provider to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Operations_List (removed)
Description :  Lists all of the available Data Lake Store REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataLakeStore/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The results of the list operation. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display information for the operation. ,
Required: False ,
}
{
provider:
{
Description: The resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The resource type of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: A friendly name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: A friendly description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Locations_GetCapability (removed)
Description :  Gets subscription-level properties and limits for Data Lake Store specified by resource location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/capability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The subscription credentials that uniquely identifies the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
state:
{
Description: The subscription state. ,
Enum:
{
Registered: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
maxAccountCount:
{
Description: The maximum supported number of accounts under this subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
accountCount:
{
Description: The current number of accounts under this subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationState:
{
Description: The Boolean value of true or false to indicate the maintenance state. ,
Required: False ,
}
boolean ,
}

⚐ Response (404)

{}
Locations_GetUsage (removed)
Description :  Gets the current usage count and the limit for the resources of the location under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/usages
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of Storage Resource Usages. ,
Required: False ,
}
[
{
unit:
{
Description: Gets the unit of measurement. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountsPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
currentValue:
{
Description: Gets the current count of the allocated resources in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Gets the maximum count of the resources that can be allocated in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the name of the type of usage. ,
Required: False ,
}
{
value:
{
Description: Gets a string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Gets a localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Accounts_CheckNameAvailability (removed)
Description :  Checks whether the specified account name is available or taken.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The resource location without whitespace. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to check the Data Lake Store account name availability. ,
Required: True ,
}
{
name:
{
Description: The Data Lake Store name to check availability for. ,
Required: True ,
}
string ,
type:
{
Description: The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts ,
Enum:
{
Microsoft.DataLakeStore/accounts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The Boolean value of true or false to indicate whether the Data Lake Store account name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the Data Lake Store account name is not available, if nameAvailable is false. ,
Required: False ,
}
string ,
message:
{
Description: The message describing why the Data Lake Store account name is not available, if nameAvailable is false. ,
Required: False ,
}
string ,
}