< Back
New-AzureRmBatchAccount
Post
NAME New-AzureRmBatchAccount
SYNOPSIS
Creates a Batch account.
SYNTAX
New-AzureRmBatchAccount [-AccountName] <String> [-Location] <String> [-ResourceGroupName] <String> [[-AutoStorageAccountId] <String>]
[-DefaultProfile <IAzureContextContainer>] [-KeyVaultId <String>] [-KeyVaultUrl <String>] [-PoolAllocationMode {BatchService | UserSubscription}]
[-Tag <Hashtable>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmBatchAccount cmdlet creates an Azure Batch account for the specified resource group and location.
PARAMETERS
-AccountName <String>
Specifies the name of the Batch account that this cmdlet creates.
Batch account names must be between 3 and 24 characters long and contain only numbers and lowercase letters.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoStorageAccountId <String>
Specifies the resource ID of the storage account to be used for auto storage.
Required? false
Position? 3
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
-KeyVaultId <String>
The resource ID of the Azure key vault associated with the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-KeyVaultUrl <String>
The URL of the Azure key vault associated with the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the region where this cmdlet creates the account. For more information, see Azure Regions
(https://azure.microsoft.com/en-us/regions).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PoolAllocationMode <PoolAllocationMode>
The allocation mode for creating pools in the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group in which this cmdlet creates the account.
Required? true
Position? 2
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"}
Required? false
Position? named
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
BatchAccountContext
NOTES
Example 1: Create a Batch account
PS C:\\>New-AzureRmBatchAccount -AccountName "pfuller" -ResourceGroupName "ResourceGroup03" -Location "WestUS"
AccountName : pfuller
Location : westus
ResourceGroupName : ResourceGroup03
CoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com
This command creates a Batch account named pfuller using the ResourceGroup03 resource group in the West US location.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchaccount
Get-AzureRmBatchAccount
Remove-AzureRmBatchAccount
Set-AzureRmBatchAccount
Azure Batch Cmdlets
SYNOPSIS
Creates a Batch account.
SYNTAX
New-AzureRmBatchAccount [-AccountName] <String> [-Location] <String> [-ResourceGroupName] <String> [[-AutoStorageAccountId] <String>]
[-DefaultProfile <IAzureContextContainer>] [-KeyVaultId <String>] [-KeyVaultUrl <String>] [-PoolAllocationMode {BatchService | UserSubscription}]
[-Tag <Hashtable>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmBatchAccount cmdlet creates an Azure Batch account for the specified resource group and location.
PARAMETERS
-AccountName <String>
Specifies the name of the Batch account that this cmdlet creates.
Batch account names must be between 3 and 24 characters long and contain only numbers and lowercase letters.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoStorageAccountId <String>
Specifies the resource ID of the storage account to be used for auto storage.
Required? false
Position? 3
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
-KeyVaultId <String>
The resource ID of the Azure key vault associated with the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-KeyVaultUrl <String>
The URL of the Azure key vault associated with the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the region where this cmdlet creates the account. For more information, see Azure Regions
(https://azure.microsoft.com/en-us/regions).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PoolAllocationMode <PoolAllocationMode>
The allocation mode for creating pools in the Batch account.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group in which this cmdlet creates the account.
Required? true
Position? 2
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"}
Required? false
Position? named
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
BatchAccountContext
NOTES
Example 1: Create a Batch account
PS C:\\>New-AzureRmBatchAccount -AccountName "pfuller" -ResourceGroupName "ResourceGroup03" -Location "WestUS"
AccountName : pfuller
Location : westus
ResourceGroupName : ResourceGroup03
CoreQuota : 20
PoolQuota : 20
ActiveJobAndJobScheduleQuota : 20
Tags :
TaskTenantUrl : https://cmdletexample.westus.batch.azure.com
This command creates a Batch account named pfuller using the ResourceGroup03 resource group in the West US location.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchaccount
Get-AzureRmBatchAccount
Remove-AzureRmBatchAccount
Set-AzureRmBatchAccount
Azure Batch Cmdlets