Skip to content

Latest commit

 

History

History
243 lines (188 loc) · 5.73 KB

Add-AzureRmServiceFabricClientCertificate.md

File metadata and controls

243 lines (188 loc) · 5.73 KB
external help file online version schema
Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml
2.0.0

Add-AzureRmServiceFabricClientCertificate

SYNOPSIS

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

SYNTAX

SingleUpdateWithThumbprint

Add-AzureRmServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String>
 -Thumbprint <String> [-WhatIf] [-Confirm] [<CommonParameters>]

SingleUpdateWithCommonName

Add-AzureRmServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String>
 -CommonName <String> -IssuerThumbprint <String> [-WhatIf] [-Confirm] [<CommonParameters>]

MultipleUpdatesWithCommonName

Add-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String>
 -CommonNames <PSClientCertificateCommonName[]> [-WhatIf] [-Confirm] [<CommonParameters>]

MultipleUpdatesWithThumbprint

Add-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String>
 [-AdminClientThumbprints <String[]>] [-ReadonlyClientThumbprints <String[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1

PS c:> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName myResourceGroup -ClusterName myCluster -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -IsAdmin true

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

Example 1

PS C:\> $table=@{"abc.com;AF06E4BFCBA05DCB59C42720136EC19DBA0A8E9F"="true";"testdomain.com;5F3660C715EBBDA31DB1FFDCF508302348DE8E7A"="false"}
PS C:\> Add-AzureRmServiceFabricClientCertificate -CommonNameIssuersAndFlags $table -ClusterName testclusterpowershell2 -ResourceGroupName newsftestrg2

This command will add two client certificates: one with admin access, the other one with ready-only access by common name and issuer thumbprint to the cluster.

PARAMETERS

-Admin

Client authentication type.

Type: SwitchParameter
Parameter Sets: SingleUpdateWithThumbprint, SingleUpdateWithCommonName
Aliases: 

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

-AdminClientThumbprints

Specify a client certificate thumbprint which has admin permission.

Type: String[]
Parameter Sets: MultipleUpdatesWithThumbprint
Aliases: 

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

-CommonName

Specify the client certificate common name.

Type: String
Parameter Sets: SingleUpdateWithCommonName
Aliases: 

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

-CommonNames

Client certificate common name, issuer thumbprint and authentication type.

Type: PSClientCertificateCommonName[]
Parameter Sets: MultipleUpdatesWithCommonName
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-IssuerThumbprint

Client certificate issuer thumbprint.

Type: String
Parameter Sets: SingleUpdateWithCommonName
Aliases: 

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

-Name

The name of the cluster.

Type: String
Parameter Sets: (All)
Aliases: ClusterName

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

-ReadonlyClientThumbprints

Client certificate thumbprint which only has read only permissions=.

Type: String[]
Parameter Sets: MultipleUpdatesWithThumbprint
Aliases: 

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

-ResourceGroupName

The name of the resource group.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Thumbprint

Client certificate thumbprint.

Type: String
Parameter Sets: SingleUpdateWithThumbprint
Aliases: ClientCertificateThumbprint

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

-WhatIf

Shows what would happen if the cmdlet runs or not.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.Collections.Hashtable

System.String System.Boolean

OUTPUTS

Microsoft.Azure.Commands.ServiceFabric.Models.PsCluster

NOTES

RELATED LINKS

Remove-AzureRmServiceFabricClientCertificate