Edit

Get-AzBatchAccount

  • Reference
Module:
Az.Batch

Gets a Batch account in the current subscription.

Syntax

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.

Type:String
Aliases:Name
Position:0
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 name of a resource group. If you specify a resource group, this cmdlet gets the accounts under the specified resource group.

Type:String
Position:1
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"} This cmdlet gets accounts that contain the tags that this parameter specifies.

Type:Hashtable
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Hashtable

Outputs

BatchAccountContext