Microsoft.DataLakeStore (preview:2015-10-01)

2025/09/19 • 11 new, 15 deleted methods

Account_DeleteFirewallRule (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}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to delete the firewall rule. ,
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 ,
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 ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Account_GetFirewallRule (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}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to get the firewall rule. ,
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 ,
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 ,
}

⚐ Response (200)

{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
Account_ListFirewallRules (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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to get the firewall rules. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Account_CreateOrUpdateFirewallRule (new)
Description :  Creates or updates the specified firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to which to add the firewall rule. ,
Required: True ,
}
string ,
name:
{
Description: The name of the firewall rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the create firewall rule. ,
Required: True ,
}
{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (200)

{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
Account_Create (new)
Description :  Creates the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Data Lake Store account to create. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (201)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_Update (new)
Description :  Updates the specified Data Lake Store account information.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Data Lake Store account to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_Delete (new)
Description :  Deletes the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to delete. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}
Account_Get (new)
Description :  Gets the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to retrieve. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to attempt to enable the Key Vault for. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{}
Account_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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account(s). ,
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 ,
$expand:
{
Description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional. ,
Required: False ,
}
string ,
$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 ,
$search:
{
Description: A free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional. ,
Required: False ,
}
string ,
$format:
{
Description: The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Account_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
{
$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 ,
$expand:
{
Description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional. ,
Required: False ,
}
string ,
$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 ,
$search:
{
Description: A free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional. ,
Required: False ,
}
string ,
$format:
{
Description: The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}
FileSystem_ConcurrentAppend (removed)
Description :  Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: ConcurrentAppend and normal (serial) Append CANNOT be used interchangeably; once a file has been appended to using either of these append options, it can only be appended to using that append option. ConcurrentAppend DOES NOT guarantee order and can result in duplicated data landing in the target file. In order to close a file after using ConcurrentAppend, call the Flush method.
Reference :  Link ¶

⚼ Request

POST:  /WebHdfsExt/{filePath}
{
filePath:
{
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 ,
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_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/{filePath}
{
filePath:
{
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_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: False ,
}
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 ,
}
,
}
FileSystem_Mkdirs (removed)
Description :  Creates a directory.
Reference :  Link ¶

⚼ Request

PUT:  /webhdfs/v1/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the directory to create. ,
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)

{
boolean:
{
Description: the result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ 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 ,
}
,
}
Account_DeleteFirewallRule (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}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to delete the firewall rule. ,
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 ,
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 ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Account_GetFirewallRule (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}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to get the firewall rule. ,
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 ,
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 ,
}

⚐ Response (200)

{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
Account_ListFirewallRules (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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account from which to get the firewall rules. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Account_CreateOrUpdateFirewallRule (removed)
Description :  Creates or updates the specified firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to which to add the firewall rule. ,
Required: True ,
}
string ,
name:
{
Description: The name of the firewall rule to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the create firewall rule. ,
Required: True ,
}
{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (200)

{
name:
{
Description: the firewall rule's name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the firewall Rule. ,
Required: False ,
}
string ,
id:
{
Description: the firewall rule's subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the firewall rule's regional location. ,
Required: False ,
}
string ,
properties:
{
Description: the properties of the firewall rule. ,
Required: False ,
}
{
startIpAddress:
{
Description: the start IP address for the firewall rule. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: the end IP address for the firewall rule. ,
Required: False ,
}
string ,
}
,
}
Account_Create (removed)
Description :  Creates the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Data Lake Store account to create. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (201)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_Update (removed)
Description :  Updates the specified Data Lake Store account information.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Data Lake Store account to update. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the Data Lake Store account. ,
Required: True ,
}
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_Delete (removed)
Description :  Deletes the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to delete. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}
Account_Get (removed)
Description :  Gets the specified Data Lake Store account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to retrieve. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
Account_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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Data Lake Store account to attempt to enable the Key Vault for. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{}
Account_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
{
resourceGroupName:
{
Description: The name of the Azure resource group that contains the Data Lake Store account(s). ,
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 ,
$expand:
{
Description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional. ,
Required: False ,
}
string ,
$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 ,
$search:
{
Description: A free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional. ,
Required: False ,
}
string ,
$format:
{
Description: The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Account_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
{
$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 ,
$expand:
{
Description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional. ,
Required: False ,
}
string ,
$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 ,
$search:
{
Description: A free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional. ,
Required: False ,
}
string ,
$format:
{
Description: The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: the results of the list operation ,
Required: False ,
}
[
{
location:
{
Description: the account regional location. ,
Required: False ,
}
string ,
name:
{
Description: the account name. ,
Required: False ,
}
string ,
type:
{
Description: the namespace and type of the account. ,
Required: False ,
}
string ,
id:
{
Description: the account subscription ID. ,
Required: False ,
}
string ,
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: False ,
}
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 ,
}
,
tags:
{
Description: the value of custom properties. ,
Required: False ,
}
object ,
properties:
{
Description: the Data Lake Store account properties. ,
Required: False ,
}
{
provisioningState:
{
Description: the status of the Data Lake Store account while being provisioned. ,
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. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: the status of the Data Lake Store account after provisioning has completed. ,
Enum:
{
active: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: the account creation time. ,
Format: date-time ,
Required: False ,
}
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 ,
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: False ,
}
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: False ,
}
string ,
encryptionKeyName:
{
Description: The name of the user managed encryption key. ,
Required: False ,
}
string ,
encryptionKeyVersion:
{
Description: The version of the user managed encryption key. ,
Required: False ,
}
string ,
}
,
}
,
lastModifiedTime:
{
Description: the account last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: the gateway host. ,
Required: False ,
}
string ,
defaultGroup:
{
Description: the default owner group for all new folders and files created in the Data Lake Store account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
count:
{
Description: the total count of results that are available, but might not be returned in the current page. ,
Format: int64 ,
Required: False ,
}
integer ,
}