Get-CrmCertificate

Retrieves the certificate information for Dynamics 365.

Syntax

Get-CrmCertificate
   [[-Id] <Guid>]
   [-Timeout <Int32>]
   [-Diag]
   [-Credential <PSCredential>]
   [-DwsServerUrl <String>]
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.

Type:Certificate
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

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

-DwsServerUrl

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

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

-Id

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

Type:Guid
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

For internal use only.

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

System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Deployment.Certificate, Microsoft.Crm.PowerShell, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]