< Back
Get-AzureRmBatchAccount
Post
NAME Get-AzureRmBatchAccount
SYNOPSIS
Gets a Batch account in the current subscription.
SYNTAX
Get-AzureRmBatchAccount [[-AccountName] <String>] [[-ResourceGroupName] <String>] [[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmBatchAccount 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.
PARAMETERS
-AccountName <String>
Specifies the name of an account. If you specify an account name, this cmdlet only returns that account.
Required? false
Position? 0
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 name of a resource group. If you specify a resource group, this cmdlet gets the accounts under the specified resource group.
Required? false
Position? 1
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"}
This cmdlet gets accounts that contain the tags that this parameter specifies.
Required? false
Position? 2
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
Microsoft.Azure.Commands.Batch.BatchAccountContext
NOTES
Example 1: Get a batch account by name
PS C:\\>Get-AzureRmBatchAccount -AccountName "pfuller"
AccountName : pfuller
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 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
PS C:\\>Get-AzureRmBatchAccount -ResourceGroupName "CmdletExampleRG"
AccountName : cmdletexample
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com
AccountName : cmdletexample2
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchaccount
New-AzureRmBatchAccount
Remove-AzureRmBatchAccount
Set-AzureRmBatchAccount
Azure Batch Cmdlets
SYNOPSIS
Gets a Batch account in the current subscription.
SYNTAX
Get-AzureRmBatchAccount [[-AccountName] <String>] [[-ResourceGroupName] <String>] [[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmBatchAccount 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.
PARAMETERS
-AccountName <String>
Specifies the name of an account. If you specify an account name, this cmdlet only returns that account.
Required? false
Position? 0
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 name of a resource group. If you specify a resource group, this cmdlet gets the accounts under the specified resource group.
Required? false
Position? 1
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"}
This cmdlet gets accounts that contain the tags that this parameter specifies.
Required? false
Position? 2
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
Microsoft.Azure.Commands.Batch.BatchAccountContext
NOTES
Example 1: Get a batch account by name
PS C:\\>Get-AzureRmBatchAccount -AccountName "pfuller"
AccountName : pfuller
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 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
PS C:\\>Get-AzureRmBatchAccount -ResourceGroupName "CmdletExampleRG"
AccountName : cmdletexample
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com
AccountName : cmdletexample2
Location : westus
ResourceGroupName : CmdletExampleRG
CoreQuota : 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchaccount
New-AzureRmBatchAccount
Remove-AzureRmBatchAccount
Set-AzureRmBatchAccount
Azure Batch Cmdlets