New-​Azure​Rm​Batch​Account​Key

Regenerates a key of a Batch account.

Syntax

New-AzureRmBatchAccountKey
   [-AccountName] <String>
   -KeyType <String>
   [-ResourceGroupName <String>]
   [<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.

Required 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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-KeyType

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

  • Primary
  • Secondary
Type:String
Parameter Sets:Primary, Secondary
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

BatchAccountContext