Get-OCIDatasciencePrivateEndpointsList

SYNOPSIS

Invokes DataScience service - ListDataSciencePrivateEndpoints operation.

SYNTAX

Limit

Get-OCIDatasciencePrivateEndpointsList -CompartmentId <String> [-OpcRequestId <String>] [-Limit <Int32>] [-Page <String>] [-LifecycleState <DataSciencePrivateEndpointLifecycleState>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-DisplayName <String>] [-CreatedBy <String>] [-DataScienceResourceType <DataScienceResourceType>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatasciencePrivateEndpointsList -CompartmentId <String> [-OpcRequestId <String>] [-Page <String>] [-LifecycleState <DataSciencePrivateEndpointLifecycleState>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-DisplayName <String>] [-CreatedBy <String>] [-DataScienceResourceType <DataScienceResourceType>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn't include compartmentId, or includes compartmentId with two or more other parameters, then an error is 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

Filter results by the OCID of the compartment.

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

-CreatedBy

Filter results by the OCID of the user who created the resource.

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

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

-DataScienceResourceType

Resource types in the Data Science service such as notebooks.

Type: DataScienceResourceType
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, NotebookSession, ModelDeployment

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

-DisplayName

Filter results by its user-friendly 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

-LifecycleState

The lifecycle state of the private endpoint.

Type: DataSciencePrivateEndpointLifecycleState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Creating, Active, Updating, 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. 1 is the minimum, 100 is the maximum. 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, then 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

-Page

For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

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

The field used to sort the results. Multiple fields aren't supported.

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

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

-SortOrder

Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

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.DatascienceService.Models.DataSciencePrivateEndpointSummary
Oci.DatascienceService.Responses.ListDataSciencePrivateEndpointsResponse