Edit

Share via

New-AzureRmBatchAccountKey

  • Reference
Module:
AzureRM.Batch

Regenerates a key of a Batch 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

New-AzureRmBatchAccountKey
   [-AccountName] <String>
   [-ResourceGroupName <String>]
   -KeyType <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureRmBatchAccountKey cmdlet regenerates the primary or secondary key of an Azure Batch account. The cmdlet returns a BatchAccountContext object that has its current PrimaryAccountKey and SecondaryAccountKey properties.

Examples

Example 1: Regenerate the primary account key on a Batch account

PS C:\>New-AzureRmBatchAccountKey -AccountName "pfuller" -KeyType "Primary"
AccountName                  : pfuller

Location                     : westus

ResourceGroupName            : CmdletExampleRG

CoreQuota                    : 20

PoolQuota                    : 20

ActiveJobAndJobScheduleQuota : 20

Tags                         : 
TaskTenantUrl                : https://cmdletexample.westus.batch.azure.com

This command regenerates the primary account key on the Batch account named pfuller.

Parameters

-AccountName

Specifies the name of the Batch account for which this cmdlet regenerates a key.

Type:String
Aliases:Name
Position:0
Default value:None
Required:True
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

-KeyType

Specifies the type of key that this cmdlet regenerates. Valid values are:

  • Primary
  • Secondary
Type:String
Accepted values:Primary, Secondary
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the resource group of the account for which this cmdlet regenerates a key.

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

Inputs

String

Outputs

BatchAccountContext