New-AzBatchAccountKey

Reference

Module:: Az.Batch

Regenerates a key of a Batch account.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

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

Description

The New-AzBatchAccountKey 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-AzBatchAccountKey -AccountName "pfuller" -KeyType "Primary"
AccountName                  : pfuller
Location                     : westus
ResourceGroupName            : CmdletExampleRG
DedicatedCoreQuota           : 20
LowPriorityCoreQuota         : 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
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
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
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
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

BatchAccountContext