Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzBatchAccount

Module:
Az.Batch Module

Gets a Batch account in the current subscription.

Syntax

Default (Default) 

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

Description

The Get-AzBatchAccount cmdlet gets an Azure Batch account in 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.

Examples

Example 1: Get a batch account by name

Get-AzBatchAccount -AccountName "pfuller"

AccountName : pfuller
Location : westus
ResourceGroupName : CmdletExampleRG
DedicatedCoreQuota : 20
LowPriorityCoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://pfuller.westus.batch.azure.com

This command gets the batch account named pfuller.

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

Get-AzBatchAccount -ResourceGroupName "CmdletExampleRG"

AccountName : cmdletexample
Location : westus
ResourceGroupName : CmdletExampleRG
DedicatedCoreQuota : 20
LowPriorityCoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com
AccountName : cmdletexample2
Location : westus
ResourceGroupName : CmdletExampleRG
DedicatedCoreQuota : 20
LowPriorityCoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com

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

Parameters

-AccountName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-ResourceGroupName

Specifies the name of a resource group. If you specify a resource group, this cmdlet gets the accounts under the specified resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"} This cmdlet gets accounts that contain the tags that this parameter specifies.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Hashtable

Outputs

BatchAccountContext

Related Links

Feedback

Was this page helpful?