Skip to content

Latest commit

 

History

History
223 lines (174 loc) · 5.62 KB

Add-AzureRmServiceFabricClusterCertificate.md

File metadata and controls

223 lines (174 loc) · 5.62 KB
external help file online version schema
Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml
2.0.0

Add-AzureRmServiceFabricClusterCertificate

SYNOPSIS

Add a secondary cluster certificate to the cluster.

SYNTAX

ByExistingKeyVault

Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String>
 -SecretIdentifier <String> [-CertificateThumprint <String>] [<CommonParameters>]

ByNewPfxAndVaultName

Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String>
 [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] [-PfxOutputFolder <String>]
 -CertificateSubjectName <String> [<CommonParameters>]

ByExistingPfxAndVaultName

Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String>
 [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] -PfxSourceFile <String>
 [-CertificatePassword <SecureString>] [<CommonParameters>]

DESCRIPTION

Use Add-AzureRmServiceFabricClusterCertificate to add a secondary cluster certificate, either from an existing Azure key vault or by creating a new Azure key vault using the existing certificate provided or from an new self signed certificate created. It will override the secondary cluster if there is any.

EXAMPLES

Example 1

Add-AzureRmServiceFabricClusterCertificate -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' 
-SecretUrl 'https://contoso03vault.vault.azure.net/secrets/contoso03vaultrg/7f7de9131c034172b9df37ccc549524f' -CertificateThumprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A

This command will add a certificate in the existing Azure key vault, and upgrade the certificate as secondary cluster certificate.

Example 2

PS c:\> $pwd = ConvertTo-SecureString -String "123" -AsPlainText -Force
PS c:\> add-AzureRmServiceFabricClusterCertificate -ResourceGroupName 'Group2' -ClusterName 'Contoso02SFCluster' -KeyVaultName  'Contoso02Vault'  -KeyVaultResouceGroupName 'Contoso02VaultRg'  
-PfxDestinationFile 'c:\newcert.pfx' -Password $pwd -CertificateDnsName 'Contoso.com'

This command will add a certificate by creating an new self signed certificate and uploading it to the Azure key vault, and upgrade the certificate to secondary cluster certificate.

PARAMETERS

-CertificatePassword

The password of the .pfx file.

Type: SecureString
Parameter Sets: ByExistingPfxAndVaultName
Aliases: CertPassword

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CertificateSubjectName

The DNS name of the certificate to be created.

Type: String
Parameter Sets: ByNewPfxAndVaultName
Aliases: Subject

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CertificateThumprint

The thumprint for the Azure key vault secret.

Type: String
Parameter Sets: ByExistingKeyVault
Aliases: Thumbprint

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-KeyVaultName

Azure key vault name.

Type: String
Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-KeyVaultResouceGroupName

Azure key vault resource group name.

Type: String
Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specify the name of the cluster```yaml Type: String Parameter Sets: (All) Aliases: ClusterName

Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False


### -PfxOutputFolder
The folder path of the new Pfx file to be created```yaml
Type: String
Parameter Sets: ByNewPfxAndVaultName
Aliases: Destination

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PfxSourceFile

The existing .pfx file path

Type: String
Parameter Sets: ByExistingPfxAndVaultName
Aliases: Source

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ResourceGroupName

Specifies the name of the resource group.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SecretIdentifier

The existing Azure key vault secret uri.

Type: String
Parameter Sets: ByExistingKeyVault
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.ServiceFabric.Models.PsCluster

NOTES

RELATED LINKS

Remove-AzureRmServiceFabricClusterCertificate New-AzureRmServiceFabricCluster Add-AzureRmServiceFabricApplicationCertificate