Share via

DataLakeAnalyticsAccount interface

Package:
@azure/arm-datalake-analytics

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

Extends
Resource

Properties

accountId

The unique identifier associated with this Data Lake Analytics account. NOTE: This property will not be serialized. It can only be populated by the server.
computePolicies

The list of compute policies associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
creationTime

The account creation time. NOTE: This property will not be serialized. It can only be populated by the server.
currentTier

The commitment tier in use for the current month. Possible values include: 'Consumption', 'Commitment_100AUHours', 'Commitment_500AUHours', 'Commitment_1000AUHours', 'Commitment_5000AUHours', 'Commitment_10000AUHours', 'Commitment_50000AUHours', 'Commitment_100000AUHours', 'Commitment_500000AUHours' NOTE: This property will not be serialized. It can only be populated by the server.
dataLakeStoreAccounts

The list of Data Lake Store accounts associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
debugDataAccessLevel

The current state of the DebugDataAccessLevel for this account. Possible values include: 'All', 'Customer', 'None' NOTE: This property will not be serialized. It can only be populated by the server.
defaultDataLakeStoreAccount

The default Data Lake Store account associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
endpoint

The full CName endpoint for this account. NOTE: This property will not be serialized. It can only be populated by the server.
firewallAllowAzureIps

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.
firewallRules

The list of firewall rules associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
firewallState

The current state of the IP address firewall for this account. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.
hiveMetastores

The list of hiveMetastores associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
lastModifiedTime

The account last modified time. NOTE: This property will not be serialized. It can only be populated by the server.
maxDegreeOfParallelism

The maximum supported degree of parallelism for this account. Default value: 30.
maxDegreeOfParallelismPerJob

The maximum supported degree of parallelism per job for this account. NOTE: This property will not be serialized. It can only be populated by the server.
maxJobCount

The maximum supported jobs running under the account at the same time. Default value: 3.
minPriorityPerJob

The minimum supported priority per job for this account. NOTE: This property will not be serialized. It can only be populated by the server.
newTier

The commitment tier for the next month. Possible values include: 'Consumption', 'Commitment_100AUHours', 'Commitment_500AUHours', 'Commitment_1000AUHours', 'Commitment_5000AUHours', 'Commitment_10000AUHours', 'Commitment_50000AUHours', 'Commitment_100000AUHours', 'Commitment_500000AUHours' NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning status of the Data Lake Analytics account. Possible values include: 'Failed', 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', 'Deleted', 'Undeleting', 'Canceled' NOTE: This property will not be serialized. It can only be populated by the server.
queryStoreRetention

The number of days that job metadata is retained. Default value: 30.
state

The state of the Data Lake Analytics account. Possible values include: 'Active', 'Suspended' NOTE: This property will not be serialized. It can only be populated by the server.
storageAccounts

The list of Azure Blob Storage accounts associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.
systemMaxDegreeOfParallelism

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. NOTE: This property will not be serialized. It can only be populated by the server.
systemMaxJobCount

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. NOTE: This property will not be serialized. It can only be populated by the server.
virtualNetworkRules

The list of virtualNetwork rules associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

The resource identifer. NOTE: This property will not be serialized. It can only be populated by the server.
location

The resource location. NOTE: This property will not be serialized. It can only be populated by the server.
name

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

The resource tags. NOTE: This property will not be serialized. It can only be populated by the server.
type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accountId

The unique identifier associated with this Data Lake Analytics account. NOTE: This property will not be serialized. It can only be populated by the server.

accountId?: string

Property Value

string

computePolicies

The list of compute policies associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

computePolicies?: ComputePolicy[]

Property Value

ComputePolicy[]

creationTime

The account creation time. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

currentTier

The commitment tier in use for the current month. Possible values include: 'Consumption', 'Commitment_100AUHours', 'Commitment_500AUHours', 'Commitment_1000AUHours', 'Commitment_5000AUHours', 'Commitment_10000AUHours', 'Commitment_50000AUHours', 'Commitment_100000AUHours', 'Commitment_500000AUHours' NOTE: This property will not be serialized. It can only be populated by the server.

currentTier?: TierType

Property Value

TierType

dataLakeStoreAccounts

The list of Data Lake Store accounts associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

dataLakeStoreAccounts?: DataLakeStoreAccountInformation[]

Property Value

DataLakeStoreAccountInformation[]

debugDataAccessLevel

The current state of the DebugDataAccessLevel for this account. Possible values include: 'All', 'Customer', 'None' NOTE: This property will not be serialized. It can only be populated by the server.

debugDataAccessLevel?: DebugDataAccessLevel

Property Value

DebugDataAccessLevel

defaultDataLakeStoreAccount

The default Data Lake Store account associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

defaultDataLakeStoreAccount?: string

Property Value

string

endpoint

The full CName endpoint for this account. NOTE: This property will not be serialized. It can only be populated by the server.

endpoint?: string

Property Value

string

firewallAllowAzureIps

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

firewallAllowAzureIps?: FirewallAllowAzureIpsState

Property Value

FirewallAllowAzureIpsState

firewallRules

The list of firewall rules associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

firewallRules?: FirewallRule[]

Property Value

FirewallRule[]

firewallState

The current state of the IP address firewall for this account. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

firewallState?: FirewallState

Property Value

FirewallState

hiveMetastores

The list of hiveMetastores associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

hiveMetastores?: HiveMetastore[]

Property Value

HiveMetastore[]

lastModifiedTime

The account last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedTime?: Date

Property Value

Date

maxDegreeOfParallelism

The maximum supported degree of parallelism for this account. Default value: 30.

maxDegreeOfParallelism?: number

Property Value

number

maxDegreeOfParallelismPerJob

The maximum supported degree of parallelism per job for this account. NOTE: This property will not be serialized. It can only be populated by the server.

maxDegreeOfParallelismPerJob?: number

Property Value

number

maxJobCount

The maximum supported jobs running under the account at the same time. Default value: 3.

maxJobCount?: number

Property Value

number

minPriorityPerJob

The minimum supported priority per job for this account. NOTE: This property will not be serialized. It can only be populated by the server.

minPriorityPerJob?: number

Property Value

number

newTier

The commitment tier for the next month. Possible values include: 'Consumption', 'Commitment_100AUHours', 'Commitment_500AUHours', 'Commitment_1000AUHours', 'Commitment_5000AUHours', 'Commitment_10000AUHours', 'Commitment_50000AUHours', 'Commitment_100000AUHours', 'Commitment_500000AUHours' NOTE: This property will not be serialized. It can only be populated by the server.

newTier?: TierType

Property Value

TierType

provisioningState

The provisioning status of the Data Lake Analytics account. Possible values include: 'Failed', 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', 'Deleted', 'Undeleting', 'Canceled' NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: DataLakeAnalyticsAccountStatus

Property Value

DataLakeAnalyticsAccountStatus

queryStoreRetention

The number of days that job metadata is retained. Default value: 30.

queryStoreRetention?: number

Property Value

number

state

The state of the Data Lake Analytics account. Possible values include: 'Active', 'Suspended' NOTE: This property will not be serialized. It can only be populated by the server.

state?: DataLakeAnalyticsAccountState

Property Value

DataLakeAnalyticsAccountState

storageAccounts

The list of Azure Blob Storage accounts associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

storageAccounts?: StorageAccountInformation[]

Property Value

StorageAccountInformation[]

systemMaxDegreeOfParallelism

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. NOTE: This property will not be serialized. It can only be populated by the server.

systemMaxDegreeOfParallelism?: number

Property Value

number

systemMaxJobCount

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. NOTE: This property will not be serialized. It can only be populated by the server.

systemMaxJobCount?: number

Property Value

number

virtualNetworkRules

The list of virtualNetwork rules associated with this account. NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetworkRules?: VirtualNetworkRule[]

Property Value

VirtualNetworkRule[]

Inherited Property Details

id

The resource identifer. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

The resource location. NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From Resource.location

name

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

The resource tags. NOTE: This property will not be serialized. It can only be populated by the server.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type