Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.FleetAppsManagement.getOnboardings

Start a Neo task

Explain and create an oci.FleetAppsManagement.getOnboardings resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testOnboardings = oci.FleetAppsManagement.getOnboardings({
    compartmentId: compartmentId,
    id: onboardingId,
    state: onboardingState,
});

import pulumi
import pulumi_oci as oci

test_onboardings = oci.FleetAppsManagement.get_onboardings(compartment_id=compartment_id,
    id=onboarding_id,
    state=onboarding_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fleetappsmanagement.GetOnboardings(ctx, &fleetappsmanagement.GetOnboardingsArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			Id:            pulumi.StringRef(onboardingId),
			State:         pulumi.StringRef(onboardingState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testOnboardings = Oci.FleetAppsManagement.GetOnboardings.Invoke(new()
    {
        CompartmentId = compartmentId,
        Id = onboardingId,
        State = onboardingState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FleetAppsManagement.FleetAppsManagementFunctions;
import com.pulumi.oci.FleetAppsManagement.inputs.GetOnboardingsArgs;
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 testOnboardings = FleetAppsManagementFunctions.getOnboardings(GetOnboardingsArgs.builder()
            .compartmentId(compartmentId)
            .id(onboardingId)
            .state(onboardingState)
            .build());

    }
}

variables:
  testOnboardings:
    fn::invoke:
      function: oci:FleetAppsManagement:getOnboardings
      arguments:
        compartmentId: ${compartmentId}
        id: ${onboardingId}
        state: ${onboardingState}

Using getOnboardings

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 getOnboardings(args: GetOnboardingsArgs, opts?: InvokeOptions): Promise<GetOnboardingsResult>
function getOnboardingsOutput(args: GetOnboardingsOutputArgs, opts?: InvokeOptions): Output<GetOnboardingsResult>

def get_onboardings(compartment_id: Optional[str] = None,
                    filters: Optional[Sequence[GetOnboardingsFilter]] = None,
                    id: Optional[str] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetOnboardingsResult
def get_onboardings_output(compartment_id: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetOnboardingsFilterArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetOnboardingsResult]

func GetOnboardings(ctx *Context, args *GetOnboardingsArgs, opts ...InvokeOption) (*GetOnboardingsResult, error)
func GetOnboardingsOutput(ctx *Context, args *GetOnboardingsOutputArgs, opts ...InvokeOption) GetOnboardingsResultOutput

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

public static class GetOnboardings 
{
    public static Task<GetOnboardingsResult> InvokeAsync(GetOnboardingsArgs args, InvokeOptions? opts = null)
    public static Output<GetOnboardingsResult> Invoke(GetOnboardingsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOnboardingsResult> getOnboardings(GetOnboardingsArgs args, InvokeOptions options)
public static Output<GetOnboardingsResult> getOnboardings(GetOnboardingsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:FleetAppsManagement/getOnboardings:getOnboardings
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
Filters List<GetOnboardingsFilter>
Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

CompartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
Filters []GetOnboardingsFilter
Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
filters List<GetOnboardingsFilter>
id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
filters GetOnboardingsFilter[]
id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
state string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartment_id str: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
filters Sequence[GetOnboardingsFilter]
id str: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
state str: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
filters List<Property Map>
id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.

getOnboardings Result

The following output properties are available:

OnboardingCollections List<GetOnboardingsOnboardingCollection>: The list of onboarding_collection.
CompartmentId string: Tenancy OCID
Filters List<GetOnboardingsFilter>
Id string: The unique id of the resource.
State string: The current state of the Onboarding.

OnboardingCollections []GetOnboardingsOnboardingCollection: The list of onboarding_collection.
CompartmentId string: Tenancy OCID
Filters []GetOnboardingsFilter
Id string: The unique id of the resource.
State string: The current state of the Onboarding.

onboardingCollections List<GetOnboardingsOnboardingCollection>: The list of onboarding_collection.
compartmentId String: Tenancy OCID
filters List<GetOnboardingsFilter>
id String: The unique id of the resource.
state String: The current state of the Onboarding.

onboardingCollections GetOnboardingsOnboardingCollection[]: The list of onboarding_collection.
compartmentId string: Tenancy OCID
filters GetOnboardingsFilter[]
id string: The unique id of the resource.
state string: The current state of the Onboarding.

onboarding_collections Sequence[GetOnboardingsOnboardingCollection]: The list of onboarding_collection.
compartment_id str: Tenancy OCID
filters Sequence[GetOnboardingsFilter]
id str: The unique id of the resource.
state str: The current state of the Onboarding.

onboardingCollections List<Property Map>: The list of onboarding_collection.
compartmentId String: Tenancy OCID
filters List<Property Map>
id String: The unique id of the resource.
state String: The current state of the Onboarding.

Supporting Types

GetOnboardingsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetOnboardingsOnboardingCollection

Items List<GetOnboardingsOnboardingCollectionItem>: List of Fleet Application Management Onboardings.

Items []GetOnboardingsOnboardingCollectionItem: List of Fleet Application Management Onboardings.

items List<GetOnboardingsOnboardingCollectionItem>: List of Fleet Application Management Onboardings.

items GetOnboardingsOnboardingCollectionItem[]: List of Fleet Application Management Onboardings.

items Sequence[GetOnboardingsOnboardingCollectionItem]: List of Fleet Application Management Onboardings.

items List<Property Map>: List of Fleet Application Management Onboardings.

GetOnboardingsOnboardingCollectionItem

AppliedPolicies List<GetOnboardingsOnboardingCollectionItemAppliedPolicy>: Summary of the Fleet Application Management Onboard Policy.
CompartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DiscoveryFrequency string: Provide discovery frequency.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
IsCostTrackingTagEnabled bool: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
IsFamsTagEnabled bool: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
ResourceRegion string: Associated region
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
Version string: The version of Fleet Application Management that the tenant is onboarded to.

AppliedPolicies []GetOnboardingsOnboardingCollectionItemAppliedPolicy: Summary of the Fleet Application Management Onboard Policy.
CompartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DiscoveryFrequency string: Provide discovery frequency.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
IsCostTrackingTagEnabled bool: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
IsFamsTagEnabled bool: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
ResourceRegion string: Associated region
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
Version string: The version of Fleet Application Management that the tenant is onboarded to.

appliedPolicies List<GetOnboardingsOnboardingCollectionItemAppliedPolicy>: Summary of the Fleet Application Management Onboard Policy.
compartmentId String: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
discoveryFrequency String: Provide discovery frequency.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
isCostTrackingTagEnabled Boolean: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
isFamsTagEnabled Boolean: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
resourceRegion String: Associated region
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
version String: The version of Fleet Application Management that the tenant is onboarded to.

appliedPolicies GetOnboardingsOnboardingCollectionItemAppliedPolicy[]: Summary of the Fleet Application Management Onboard Policy.
compartmentId string: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
discoveryFrequency string: Provide discovery frequency.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
isCostTrackingTagEnabled boolean: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
isFamsTagEnabled boolean: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
resourceRegion string: Associated region
state string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
version string: The version of Fleet Application Management that the tenant is onboarded to.

applied_policies Sequence[GetOnboardingsOnboardingCollectionItemAppliedPolicy]: Summary of the Fleet Application Management Onboard Policy.
compartment_id str: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
discovery_frequency str: Provide discovery frequency.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
is_cost_tracking_tag_enabled bool: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
is_fams_tag_enabled bool: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
resource_region str: Associated region
state str: A filter to return only resources whose lifecycleState matches the given lifecycleState.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
time_updated str: The time this resource was last updated. An RFC3339 formatted datetime string.
version str: The version of Fleet Application Management that the tenant is onboarded to.

appliedPolicies List<Property Map>: Summary of the Fleet Application Management Onboard Policy.
compartmentId String: The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
discoveryFrequency String: Provide discovery frequency.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
isCostTrackingTagEnabled Boolean: A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.
isFamsTagEnabled Boolean: A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.
resourceRegion String: Associated region
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
version String: The version of Fleet Application Management that the tenant is onboarded to.

GetOnboardingsOnboardingCollectionItemAppliedPolicy

Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
Statements List<string>: Policy statements.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

Id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
Statements []string: Policy statements.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
statements List<String>: Policy statements.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

id string: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
statements string[]: Policy statements.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

id str: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
statements Sequence[str]: Policy statements.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
time_updated str: The time this resource was last updated. An RFC3339 formatted datetime string.

id String: Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.
statements List<String>: Policy statements.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.FleetAppsManagement.getOnboardings

On this page

On this page

Example Usage

Using getOnboardings

getOnboardings Result

Supporting Types

GetOnboardingsFilter

GetOnboardingsOnboardingCollection

GetOnboardingsOnboardingCollectionItem

GetOnboardingsOnboardingCollectionItemAppliedPolicy

Package Details

On this page

On this page