Get-OCIOdaWorkRequest
SYNOPSIS
Invokes Oda service - GetWorkRequest operation.
SYNTAX
Default (Default)
Get-OCIOdaWorkRequest -WorkRequestId <String> [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
StatusParamSet
Get-OCIOdaWorkRequest -WorkRequestId <String> [-OpcRequestId <String>] -WaitForStatus <StatusEnum[]> [-WaitIntervalSeconds <Int32>] [-MaxWaitAttempts <Int32>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
DESCRIPTION
Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.
PARAMETERS
-AuthType
Type of authentication to use for making API requests. Default is Key based Authentication.
Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ConfigFile
The path to the config file.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Endpoint
The value to use as the service endpoint, including any required API version path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FullResponse
Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MaxWaitAttempts
Maximum number of attempts to be made until the resource reaches a desired state.
Type: Int32
Parameter Sets: StatusParamSet
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoRetry
Disable retry logic for calls to services.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OpcRequestId
The client request ID for tracing. This value is included in the opc-request-id response header.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Profile
The profile in the config file to load.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TimeOutInMillis
Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WaitForStatus
This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state.
Type: StatusEnum[]
Parameter Sets: StatusParamSet
Aliases: None
Accepted values: UnknownEnumValue, Accepted, InProgress, Succeeded, Failed, Canceling, Canceled
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WaitIntervalSeconds
Check every WaitIntervalSeconds to see whether the resource has reached a desired state.
Type: Int32
Parameter Sets: StatusParamSet
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WorkRequestId
The identifier of the asynchronous work request.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.
OUTPUTS
- Oci.OdaService.Models.WorkRequest
- Oci.OdaService.Responses.GetWorkRequestResponse