Set-AzureBatchAccount
Set-AzureBatchAccount
Updates the specified Batch account.
Syntax
Parameter Set: Default
Set-AzureBatchAccount [-AccountName] <String> [-Tag] <Hashtable[]> [-Profile <AzureProfile> ] [-ResourceGroupName <String> ] [ <CommonParameters>]
Detailed Description
The Set-AzureBatchAccount cmdlet updates the specified Azure Batch account. Currently, only tags can be updated.
Parameters
-AccountName<String>
Specifies the name of the existing Batch account to update.
Aliases |
Name |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Profile<AzureProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<String>
Specifies the resource group of the account being updated.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Tag<Hashtable[]>
Specifies tags in an array of hash tables to set on the account.
Aliases |
Tags |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- BatchAccountContext
Examples
Example 1: Update the tags on an existing Batch account
This command updates the tags on the cmdletexample account.
PS C:\> Set-AzureBatchAccount -AccountName "cmdletexample" -Tag @(@{Name = "tag1";Value = "value1"},@{Name = "tag2";Value = "value2"})