Get-CrmOperationStatus

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

Get-CrmOperationStatus

Retrieves the status of asynchronous operations sitting in the asynchronous operation queue for Microsoft Dynamics 365.

Syntax

Parameter Set: Default
Get-CrmOperationStatus [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-OperationId <Guid> ] [-Timeout <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-CrmOperationStatus cmdlet retrieves the status of an asynchronous deployment operation. If no parameters are specified, all asynchronous deployment operations in the processing queue are returned. This cmdlet returns a DeferredOperationStatus object, or an array of DeferredOperationStatus objects in the queue.

Parameters

-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

-OperationId<Guid>

Specifies the GUID of an asynchronous operation in the queue. If this parameter is supplied, the status of the specified operation is returned. Otherwise, the status of all operations in the queue is returned.This ID is returned by calls to New-CrmOrganization and Update-CrmOrganization.

Aliases	none
Required?	false
Position?	named
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 a list of all asynchronous deployment operations.

PS C:\> Get-CrmOperationStatus

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

This example returns the DeferredOperationStatus for a given asynchronous OperationId. If you were using this in a polling fashion, you would monitor the State property of the object.

PS C:\> Get-CrmOperationStatus –OperationId 31dc0f00-ecc6-4c05-8500-a20e7d995c10