Get-SqlDataCatalogOperationList
Published 20 October 2021
Get a list of operations
Syntax
Get-SqlDataCatalogOperationList [[-OperationStatus] <string[]>] [-OperationType <string>] [-StartResultNumber <int>] [-MaxNumberOfResults <int>] [<CommonParameters>]
Description
Returns a list of operations with details. Can be filtered down by operation status or paginated.
Parameters
-OperationStatus
<String[]>
An array with the status of the operations to be returned. These can be Queued, Running, Canceled, Successful or Errored.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-OperationType
<String>
Filter down to a single operation type, one of GENERATE_SUGGESTIONS, DATA_SCANNING, INSTANCE_SCANNING, or DELETE_INSTANCE
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-StartResultNumber
<Int32>
Optional. The start index of the matched column collection. See MaxNumberOfResults and the below example.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | 0 |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-MaxNumberOfResults
<Int32>
Optional. The maximum number of results you would like returned in one go. Combine this with StartResultNumber to get a slice of operations.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | 0 |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
-
A array of hashtables with the following properties:
- id: string
- createdDateUtc: string
- startedDateUtc: string
- endDateUtc: string
- canceledDateUtc: string
- errorMessage: string
- userName: string
- status: string
- type: string - one of GENERATE_SUGGESTIONS, INSTANCE_SCANNING, DATA_SCANNING, or DELETE_INSTANCE
- description: string
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlDataCatalogOperationList -OperationStatus "Successful" -StartResultNumber 10 -MaxNumberOfResults 20
From the most recent successful operations it returns 20 starting from the 10th
