Edit

Share via


Set-AzDataLakeAnalyticsAccount

Modifies a Data Lake Analytics account.

Syntax

Default (Default)

Set-AzDataLakeAnalyticsAccount
    [-Name] <String>
    [[-Tag] <Hashtable>]
    [[-ResourceGroupName] <String>]
    [-MaxAnalyticsUnits <Int32>]
    [-MaxJobCount <Int32>]
    [-QueryStoreRetention <Int32>]
    [-Tier <TierType>]
    [-FirewallState <FirewallState>]
    [-AllowAzureIpState <FirewallAllowAzureIpsState>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Set-AzDataLakeAnalyticsAccount cmdlet modifies an Azure Data Lake Analytics account.

Examples

Example 1: Modify the data source of an account

Set-AzDataLakeAnalyticsAccount -Name "ContosoAdlAcct" -Tag @{"stage"="production"}

This command changes the default data source and the Tags property of the account.

Example 2

Modifies a Data Lake Analytics account. (autogenerated)

Set-AzDataLakeAnalyticsAccount -AllowAzureIpState Enabled -FirewallState Enabled -Name 'ContosoAdlAcct' -ResourceGroupName myresourcegroup

Parameters

-AllowAzureIpState

Optionally allow/block Azure originating IPs through the firewall.

Parameter properties

Type:

Nullable<T>[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState]

Default value:None
Accepted values:Enabled, Disabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FirewallState

Optionally enable/disable existing firewall rules.

Parameter properties

Type:

Nullable<T>[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState]

Default value:None
Accepted values:Enabled, Disabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxAnalyticsUnits

The optional maximum supported analytics units to update the account with.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:MaxDegreeOfParallelism

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxJobCount

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

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the Data Lake Analytics account name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-QueryStoreRetention

The optional number of days that job metadata is retained to set in the account.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Specifies the resource group name of the Data Lake Analytics account.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Tag

A string,string dictionary of tags associated with this account that should replace the current set of tags

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Tier

The desired commitment tier for this account to use.

Parameter properties

Type:

Nullable<T>[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType]

Default value:None
Accepted values:Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Hashtable

Nullable<T>

Nullable<T>

Nullable<T>

Nullable<T>

Outputs

PSDataLakeAnalyticsAccount