Get-CrmOperationStatus
Retrieves the status for an operation from your Dataverse environment.
Syntax
Get-CrmOperationStatus
-Id <Guid>
[-ApiUrl] <Uri>
[[-Credential] <PSCredential>]
[-MaxCrmConnectionTimeOutMinutes <Int32>] Description
The Get-CrmOperationStatus retrieves the status of an operation from your Dataverse environment.
Examples
Example 1
PS C:\> Get-CrmOperationStatus -Id <OperationIdGuid> -ApiUrl $connectionhost -Credential $credRetrieves the status of an operation as specified by the operation Id.
Parameters
-ApiUrl
URL of the Dataverse root service endpoint. For information about this parameter see Establish your credentials and connection.
| Type: | Uri |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Credential
User credential for signing in to Dataverse. For information about this parameter see Establish your credentials and connection.
| Type: | PSCredential |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
Operation Id of a long-running process, such as a backup, restore, new environment, or delete operation. For example, when you run the Get-CrmInstanceBackup cmdlet, the operation Id is returned from the cmdlet.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxCrmConnectionTimeOutMinutes
Maximum number in minutes to wait before quitting the operation.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
System.Guid
System.Uri System.Management.Automation.PSCredential System.Int32
Outputs
System.Object