Edit

Share via

New-AzureBatchCertificate

  • Reference
Module:
AzureRM.Batch

Adds a certificate to the specified Batch account.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureBatchCertificate
   [-FilePath] <String>
   [-Password <SecureString>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzureBatchCertificate
   [-RawData] <Byte[]>
   [-Password <SecureString>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureBatchCertificate cmdlet adds a certificate to the specified Azure Batch account.

Examples

Example 1: Add a certificate from a file

PS C:\>New-AzureBatchCertificate -FilePath "E:\Certificates\MyCert.cer" -BatchContext $Context

This command adds a certificate to the specified Batch account by using the file E:\Certificates\MyCert.cer.

Example 2: Add a certificate from raw data

PS C:\>$RawData = [System.IO.File]::ReadAllBytes("E:\Certificates\MyCert.pfx")
PS C:\> New-AzureBatchCertificate -RawData $RawData -Password "Password1234" -BatchContext $Context

The first command reads the data from the file named MyCert.pfx into the $RawData variable. The second command adds a certificate to the specified Batch account using the raw data stored in $RawData.

Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property.

Type:BatchAccountContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

Specifies the path of the certificate file. The certificate file must be in either .cer or .pfx format.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Password

Specifies the password to access the certificate private key. You must specify this parameter if you specify a certificate in .pfx format.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RawData

Specifies the raw certificate data in either .cer or .pfx format.

Type:Byte[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Byte[]

BatchAccountContext

Parameters: BatchContext (ByValue)

Outputs

Void