Show / Hide Table of Contents

Get-OCIFunctionsPbfListingsList

SYNOPSIS

Invokes FunctionsManagement service - ListPbfListings operation.

SYNTAX

Limit

Get-OCIFunctionsPbfListingsList [-PbfListingId <String>] [-Name <String>] [-NameContains <String>] [-NameStartsWith <String>] [-Trigger <System.Collections.Generic.List`1[System.String]>] [-LifecycleState <LifecycleStateEnum>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIFunctionsPbfListingsList [-PbfListingId <String>] [-Name <String>] [-NameContains <String>] [-NameStartsWith <String>] [-Trigger <System.Collections.Generic.List`1[System.String]>] [-LifecycleState <LifecycleStateEnum>] [-Page <String>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing an array of PbfListingSummary response models.

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

-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

-LifecycleState

A filter to return only resources their lifecycleState matches the given lifecycleState.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Inactive, Deleted

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

-Limit

The maximum number of items to return. 1 is the minimum, 50 is the maximum.

Default: 10

Type: Int32
Parameter Sets: Limit
Aliases: None

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

-Name

A filter to return only resources that match the entire PBF name given.

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

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

-NameContains

A filter to return only resources that contain the supplied filter text in the PBF name given.

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

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

-NameStartsWith

A filter to return only resources that start with the supplied filter text in the PBF name given.

Type: String
Parameter Sets: (All)
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

The 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

-Page

The pagination token for a list query returned by a previous operation

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

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

-PbfListingId

unique PbfListing identifier

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 to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.

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

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

-SortOrder

Specifies sort order.

  • ASC: Ascending sort order.
  • DESC: Descending sort order.
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

-Trigger

A filter to return only resources that match the service trigger sources of a PBF.

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

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.FunctionsService.Models.PbfListingsCollection
  • Oci.FunctionsService.Responses.ListPbfListingsResponse

RELATED LINKS

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