Invoke-OCIFunctionsFunction

SYNOPSIS

Invokes FunctionsInvoke service - InvokeFunction operation.

SYNTAX

Default (Default)

Invoke-OCIFunctionsFunction -FunctionId <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromStream

Invoke-OCIFunctionsFunction -FunctionId <String> [-InvokeFunctionBody <Stream>] [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromStream-WriteToFile

Invoke-OCIFunctionsFunction -FunctionId <String> -InvokeFunctionBody <Stream> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -OutputFile <String> -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromStream-FullResponse

Invoke-OCIFunctionsFunction -FunctionId <String> -InvokeFunctionBody <Stream> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] [-FullResponse] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromFile

Invoke-OCIFunctionsFunction -FunctionId <String> -InvokeFunctionBodyFromFile <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromFile-WriteToFile

Invoke-OCIFunctionsFunction -FunctionId <String> -InvokeFunctionBodyFromFile <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -OutputFile <String> -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FromFile-FullResponse

Invoke-OCIFunctionsFunction -FunctionId <String> -InvokeFunctionBodyFromFile <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] [-FullResponse] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

WriteToFile

Invoke-OCIFunctionsFunction -FunctionId <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] -OutputFile <String> -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

FullResponse

Invoke-OCIFunctionsFunction -FunctionId <String> [-FnIntent <FnIntentEnum>] [-FnInvokeType <FnInvokeTypeEnum>] [-OpcRequestId <String>] [-IsDryRun <Boolean>] [-FullResponse] -Endpoint <String> [-ConfigFile <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Invokes a function

PARAMETERS

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

-FnIntent

An optional intent header that indicates to the FDK the way the event should be interpreted. E.g. 'httprequest', 'cloudevent'.

Type: FnIntentEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Httprequest, Cloudevent

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

-FnInvokeType

Indicates whether Oracle Functions should execute the request and return the result ('sync') of the execution, or whether Oracle Functions should return as soon as processing has begun ('detached') and leave result handling to the function.

Type: FnInvokeTypeEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Detached, Sync

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: FromStream-FullResponse, FromFile-FullResponse, FullResponse
Aliases: None

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

-FunctionId

The OCID of this function.

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

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

-InvokeFunctionBody

The body of the function invocation. Note: The maximum size of the request is limited. This limit is currently 6MB and the endpoint will not accept requests that are bigger than this limit.

Type: Stream
Parameter Sets: FromStream
Aliases: None

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

Type: Stream
Parameter Sets: FromStream-WriteToFile, FromStream-FullResponse
Aliases: None

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

-InvokeFunctionBodyFromFile

Use this parameter to provide the file location from where the input stream to be read. The body of the function invocation. Note: The maximum size of the request is limited. This limit is currently 6MB and the endpoint will not accept requests that are bigger than this limit.

Type: String
Parameter Sets: FromFile, FromFile-WriteToFile, FromFile-FullResponse
Aliases: None

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

-IsDryRun

Indicates that the request is a dry run, if set to "true". A dry run request does not execute the function.

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

-OutputFile

Path to the output file.

Type: String
Parameter Sets: FromStream-WriteToFile, FromFile-WriteToFile, WriteToFile
Aliases: None

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

-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

• System.IO.Stream
• System.Void
• Oci.FunctionsService.Responses.InvokeFunctionResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples