Get-OCIDatabaseAutonomousDatabasesList

SYNOPSIS

Invokes Database service - ListAutonomousDatabases operation.

SYNTAX

Limit

Get-OCIDatabaseAutonomousDatabasesList -CompartmentId <String> [-AutonomousContainerDatabaseId <String>] [-Limit <Int32>] [-Page <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-InfrastructureType <InfrastructureTypeEnum>] [-LifecycleState <LifecycleStateEnum>] [-LifecycleStateNotEqualTo <LifecycleStateEnum>] [-DbWorkload <DbWorkloadEnum>] [-DbVersion <String>] [-IsFreeTier <Boolean>] [-DisplayName <String>] [-OpcRequestId <String>] [-IsRefreshableClone <Boolean>] [-IsDataGuardEnabled <Boolean>] [-IsResourcePoolLeader <Boolean>] [-ResourcePoolLeaderId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatabaseAutonomousDatabasesList -CompartmentId <String> [-AutonomousContainerDatabaseId <String>] [-Page <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-InfrastructureType <InfrastructureTypeEnum>] [-LifecycleState <LifecycleStateEnum>] [-LifecycleStateNotEqualTo <LifecycleStateEnum>] [-DbWorkload <DbWorkloadEnum>] [-DbVersion <String>] [-IsFreeTier <Boolean>] [-DisplayName <String>] [-OpcRequestId <String>] [-IsRefreshableClone <Boolean>] [-IsDataGuardEnabled <Boolean>] [-IsResourcePoolLeader <Boolean>] [-ResourcePoolLeaderId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of Autonomous Databases based on the query parameters specified.

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

-AutonomousContainerDatabaseId

The Autonomous Container Database OCID.

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

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

-CompartmentId

The compartment OCID.

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

Required: True
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

-DbVersion

A filter to return only autonomous database resources that match the specified dbVersion.

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

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

-DbWorkload

A filter to return only autonomous database resources that match the specified workload type.

Type: DbWorkloadEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Oltp, Dw, Ajd, Apex

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

-DisplayName

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

-InfrastructureType

A filter to return only resources that match the given Infrastructure Type.

Type: InfrastructureTypeEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Cloud, CloudAtCustomer

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

-IsDataGuardEnabled

A filter to return only resources that have Data Guard enabled.

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

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

-IsFreeTier

Filter on the value of the resource's 'isFreeTier' property. A value of `true` returns only Always Free resources. A value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.

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

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

-IsRefreshableClone

Filter on the value of the resource's 'isRefreshableClone' property. A value of `true` returns only refreshable clones. A value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.

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

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

-IsResourcePoolLeader

Filter if the resource is the resource pool leader. A value of `true` returns only resource pool leader.

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

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

-LifecycleState

A filter to return only resources that match the given lifecycle state exactly.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Provisioning, Available, Stopping, Stopped, Starting, Terminating, Terminated, Unavailable, RestoreInProgress, RestoreFailed, BackupInProgress, ScaleInProgress, AvailableNeedsAttention, Updating, MaintenanceInProgress, Restarting, Recreating, RoleChangeInProgress, Upgrading, Inaccessible, Standby

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

-LifecycleStateNotEqualTo

A filter to return only resources that not match the given lifecycle state.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Provisioning, Available, Stopping, Stopped, Starting, Terminating, Terminated, Unavailable, RestoreInProgress, RestoreFailed, BackupInProgress, ScaleInProgress, AvailableNeedsAttention, Updating, MaintenanceInProgress, Restarting, Recreating, RoleChangeInProgress, Upgrading, Inaccessible, Standby

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

-Limit

The maximum number of items to return per page.

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 identifier for the request.

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

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

-Page

The pagination token to continue listing from.

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

-ResourcePoolLeaderId

The database OCID of the resourcepool Leader Autonomous Database.

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. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

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 ascending (`ASC`) or descending (`DESC`).

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

-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.DatabaseService.Models.AutonomousDatabaseSummary
• Oci.DatabaseService.Responses.ListAutonomousDatabasesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples