< Back

Set-AzureRmBatchAccount

Tue Jan 29, 2019 9:36 pm

NAME Set-AzureRmBatchAccount



SYNOPSIS

Updates a Batch account.





SYNTAX

Set-AzureRmBatchAccount [-AccountName] <String> [-Tag] <Hashtable> [-AutoStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>]

[-ResourceGroupName <String>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AccountName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AutoStorageAccountId <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

Key-value pairs in the form of a hash table. For example:



@{key0="value0";key1=$null;key2="value2"}



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

BatchAccountContext







NOTES









Example 1: Update the tags on a Batch account



PS C:\\>Set-AzureRmBatchAccount -AccountName "cmdletexample" -Tag @{key0="value0";key1=$null;key2="value2"}

AccountName : cmdletexample

Location : westus

ResourceGroupName : CmdletExampleRG

CoreQuota : 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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... tchaccount

Get-AzureRmBatchAccount

New-AzureRmBatchAccount

Remove-AzureRmBatchAccount

Azure Batch Cmdlets