Set-AzureRmDataLakeStoreAccount
Modifies a Data Lake Store 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-AzureRmDataLakeStoreAccount
[-Name] <String>
[[-DefaultGroup] <String>]
[[-Tag] <Hashtable>]
[[-TrustedIdProviderState] <TrustedIdProviderState>]
[[-FirewallState] <FirewallState>]
[[-ResourceGroupName] <String>]
[-Tier <TierType>]
[-AllowAzureIpState <FirewallAllowAzureIpsState>]
[-KeyVersion <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzureRmDataLakeStoreAccount cmdlet modifies a Data Lake Store account.
Examples
Example 1: Add a tag to an account
PS C:\>Set-AzureRmDataLakeStoreAccount -Name "ContosoADL" -Tags @{"stage"="production"}This command adds the specified tag to the Data Lake Store account named ContosoADL.
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 |
-DefaultGroup
Specifies the ID of an AzureActive Directory group. This group is the default group for files and folders that you create.
| Type: | String |
| Position: | 1 |
| 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 or disable existing firewall rules.
| Type: | Nullable<T>[FirewallState] |
| Accepted values: | Enabled, Disabled |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-KeyVersion
If the encryption type is User assigned, the user can rotate their key version with this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of a Data Lake Store account.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group that contains the Data Lake Store account to modify.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
Specifies tags as key-value pairs. You can use tags to identify a Data Lake Store account from other Azure resources.
| Type: | Hashtable |
| Aliases: | Tags |
| Position: | 2 |
| 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, Commitment1TB, Commitment10TB, Commitment100TB, Commitment500TB, Commitment1PB, Commitment5PB |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TrustedIdProviderState
Optionally enable or disable the existing trusted ID providers.
| Type: | Nullable<T>[TrustedIdProviderState] |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Nullable<T>[[Microsoft.Azure.Management.DataLake.Store.Models.TrustedIdProviderState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
Nullable<T>[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
Nullable<T>[[Microsoft.Azure.Management.DataLake.Store.Models.TierType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
Nullable<T>[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]