Share via

Get-CrmCertificate

Module:
Microsoft.Crm.PowerShell Module

Retrieves the certificate information for Dynamics 365.

Syntax

P1 (Default) 

Get-CrmCertificate
    [[-Id] <Guid>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]

P2 

Get-CrmCertificate
    [[-Certificate] <Certificate>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]

Description

The Get-CrmCertificate cmdlet retrieves the certificate information for Dynamics 365. This command can be called with or without parameters. If called without parameters, all available certificates are returned.

Examples

Example 1

PS C:\> Get-CrmCertificate

Returns the information for all certificates on the system.

Example 2

PS C:\> Get-CrmCertificate -Id a34eba34-0d0a-e011-b8e8-00155db05351

Returns the information for the certificate specified by the certificate Id.

Parameters

-Certificate

The Microsoft.Xrm.Sdk.Deployment.Certificate type.

Parameter properties

Type:Certificate
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

P2
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Diag

Turns on stack traces for error reports returned from Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-DwsServerUrl

The URL of the Deployment Web Service. This should be in the format: https://<serverurl>, for example, https://contoso.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Id

Specifies the Id of the certificate object (Microsoft.Xrm.Sdk.Deployment.Certificate) being addressed.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

P1
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Timeout

For internal use only.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

Inputs

System.Guid

Microsoft.Xrm.Sdk.Deployment.Certificate

System.Int32

System.Management.Automation.SwitchParameter

System.Management.Automation.PSCredential

System.String

Outputs

Microsoft.Xrm.Sdk.Deployment.Certificate