Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getFunction

This data source provides details about a specific Function resource in Oracle Cloud Infrastructure Functions service.

Retrieves a function.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testFunction = Oci.Functions.GetFunction.Invoke(new()
    {
        FunctionId = oci_functions_function.Test_function.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Functions"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Functions.GetFunction(ctx, &functions.GetFunctionArgs{
			FunctionId: oci_functions_function.Test_function.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Functions.FunctionsFunctions;
import com.pulumi.oci.Functions.inputs.GetFunctionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testFunction = FunctionsFunctions.getFunction(GetFunctionArgs.builder()
            .functionId(oci_functions_function.test_function().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_function = oci.Functions.get_function(function_id=oci_functions_function["test_function"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testFunction = oci.Functions.getFunction({
    functionId: oci_functions_function.test_function.id,
});
variables:
  testFunction:
    Fn::Invoke:
      Function: oci:Functions:getFunction
      Arguments:
        functionId: ${oci_functions_function.test_function.id}

Using getFunction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
def get_function(function_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFunctionResult
def get_function_output(function_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
func GetFunction(ctx *Context, args *GetFunctionArgs, opts ...InvokeOption) (*GetFunctionResult, error)
func GetFunctionOutput(ctx *Context, args *GetFunctionOutputArgs, opts ...InvokeOption) GetFunctionResultOutput

> Note: This function is named GetFunction in the Go SDK.

public static class GetFunction 
{
    public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Functions/getFunction:getFunction
  arguments:
    # arguments dictionary

The following arguments are supported:

FunctionId string

The OCID of this function.

FunctionId string

The OCID of this function.

functionId String

The OCID of this function.

functionId string

The OCID of this function.

function_id str

The OCID of this function.

functionId String

The OCID of this function.

getFunction Result

The following output properties are available:

ApplicationId string

The OCID of the application the function belongs to.

CompartmentId string

The OCID of the compartment that contains the function.

Config Dictionary<string, object>

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

The display name of the function. The display name is unique within the application containing the function.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

FunctionId string
Id string

The OCID of the function.

Image string

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

ImageDigest string

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

InvokeEndpoint string

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

MemoryInMbs string

Maximum usable memory for the function (MiB).

ProvisionedConcurrencyConfigs List<GetFunctionProvisionedConcurrencyConfig>

Define the strategy for provisioned concurrency for the function.

State string

The current state of the function.

TimeCreated string

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeUpdated string

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeoutInSeconds int

Timeout for executions of the function. Value in seconds.

TraceConfigs List<GetFunctionTraceConfig>

Define the tracing configuration for a function.

ApplicationId string

The OCID of the application the function belongs to.

CompartmentId string

The OCID of the compartment that contains the function.

Config map[string]interface{}

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

The display name of the function. The display name is unique within the application containing the function.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

FunctionId string
Id string

The OCID of the function.

Image string

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

ImageDigest string

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

InvokeEndpoint string

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

MemoryInMbs string

Maximum usable memory for the function (MiB).

ProvisionedConcurrencyConfigs []GetFunctionProvisionedConcurrencyConfig

Define the strategy for provisioned concurrency for the function.

State string

The current state of the function.

TimeCreated string

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeUpdated string

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeoutInSeconds int

Timeout for executions of the function. Value in seconds.

TraceConfigs []GetFunctionTraceConfig

Define the tracing configuration for a function.

applicationId String

The OCID of the application the function belongs to.

compartmentId String

The OCID of the compartment that contains the function.

config Map<String,Object>

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

The display name of the function. The display name is unique within the application containing the function.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

functionId String
id String

The OCID of the function.

image String

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

imageDigest String

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

invokeEndpoint String

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

memoryInMbs String

Maximum usable memory for the function (MiB).

provisionedConcurrencyConfigs List<GetFunctionProvisionedConcurrencyConfig>

Define the strategy for provisioned concurrency for the function.

state String

The current state of the function.

timeCreated String

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeUpdated String

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeoutInSeconds Integer

Timeout for executions of the function. Value in seconds.

traceConfigs List<GetFunctionTraceConfig>

Define the tracing configuration for a function.

applicationId string

The OCID of the application the function belongs to.

compartmentId string

The OCID of the compartment that contains the function.

config {[key: string]: any}

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

The display name of the function. The display name is unique within the application containing the function.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

functionId string
id string

The OCID of the function.

image string

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

imageDigest string

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

invokeEndpoint string

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

memoryInMbs string

Maximum usable memory for the function (MiB).

provisionedConcurrencyConfigs GetFunctionProvisionedConcurrencyConfig[]

Define the strategy for provisioned concurrency for the function.

state string

The current state of the function.

timeCreated string

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeUpdated string

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeoutInSeconds number

Timeout for executions of the function. Value in seconds.

traceConfigs GetFunctionTraceConfig[]

Define the tracing configuration for a function.

application_id str

The OCID of the application the function belongs to.

compartment_id str

The OCID of the compartment that contains the function.

config Mapping[str, Any]

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

The display name of the function. The display name is unique within the application containing the function.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

function_id str
id str

The OCID of the function.

image str

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

image_digest str

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

invoke_endpoint str

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

memory_in_mbs str

Maximum usable memory for the function (MiB).

provisioned_concurrency_configs GetFunctionProvisionedConcurrencyConfig]

Define the strategy for provisioned concurrency for the function.

state str

The current state of the function.

time_created str

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

time_updated str

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeout_in_seconds int

Timeout for executions of the function. Value in seconds.

trace_configs GetFunctionTraceConfig]

Define the tracing configuration for a function.

applicationId String

The OCID of the application the function belongs to.

compartmentId String

The OCID of the compartment that contains the function.

config Map<Any>

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

The display name of the function. The display name is unique within the application containing the function.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

functionId String
id String

The OCID of the function.

image String

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

imageDigest String

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

invokeEndpoint String

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

memoryInMbs String

Maximum usable memory for the function (MiB).

provisionedConcurrencyConfigs List<Property Map>

Define the strategy for provisioned concurrency for the function.

state String

The current state of the function.

timeCreated String

The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeUpdated String

The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

timeoutInSeconds Number

Timeout for executions of the function. Value in seconds.

traceConfigs List<Property Map>

Define the tracing configuration for a function.

Supporting Types

GetFunctionProvisionedConcurrencyConfig

Count int
Strategy string

The strategy for provisioned concurrency to be used.

Count int
Strategy string

The strategy for provisioned concurrency to be used.

count Integer
strategy String

The strategy for provisioned concurrency to be used.

count number
strategy string

The strategy for provisioned concurrency to be used.

count int
strategy str

The strategy for provisioned concurrency to be used.

count Number
strategy String

The strategy for provisioned concurrency to be used.

GetFunctionTraceConfig

IsEnabled bool

Define if tracing is enabled for the resource.

IsEnabled bool

Define if tracing is enabled for the resource.

isEnabled Boolean

Define if tracing is enabled for the resource.

isEnabled boolean

Define if tracing is enabled for the resource.

is_enabled bool

Define if tracing is enabled for the resource.

isEnabled Boolean

Define if tracing is enabled for the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.