New-AzBatchCertificate
Adds a certificate to the specified Batch account.
Syntax
New-AzBatchCertificate
[-FilePath] <String>
[-Password <SecureString>]
[-Kind <PSCertificateKind>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzBatchCertificate
[-RawData] <Byte[]>
[-Password <SecureString>]
[-Kind <PSCertificateKind>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzBatchCertificate cmdlet adds a certificate to the specified Azure Batch account.
Examples
Example 1: Add a certificate from a file
New-AzBatchCertificate -FilePath "E:\Certificates\MyCert.cer" -BatchContext $ContextThis 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
$RawData = [System.IO.File]::ReadAllBytes("E:\Certificates\MyCert.pfx")
New-AzBatchCertificate -RawData $RawData -Password <Password> -BatchContext $ContextThe 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-AzBatchAccount 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-AzBatchAccountKey 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: | AzContext, 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 |
-Kind
The kind of certificate to create. If this is not specified, it is assumed that all certificates without a password are CER and all certificates with password are PFX.
| Type: | PSCertificateKind |
| Accepted values: | Cer, Pfx |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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[]