Get-AzureBatchAccount

Get-AzureBatchAccount

Gets a Batch account under the current subscription.

Syntax

Parameter Set: Default
Get-AzureBatchAccount [[-AccountName] <String> ] [[-ResourceGroupName] <String> ] [[-Tag] <Hashtable> ] [-Profile <AzureProfile> ] [ <CommonParameters>]




Detailed Description

The Get-AzureBatchAccount cmdlet gets an Azure Batch account under the current subscription. You can use the AccountName parameter to get a single account, or you can use the ResourceGroupName parameter to get accounts under that resource group.

Parameters

-AccountName<String>

Specifies the name of the account. If you specify an account name, this cmdlet only returns the specified account.


Aliases

Name

Required?

false

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 name of the resource group. If you specify a resource group, this cmdlet lists the accounts under the specified resource group.


Aliases

none

Required?

false

Position?

2

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

none

Required?

false

Position?

3

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: Get a batch account by name

This command gets the batch account named pfuller.


PS C:\> Get-AzureBatchAccount -AccountName "pfuller"

Example 2: Gets the batch accounts associated with a resource group

This command gets the batch accounts associated with the CmdletExampleRG resource group.


PS C:\> Get-AzureBatchAccount -ResourceGroupName "CmdletExampleRG"

Related topics

Show: