Show / Hide Table of Contents

Get-OCIOsmanagementhubWorkRequestsList

SYNOPSIS

Invokes WorkRequest service - ListWorkRequests operation.

SYNTAX

Limit

Get-OCIOsmanagementhubWorkRequestsList [-CompartmentId <String>] [-WorkRequestId <String>] [-Status <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OperationStatus]>] [-ResourceId <String>] [-OpcRequestId <String>] [-Page <String>] [-Limit <Int32>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-InitiatorId <String>] [-ParentId <String>] [-ParentResourcesNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-OperationType <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.WorkRequestOperationType]>] [-DisplayNameContains <String>] [-RetryOfId <String>] [-RerunOfId <String>] [-TimeCreatedLessThan <DateTime>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-IsManagedByAutonomousLinux <Boolean>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIOsmanagementhubWorkRequestsList [-CompartmentId <String>] [-WorkRequestId <String>] [-Status <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OperationStatus]>] [-ResourceId <String>] [-OpcRequestId <String>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-InitiatorId <String>] [-ParentId <String>] [-ParentResourcesNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-OperationType <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.WorkRequestOperationType]>] [-DisplayNameContains <String>] [-RetryOfId <String>] [-RerunOfId <String>] [-TimeCreatedLessThan <DateTime>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-IsManagedByAutonomousLinux <Boolean>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists work requests that match the specified compartment or work request OCID. Filter the list against a variety of criteria including but not limited to its name, status, and operation type.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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

-CompartmentId

The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-DisplayNameContains

A filter to return resources that may partially match the given display name.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-InitiatorId

The OCID of the schedule job that initiated the work request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsManagedByAutonomousLinux

Indicates whether to list only resources managed by the Autonomous Linux service.

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: `50`

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OperationType

The asynchronous operation tracked by this work request. The filter returns only resources that match the given OperationType.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.WorkRequestOperationType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, InstallPackages, RemovePackages, UpdatePackages, UpdateAllPackages, UpdateSecurity, UpdateBugfix, UpdateEnhancement, UpdateOther, UpdateKspliceKernel, UpdateKspliceUserspace, EnableModuleStreams, DisableModuleStreams, SwitchModuleStream, InstallModuleProfiles, RemoveModuleProfiles, SetSoftwareSources, ListPackages, SetManagementStationConfig, SyncManagementStationMirror, UpdateManagementStationSoftware, Update, ModuleActions, LifecyclePromotion, CreateSoftwareSource, UpdateSoftwareSource, ImportContent, SyncAgentConfig, InstallWindowsUpdates, ListWindowsUpdate, GetWindowsUpdateDetails, InstallAllWindowsUpdates, InstallSecurityWindowsUpdates, InstallBugfixWindowsUpdates, InstallEnhancementWindowsUpdates, InstallOtherWindowsUpdates, RemoveContent, UnregisterManagedInstance, Reboot

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Example: `3`

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ParentId

The OCID of the parent work request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ParentResourcesNotEqualTo

A filter to return the resources whose parent resources are not the same as the given resource OCIDs.

Type: System.Collections.Generic.List`1[System.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

-RerunOfId

A filter to return the work requests that are a rerun of the given work request OCIDs.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceId

The OCID of the resource. This filter returns resources associated with the specified resource.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RetryOfId

A filter to return the work requests that are a retry of the given work request OCIDs.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: TimeCreated, DisplayName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use, either 'ASC' or 'DESC'.

Type: SortOrder
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Status

A filter to return work requests that match the given status.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OperationStatus]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Waiting, Accepted, InProgress, Failed, Succeeded, Canceling, Canceled

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeCreatedGreaterThanOrEqualTo

A filter to return work requests that were created on or after the date provided (in RFC 3339 format). Example: '2023-08-25T21:10:29.600Z'

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeCreatedLessThan

A filter to return work requests that were created before the date provided (in RFC 3339 format). Example: '2023-08-25T21:10:29.600Z'

Type: DateTime
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

-WorkRequestId

The OCID of the work request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
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.OsmanagementhubService.Models.WorkRequestSummaryCollection
  • Oci.OsmanagementhubService.Responses.ListWorkRequestsResponse

RELATED LINKS

  • APIReference
  • DotnetSDKAPI
  • OCIModulesDocs
  • OCIServiceConcepts
  • Examples
Back to top Generated by DocFX