New-AzBatchAccount
Syntax
Default (Default)
New-AzBatchAccount
[-AccountName] <String>
[-Location] <String>
[-ResourceGroupName] <String>
[[-AutoStorageAccountId] <String>]
[-PoolAllocationMode <PoolAllocationMode>]
[-KeyVaultId <String>]
[-KeyVaultUrl <String>]
[-Tag <Hashtable>]
[-PublicNetworkAccess <PublicNetworkAccessType>]
[-IdentityType <ResourceIdentityType>]
[-IdentityId <String[]>]
[-EncryptionKeySource <KeySource>]
[-EncryptionKeyIdentifier <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The New-AzBatchAccount cmdlet creates an Azure Batch account for the specified resource group and location.
Examples
Example 1: Create a Batch account
New-AzBatchAccount -AccountName "pfuller" -ResourceGroupName "ResourceGroup03" -Location "WestUS"
AccountName : pfuller
Location : westus
ResourceGroupName : ResourceGroup03
DedicatedCoreQuota : 20
LowPriorityCoreQuota : 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.
Example 2
Creates a Batch account. (autogenerated)
New-AzBatchAccount -AccountName 'pfuller' -AutoStorageAccountId <String> -Location 'WestUS' -ResourceGroupName 'ResourceGroup03'
Parameters
-AccountName
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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AutoStorageAccountId
Specifies the resource ID of the storage account to be used for auto storage.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 3 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeyIdentifier
The Key Identifier for customer-based encryption.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeySource
Configures how customer data is encrypted inside the Batch account.
By default, accounts are encrypted using a Microsoft managed key.
For additional control, a customer-managed key can be used instead.
Parameter properties
Type: KeySource
Default value: None Accepted values: MicrosoftBatch, MicrosoftKeyVault Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityId
The list of user assigned identities associated with the BatchAccount. This parameter is only used when IdentityType is set to UserAssigned.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityType
The identity associated with the BatchAccount
Parameter properties
Type: ResourceIdentityType
Default value: None Accepted values: SystemAssigned, UserAssigned, None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultId
The resource ID of the Azure key vault associated with the Batch account.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-KeyVaultUrl
The URL of the Azure key vault associated with the Batch account.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Location
Specifies the region where this cmdlet creates the account.
For more information, see Azure Regions .
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PoolAllocationMode
The allocation mode for creating pools in the Batch account.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PublicNetworkAccess
The public network access type
Parameter properties
Type: PublicNetworkAccessType
Default value: None Accepted values: Enabled, Disabled Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Specifies the name of the resource group in which this cmdlet creates the account.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Tag
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False Aliases: Tags
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
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 .
Outputs
