Add-AzureRmServiceFabricClientCertificate

Add common name or thumbprint to the cluster for client authentication purposes.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Add-AzureRmServiceFabricClientCertificate
   [-Admin]
   [-ResourceGroupName] <String>
   [-Name] <String>
   -Thumbprint <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzureRmServiceFabricClientCertificate
   [-Admin]
   [-ResourceGroupName] <String>
   [-Name] <String>
   -CommonName <String>
   -IssuerThumbprint <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzureRmServiceFabricClientCertificate
   [-ResourceGroupName] <String>
   [-Name] <String>
   -ClientCertificateCommonName <PSClientCertificateCommonName[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzureRmServiceFabricClientCertificate
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-AdminClientThumbprint <String[]>]
   [-ReadonlyClientThumbprint <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use Add-AzureRmServiceFabricClientCertificate to add a common name and issuer thumbprint or certificate thumbprint to the cluster, so the client can use it for authentication.

Examples

Example 1

PS c:> Add-AzureRmServiceFabricClientCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -Admin

This command will add the certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster, so the client can use the certificate as admin to communicate with the cluster.

Example 2

PS c:> Add-AzureRmServiceFabricClientCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -CommonName 'Contoso.com' -IssuerThumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A

This command will add a read only client certificate that's common name is 'Contoso.com' and issuer thumbprint is '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster.

Parameters

-Admin

Client authentication type.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-AdminClientThumbprint

Specify client certificate thumbprint that only has admin permission.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ClientCertificateCommonName

Specify client common name, issuer thumbprint, and authentication type.

Type:Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[]
Aliases:CertCommonName
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-CommonName

Specify client certificate common name.

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IssuerThumbprint

Specify client certificate issuer thumbprint.

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

Specify the name of the cluster.

Type:String
Aliases:ClusterName
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ReadonlyClientThumbprint

Specify client certificate thumbprint that has read only permission.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group.

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

Specify client certificate thumbprint.

Type:String
Aliases:ClientCertificateThumbprint
Position:Named
Default value:None
Accept pipeline input:True
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

SwitchParameter

Parameters: Admin (ByValue)

String

Parameters: CommonName (ByValue), IssuerThumbprint (ByValue), Thumbprint (ByValue)

String[]

Parameters: AdminClientThumbprint (ByValue), ReadonlyClientThumbprint (ByValue)

Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[]

Parameters: ClientCertificateCommonName (ByValue)

Outputs

PSCluster