Get-OCIOpsiDatabaseInsightsList

SYNOPSIS

Invokes OperationsInsights service - ListDatabaseInsights operation.

SYNTAX

Limit

Get-OCIOpsiDatabaseInsightsList [-CompartmentId <String>] [-EnterpriseManagerBridgeId <String>] [-Id <System.Collections.Generic.List`1[System.String]>] [-Status <System.Collections.Generic.List`1[Oci.OpsiService.Models.ResourceStatus]>] [-LifecycleState <System.Collections.Generic.List`1[Oci.OpsiService.Models.LifecycleState]>] [-DatabaseType <System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+DatabaseTypeEnum]>] [-DatabaseId <System.Collections.Generic.List`1[System.String]>] [-Fields <System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+FieldsEnum]>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-ExadataInsightId <String>] [-CompartmentIdInSubtree <Boolean>] [-OpsiPrivateEndpointId <String>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIOpsiDatabaseInsightsList [-CompartmentId <String>] [-EnterpriseManagerBridgeId <String>] [-Id <System.Collections.Generic.List`1[System.String]>] [-Status <System.Collections.Generic.List`1[Oci.OpsiService.Models.ResourceStatus]>] [-LifecycleState <System.Collections.Generic.List`1[Oci.OpsiService.Models.LifecycleState]>] [-DatabaseType <System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+DatabaseTypeEnum]>] [-DatabaseId <System.Collections.Generic.List`1[System.String]>] [-Fields <System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+FieldsEnum]>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-ExadataInsightId <String>] [-CompartmentIdInSubtree <Boolean>] [-OpsiPrivateEndpointId <String>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned.

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.

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

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

-CompartmentIdInSubtree

A flag to search all resources within a given compartment and all sub-compartments.

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

-DatabaseId

Optional list of database OCIDs of the associated DBaaS entity.

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

-DatabaseType

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Type: System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+DatabaseTypeEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: AdwS, AtpS, AdwD, AtpD, ExternalPdb, ExternalNoncdb, ComanagedVmCdb, ComanagedVmPdb, ComanagedVmNoncdb, ComanagedBmCdb, ComanagedBmPdb, ComanagedBmNoncdb, ComanagedExacsCdb, ComanagedExacsPdb, ComanagedExacsNoncdb, ComanagedExaccCdb, ComanagedExaccPdb, ComanagedExaccNoncdb, MdsMysql, ExternalMysql, AtpExacc, AdwExacc, ExternalAdw, ExternalAtp

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

-EnterpriseManagerBridgeId

Unique Enterprise Manager bridge identifier

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

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

-ExadataInsightId

OCID of exadata insight resource.

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

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

-Fields

Specifies the fields to return in a database summary response. By default all fields are returned if omitted.

Type: System.Collections.Generic.List`1[Oci.OpsiService.Requests.ListDatabaseInsightsRequest+FieldsEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: CompartmentId, DatabaseName, DatabaseDisplayName, DatabaseType, DatabaseVersion, DatabaseHostNames, FreeformTags, DefinedTags

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

-Id

Optional list of database insight 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

-LifecycleState

Lifecycle states

Type: System.Collections.Generic.List`1[Oci.OpsiService.Models.LifecycleState]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Creating, Updating, Active, Deleting, Deleted, Failed, NeedsAttention

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

-OpsiPrivateEndpointId

Unique Operations Insights PrivateEndpoint identifier

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

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.

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

-SortBy

Database insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: DatabaseName, DatabaseDisplayName, DatabaseType

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

-SortOrder

The sort order to use, either ascending (`ASC`) or descending (`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

Resource Status

Type: System.Collections.Generic.List`1[Oci.OpsiService.Models.ResourceStatus]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Disabled, Enabled, Terminated

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

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.OpsiService.Models.DatabaseInsightsCollection
• Oci.OpsiService.Responses.ListDatabaseInsightsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples