Edit

Share via

Set-AzureKeyVaultCertificateIssuer

  • Reference
Module:
AzureRM.KeyVault

Sets a certificate issuer in a key vault.

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

Set-AzureKeyVaultCertificateIssuer
   [-VaultName] <String>
   [-Name] <String>
   -IssuerProvider <String>
   [-AccountId <String>]
   [-ApiKey <SecureString>]
   [-OrganizationDetails <PSKeyVaultCertificateOrganizationDetails>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureKeyVaultCertificateIssuer
   [-VaultName] <String>
   [-Name] <String>
   -InputObject <PSKeyVaultCertificateIssuerIdentityItem>
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureKeyVaultCertificateIssuer cmdlet sets a certificate issuer in a key vault.

Examples

Example 1: Set a certificate issuer

PS C:\> $AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName user -LastName name -EmailAddress username@microsoft.com
PS C:\> $OrgDetails = New-AzureKeyVaultCertificateOrganizationDetails -AdministrationDetails $AdminDetails
PS C:\> $Password = ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force
PS C:\> Set-AzureKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" -IssuerProvider "Test" -AccountId "555" -ApiKey $Password -OrganizationDetails $OrgDetails -PassThru

AccountId           : 555
ApiKey              :
OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails
Name                : TestIssuer01
IssuerProvider      : Test
VaultName           : Contosokv01

This command sets the properties for a certificate issuer.

Parameters

-AccountId

Specifies the account ID for the certificate issuer.

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

-ApiKey

Specifies the API key for the certificate issuer.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-InputObject

Specifies the certificate issuer to set.

Type:PSKeyVaultCertificateIssuerIdentityItem
Aliases:Issuer
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IssuerProvider

Specifies the type of certificate issuer.

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

-Name

Specifies the name of the Issuer.

Type:String
Aliases:IssuerName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OrganizationDetails

Organization details to be used with the issuer.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-VaultName

Specifies the name of the key vault.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSKeyVaultCertificateOrganizationDetails

Parameters: OrganizationDetails (ByValue)

PSKeyVaultCertificateIssuerIdentityItem

Parameters: InputObject (ByValue)

Outputs

PSKeyVaultCertificatePolicy