Get-CrmCertificate

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Get-CrmCertificate

Retrieves the certificate information for Microsoft Dynamics 365.

Syntax

Parameter Set: P1
Get-CrmCertificate [[-Id] <Guid> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]

Parameter Set: P2
Get-CrmCertificate [[-Certificate] <Certificate> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]

Detailed Description

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

Parameters

-Certificate<Certificate>

The Microsoft.Xrm.Sdk.Deployment.Certificate object contains information about the certificate that is being addressed, created, or removed.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Diag

Turns on stack traces for error reports returned from Microsoft 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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DwsServerUrl<String>

Identifies the location of the Deployment web service.This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Id<Guid>

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

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Timeout<Int32>

For internal use only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------------------- EXAMPLE 1 --------------------------

This example returns the information for all certificates on the system.

PS C:\> Get-CrmCertificate

-------------------------- EXAMPLE 2 --------------------------

This example returns the information for the certificate specified by the ID.

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