Edit

Share via

Set-AzBatchAccount

  • Reference
Module:
Az.Batch

Updates a Batch account.

Syntax

Set-AzBatchAccount
   [-AccountName] <String>
   [-Tag] <Hashtable>
   [-ResourceGroupName <String>]
   [-AutoStorageAccountId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzBatchAccount cmdlet updates an Azure Batch account. Currently, this cmdlet can update only tags.

Examples

Example 1: Update the tags on a Batch account

Set-AzBatchAccount -AccountName "cmdletexample" -Tag @{key0="value0";key1=$null;key2="value2"}

AccountName                  : cmdletexample
Location                     : westus
ResourceGroupName            : CmdletExampleRG
DedicatedCoreQuota           : 20
LowPriorityCoreQuota         : 20
PoolQuota                    : 20
ActiveJobAndJobScheduleQuota : 20
Tags                         :
                               Name  Value
                               ====  ======
                               key0  value0
                               key1
                               key2  value2
TaskTenantUrl                : https://cmdletexample.westus.batch.azure.com

This command updates the tags on the account named pfuller.

Parameters

-AccountName

Specifies the name of the Batch account that this cmdlet updates.

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

-AutoStorageAccountId

Specifies the resource ID of the storage account to be used for auto storage.

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

-ResourceGroupName

Specifies the resource group of the account that this cmdlet updates.

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

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

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

Inputs

String

Hashtable

Outputs

BatchAccountContext