Accounts - Update

Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}?api-version=2016-11-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of the Data Lake Analytics account.

resourceGroupName
path True

string

The name of the Azure resource group.

subscriptionId
path True

string

Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client Api Version.

Request Body

Name Type Description
properties.computePolicies

UpdateComputePolicyWithAccountParameters[]

The list of compute policies associated with this account.

properties.dataLakeStoreAccounts

UpdateDataLakeStoreWithAccountParameters[]

The list of Data Lake Store accounts associated with this account.

properties.firewallAllowAzureIps

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

properties.firewallRules

UpdateFirewallRuleWithAccountParameters[]

The list of firewall rules associated with this account.

properties.firewallState

FirewallState

The current state of the IP address firewall for this account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled.

properties.maxDegreeOfParallelism

integer

The maximum supported degree of parallelism for this account.

properties.maxDegreeOfParallelismPerJob

integer

The maximum supported degree of parallelism per job for this account.

properties.maxJobCount

integer

The maximum supported jobs running under the account at the same time.

properties.minPriorityPerJob

integer

The minimum supported priority per job for this account.

properties.newTier

TierType

The commitment tier to use for next month.

properties.queryStoreRetention

integer

The number of days that job metadata is retained.

properties.storageAccounts

UpdateStorageAccountWithAccountParameters[]

The list of Azure Blob storage accounts associated with this account.

tags

object

The resource tags.

Responses

Name Type Description
200 OK

DataLakeAnalyticsAccount

Successfully updated the specified account.

201 Created

DataLakeAnalyticsAccount

Successfully initiated an update of the specified account.

202 Accepted

DataLakeAnalyticsAccount

Successfully initiated an update of the specified account.

Other Status Codes

ErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.

Sample Request

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla?api-version=2016-11-01

{
  "tags": {
    "test_key": "test_value"
  },
  "properties": {
    "computePolicies": [
      {
        "name": "test_policy",
        "properties": {
          "objectId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
          "objectType": "User",
          "maxDegreeOfParallelismPerJob": 1,
          "minPriorityPerJob": 1
        }
      }
    ],
    "firewallRules": [
      {
        "name": "test_rule",
        "properties": {
          "startIpAddress": "1.1.1.1",
          "endIpAddress": "2.2.2.2"
        }
      }
    ],
    "firewallState": "Enabled",
    "firewallAllowAzureIps": "Enabled",
    "newTier": "Consumption",
    "maxJobCount": 1,
    "maxDegreeOfParallelism": 1,
    "maxDegreeOfParallelismPerJob": 1,
    "minPriorityPerJob": 1,
    "queryStoreRetention": 1
  }
}

Sample Response

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818",
  "name": "test_account",
  "type": "Microsoft.DataLakeAnalytics/accounts",
  "properties": {
    "accountId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    "provisioningState": "Succeeded",
    "state": "Active",
    "creationTime": "2017-04-14T13:21:56.6819037-07:00",
    "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
    "endpoint": "test_endpoint",
    "defaultDataLakeStoreAccount": "test_adls",
    "dataLakeStoreAccounts": [
      {
        "id": "test_adls_id",
        "name": "test_adls",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "storageAccounts": [
      {
        "id": "test_storage_id",
        "name": "test_storage",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "computePolicies": [
      {
        "id": "test_policy_id",
        "name": "test_policy",
        "type": "test_type",
        "properties": {
          "objectId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
          "objectType": "User",
          "maxDegreeOfParallelismPerJob": 1,
          "minPriorityPerJob": 1
        }
      }
    ],
    "firewallRules": [
      {
        "id": "test_firewall_id",
        "name": "test_rule",
        "type": "test_type",
        "properties": {
          "startIpAddress": "1.1.1.1",
          "endIpAddress": "2.2.2.2"
        }
      }
    ],
    "firewallState": "Enabled",
    "firewallAllowAzureIps": "Enabled",
    "newTier": "Consumption",
    "currentTier": "Consumption",
    "maxJobCount": 3,
    "systemMaxJobCount": 1,
    "maxDegreeOfParallelism": 30,
    "systemMaxDegreeOfParallelism": 1,
    "maxDegreeOfParallelismPerJob": 1,
    "minPriorityPerJob": 1,
    "queryStoreRetention": 30
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818",
  "name": "test_account",
  "type": "Microsoft.DataLakeAnalytics/accounts",
  "properties": {
    "accountId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    "provisioningState": "Succeeded",
    "state": "Active",
    "creationTime": "2017-04-14T13:21:56.6819037-07:00",
    "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
    "endpoint": "test_endpoint",
    "defaultDataLakeStoreAccount": "test_adls",
    "dataLakeStoreAccounts": [
      {
        "id": "test_adls_id",
        "name": "test_adls",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "storageAccounts": [
      {
        "id": "test_storage_id",
        "name": "test_storage",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "computePolicies": [
      {
        "id": "test_policy_id",
        "name": "test_policy",
        "type": "test_type",
        "properties": {
          "objectId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
          "objectType": "User",
          "maxDegreeOfParallelismPerJob": 1,
          "minPriorityPerJob": 1
        }
      }
    ],
    "firewallRules": [
      {
        "id": "test_firewall_id",
        "name": "test_rule",
        "type": "test_type",
        "properties": {
          "startIpAddress": "1.1.1.1",
          "endIpAddress": "2.2.2.2"
        }
      }
    ],
    "firewallState": "Enabled",
    "firewallAllowAzureIps": "Enabled",
    "newTier": "Consumption",
    "currentTier": "Consumption",
    "maxJobCount": 3,
    "systemMaxJobCount": 1,
    "maxDegreeOfParallelism": 30,
    "systemMaxDegreeOfParallelism": 1,
    "maxDegreeOfParallelismPerJob": 1,
    "minPriorityPerJob": 1,
    "queryStoreRetention": 30
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818",
  "name": "test_account",
  "type": "Microsoft.DataLakeAnalytics/accounts",
  "properties": {
    "accountId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    "provisioningState": "Succeeded",
    "state": "Active",
    "creationTime": "2017-04-14T13:21:56.6819037-07:00",
    "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
    "endpoint": "test_endpoint",
    "defaultDataLakeStoreAccount": "test_adls",
    "dataLakeStoreAccounts": [
      {
        "id": "test_adls_id",
        "name": "test_adls",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "storageAccounts": [
      {
        "id": "test_storage_id",
        "name": "test_storage",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "computePolicies": [
      {
        "id": "test_policy_id",
        "name": "test_policy",
        "type": "test_type",
        "properties": {
          "objectId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
          "objectType": "User",
          "maxDegreeOfParallelismPerJob": 1,
          "minPriorityPerJob": 1
        }
      }
    ],
    "firewallRules": [
      {
        "id": "test_firewall_id",
        "name": "test_rule",
        "type": "test_type",
        "properties": {
          "startIpAddress": "1.1.1.1",
          "endIpAddress": "2.2.2.2"
        }
      }
    ],
    "firewallState": "Enabled",
    "firewallAllowAzureIps": "Enabled",
    "newTier": "Consumption",
    "currentTier": "Consumption",
    "maxJobCount": 3,
    "systemMaxJobCount": 1,
    "maxDegreeOfParallelism": 30,
    "systemMaxDegreeOfParallelism": 1,
    "maxDegreeOfParallelismPerJob": 1,
    "minPriorityPerJob": 1,
    "queryStoreRetention": 30
  }
}

Definitions

Name Description
AADObjectType

The type of AAD object the object identifier refers to.

ComputePolicy

Data Lake Analytics compute policy information.

DataLakeAnalyticsAccount

A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account.

DataLakeAnalyticsAccountState

The state of the Data Lake Analytics account.

DataLakeAnalyticsAccountStatus

The provisioning status of the Data Lake Analytics account.

DataLakeStoreAccountInformation

Data Lake Store account information.

DebugDataAccessLevel

The current state of the DebugDataAccessLevel for this account.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

FirewallRule

Data Lake Analytics firewall rule information.

FirewallState

The current state of the IP address firewall for this account.

HiveMetastore
NestedResourceProvisioningState

The current state of the NestedResourceProvisioning for this account.

StorageAccountInformation

Azure Storage account information.

TierType

The commitment tier for the next month.

UpdateComputePolicyWithAccountParameters

The parameters used to update a compute policy while updating a Data Lake Analytics account.

UpdateDataLakeAnalyticsAccountParameters

The parameters that can be used to update an existing Data Lake Analytics account.

UpdateDataLakeStoreWithAccountParameters

The parameters used to update a Data Lake Store account while updating a Data Lake Analytics account.

UpdateFirewallRuleWithAccountParameters

The parameters used to update a firewall rule while updating a Data Lake Analytics account.

UpdateStorageAccountWithAccountParameters

The parameters used to update an Azure Storage account while updating a Data Lake Analytics account.

VirtualNetworkRule

Data Lake Analytics VirtualNetwork Rule information.

VirtualNetworkRuleState

The current state of the VirtualNetworkRule for this account.

AADObjectType

The type of AAD object the object identifier refers to.

Name Type Description
Group

string

ServicePrincipal

string

User

string

ComputePolicy

Data Lake Analytics compute policy information.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.maxDegreeOfParallelismPerJob

integer

The maximum degree of parallelism per job this user can use to submit jobs.

properties.minPriorityPerJob

integer

The minimum priority per job this user can use to submit jobs.

properties.objectId

string

The AAD object identifier for the entity to create a policy for.

properties.objectType

AADObjectType

The type of AAD object the object identifier refers to.

type

string

The resource type.

DataLakeAnalyticsAccount

A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account.

Name Type Default Value Description
id

string

The resource identifier.

location

string

The resource location.

name

string

The resource name.

properties.accountId

string

The unique identifier associated with this Data Lake Analytics account.

properties.computePolicies

ComputePolicy[]

The list of compute policies associated with this account.

properties.creationTime

string

The account creation time.

properties.currentTier

TierType

The commitment tier in use for the current month.

properties.dataLakeStoreAccounts

DataLakeStoreAccountInformation[]

The list of Data Lake Store accounts associated with this account.

properties.debugDataAccessLevel

DebugDataAccessLevel

The current state of the DebugDataAccessLevel for this account.

properties.defaultDataLakeStoreAccount

string

The default Data Lake Store account associated with this account.

properties.endpoint

string

The full CName endpoint for this account.

properties.firewallAllowAzureIps

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

properties.firewallRules

FirewallRule[]

The list of firewall rules associated with this account.

properties.firewallState

FirewallState

The current state of the IP address firewall for this account.

properties.hiveMetastores

HiveMetastore[]

The list of hiveMetastores associated with this account.

properties.lastModifiedTime

string

The account last modified time.

properties.maxActiveJobCountPerUser

integer

The maximum supported active jobs under the account at the same time.

properties.maxDegreeOfParallelism

integer

30

The maximum supported degree of parallelism for this account.

properties.maxDegreeOfParallelismPerJob

integer

The maximum supported degree of parallelism per job for this account.

properties.maxJobCount

integer

3

The maximum supported jobs running under the account at the same time.

properties.maxJobRunningTimeInMin

integer

The maximum supported active jobs under the account at the same time.

properties.maxQueuedJobCountPerUser

integer

The maximum supported jobs queued under the account at the same time.

properties.minPriorityPerJob

integer

The minimum supported priority per job for this account.

properties.newTier

TierType

The commitment tier for the next month.

properties.provisioningState

DataLakeAnalyticsAccountStatus

The provisioning status of the Data Lake Analytics account.

properties.publicDataLakeStoreAccounts

DataLakeStoreAccountInformation[]

The list of Data Lake Store accounts associated with this account.

properties.queryStoreRetention

integer

30

The number of days that job metadata is retained.

properties.state

DataLakeAnalyticsAccountState

The state of the Data Lake Analytics account.

properties.storageAccounts

StorageAccountInformation[]

The list of Azure Blob Storage accounts associated with this account.

properties.systemMaxDegreeOfParallelism

integer

The system defined maximum supported degree of parallelism for this account, which restricts the maximum value of parallelism the user can set for the account.

properties.systemMaxJobCount

integer

The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account.

properties.virtualNetworkRules

VirtualNetworkRule[]

The list of virtualNetwork rules associated with this account.

tags

object

The resource tags.

type

string

The resource type.

DataLakeAnalyticsAccountState

The state of the Data Lake Analytics account.

Name Type Description
Active

string

Suspended

string

DataLakeAnalyticsAccountStatus

The provisioning status of the Data Lake Analytics account.

Name Type Description
Canceled

string

Creating

string

Deleted

string

Deleting

string

Failed

string

Patching

string

Resuming

string

Running

string

Succeeded

string

Suspending

string

Undeleting

string

DataLakeStoreAccountInformation

Data Lake Store account information.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.suffix

string

The optional suffix for the Data Lake Store account.

type

string

The resource type.

DebugDataAccessLevel

The current state of the DebugDataAccessLevel for this account.

Name Type Description
All

string

Customer

string

None

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

Name Type Description
Disabled

string

Enabled

string

FirewallRule

Data Lake Analytics firewall rule information.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.endIpAddress

string

The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

properties.startIpAddress

string

The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

type

string

The resource type.

FirewallState

The current state of the IP address firewall for this account.

Name Type Description
Disabled

string

Enabled

string

HiveMetastore

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.databaseName

string

The databaseName for the Hive MetaStore

properties.nestedResourceProvisioningState

NestedResourceProvisioningState

The current state of the NestedResource

properties.password

string

The password for the Hive MetaStore

properties.runtimeVersion

string

The runtimeVersion for the Hive MetaStore

properties.serverUri

string

The serverUri for the Hive MetaStore

properties.userName

string

The userName for the Hive MetaStore

type

string

The resource type.

NestedResourceProvisioningState

The current state of the NestedResourceProvisioning for this account.

Name Type Description
Canceled

string

Failed

string

Succeeded

string

StorageAccountInformation

Azure Storage account information.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.suffix

string

The optional suffix for the storage account.

type

string

The resource type.

TierType

The commitment tier for the next month.

Name Type Description
Commitment_100000AUHours

string

Commitment_10000AUHours

string

Commitment_1000AUHours

string

Commitment_100AUHours

string

Commitment_500000AUHours

string

Commitment_50000AUHours

string

Commitment_5000AUHours

string

Commitment_500AUHours

string

Consumption

string

UpdateComputePolicyWithAccountParameters

The parameters used to update a compute policy while updating a Data Lake Analytics account.

Name Type Description
name

string

The unique name of the compute policy to update.

properties.maxDegreeOfParallelismPerJob

integer

The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed.

properties.minPriorityPerJob

integer

The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed.

properties.objectId

string

The AAD object identifier for the entity to create a policy for.

properties.objectType

AADObjectType

The type of AAD object the object identifier refers to.

UpdateDataLakeAnalyticsAccountParameters

The parameters that can be used to update an existing Data Lake Analytics account.

Name Type Description
properties.computePolicies

UpdateComputePolicyWithAccountParameters[]

The list of compute policies associated with this account.

properties.dataLakeStoreAccounts

UpdateDataLakeStoreWithAccountParameters[]

The list of Data Lake Store accounts associated with this account.

properties.firewallAllowAzureIps

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

properties.firewallRules

UpdateFirewallRuleWithAccountParameters[]

The list of firewall rules associated with this account.

properties.firewallState

FirewallState

The current state of the IP address firewall for this account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled.

properties.maxDegreeOfParallelism

integer

The maximum supported degree of parallelism for this account.

properties.maxDegreeOfParallelismPerJob

integer

The maximum supported degree of parallelism per job for this account.

properties.maxJobCount

integer

The maximum supported jobs running under the account at the same time.

properties.minPriorityPerJob

integer

The minimum supported priority per job for this account.

properties.newTier

TierType

The commitment tier to use for next month.

properties.queryStoreRetention

integer

The number of days that job metadata is retained.

properties.storageAccounts

UpdateStorageAccountWithAccountParameters[]

The list of Azure Blob storage accounts associated with this account.

tags

object

The resource tags.

UpdateDataLakeStoreWithAccountParameters

The parameters used to update a Data Lake Store account while updating a Data Lake Analytics account.

Name Type Description
name

string

The unique name of the Data Lake Store account to update.

properties.suffix

string

The optional suffix for the Data Lake Store account.

UpdateFirewallRuleWithAccountParameters

The parameters used to update a firewall rule while updating a Data Lake Analytics account.

Name Type Description
name

string

The unique name of the firewall rule to update.

properties.endIpAddress

string

The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

properties.startIpAddress

string

The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

UpdateStorageAccountWithAccountParameters

The parameters used to update an Azure Storage account while updating a Data Lake Analytics account.

Name Type Description
name

string

The unique name of the Azure Storage account to update.

properties.accessKey

string

The updated access key associated with this Azure Storage account that will be used to connect to it.

properties.suffix

string

The optional suffix for the storage account.

VirtualNetworkRule

Data Lake Analytics VirtualNetwork Rule information.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties.subnetId

string

The resource identifier for the subnet

properties.virtualNetworkRuleState

VirtualNetworkRuleState

The current state of the VirtualNetwork Rule

type

string

The resource type.

VirtualNetworkRuleState

The current state of the VirtualNetworkRule for this account.

Name Type Description
Active

string

Failed

string

NetworkSourceDeleted

string