New-AzBatchAccount
Creates a Batch account.
Syntax
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.
Type: | String |
Aliases: | Name |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AutoStorageAccountId
Specifies the resource ID of the storage account to be used for auto storage.
Type: | String |
Position: | 3 |
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 |
-EncryptionKeyIdentifier
The Key Identifier for customer-based encryption.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | KeySource |
Accepted values: | MicrosoftBatch, MicrosoftKeyVault |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IdentityId
The list of user assigned identities associated with the BatchAccount. This parameter is only used when IdentityType is set to UserAssigned.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IdentityType
The identity associated with the BatchAccount
Type: | ResourceIdentityType |
Accepted values: | SystemAssigned, UserAssigned, None |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVaultId
The resource ID of the Azure key vault associated with the Batch account.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-KeyVaultUrl
The URL of the Azure key vault associated with the Batch account.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Location
Specifies the region where this cmdlet creates the account. For more information, see Azure Regions.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PoolAllocationMode
The allocation mode for creating pools in the Batch account.
Type: | Nullable<T>[PoolAllocationMode] |
Accepted values: | BatchService, UserSubscription |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PublicNetworkAccess
The public network access type
Type: | PublicNetworkAccessType |
Accepted values: | Enabled, Disabled |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group in which this cmdlet creates the account.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
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"}
Type: | Hashtable |
Aliases: | Tags |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Nullable<T>[[Microsoft.Azure.Management.Batch.Models.PoolAllocationMode, Microsoft.Azure.Management.Batch, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]