Add-AzureRmServiceFabricClientCertificate
Add common name or thumbprint to the cluster for client authentication purposes.
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
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 -AdminThis 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 5F3660C715EBBDA31DB1FFDCF508302348DE8E7AThis 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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientCertificateCommonName
Specify client common name, issuer thumbprint, and authentication type.
| Type: | PSClientCertificateCommonName[] |
| Aliases: | CertCommonName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CommonName
Specify client certificate common name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| 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 |
-IssuerThumbprint
Specify client certificate issuer thumbprint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specify the name of the cluster.
| Type: | String |
| Aliases: | ClusterName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Thumbprint
Specify client certificate thumbprint.
| Type: | String |
| Aliases: | ClientCertificateThumbprint |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Parameters: Admin (ByValue)
Parameters: CommonName (ByValue), IssuerThumbprint (ByValue), Thumbprint (ByValue)
String[]
Parameters: AdminClientThumbprint (ByValue), ReadonlyClientThumbprint (ByValue)
PSClientCertificateCommonName[]
Parameters: ClientCertificateCommonName (ByValue)