Set-AzureRmDataLakeAnalyticsAccount

Modifies a Data Lake Analytics account.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: Modify the data source of an account

PS C:\>Set-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAcct" -DefaultDataLakeStore "ContosoAdlStore01" -Tags @{"stage"="production"}

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

Parameters

-AllowAzureIpState

Optionally allow/block Azure originating IPs through the firewall.

Type:Nullable<T>[FirewallAllowAzureIpsState]
Accepted values:Enabled, Disabled
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FirewallState

Optionally enable/disable existing firewall rules.

Type:Nullable<T>[FirewallState]
Accepted values:Enabled, Disabled
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxAnalyticsUnits

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

Type:Nullable<T>[Int32]
Aliases:MaxDegreeOfParallelism
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxJobCount

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

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the Data Lake Analytics account name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-QueryStoreRetention

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

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tag

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

Type:Hashtable
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tier

The desired commitment tier for this account to use.

Type:Nullable<T>[TierType]
Accepted values:Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Hashtable

Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Nullable<T>[[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Nullable<T>[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Nullable<T>[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Outputs

PSDataLakeAnalyticsAccount