1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Functions
  5. getFusionEnvironmentFamilies
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Functions.getFusionEnvironmentFamilies

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Fusion Environment Families in Oracle Cloud Infrastructure Fusion Apps service.

Returns a list of FusionEnvironmentFamilies.

Example Usage

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

const testFusionEnvironmentFamilies = oci.Functions.getFusionEnvironmentFamilies({
    compartmentId: compartmentId,
    displayName: fusionEnvironmentFamilyDisplayName,
    fusionEnvironmentFamilyId: testFusionEnvironmentFamily.id,
    state: fusionEnvironmentFamilyState,
});
Copy
import pulumi
import pulumi_oci as oci

test_fusion_environment_families = oci.Functions.get_fusion_environment_families(compartment_id=compartment_id,
    display_name=fusion_environment_family_display_name,
    fusion_environment_family_id=test_fusion_environment_family["id"],
    state=fusion_environment_family_state)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := functions.GetFusionEnvironmentFamilies(ctx, &functions.GetFusionEnvironmentFamiliesArgs{
			CompartmentId:             compartmentId,
			DisplayName:               pulumi.StringRef(fusionEnvironmentFamilyDisplayName),
			FusionEnvironmentFamilyId: pulumi.StringRef(testFusionEnvironmentFamily.Id),
			State:                     pulumi.StringRef(fusionEnvironmentFamilyState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testFusionEnvironmentFamilies = Oci.Functions.GetFusionEnvironmentFamilies.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = fusionEnvironmentFamilyDisplayName,
        FusionEnvironmentFamilyId = testFusionEnvironmentFamily.Id,
        State = fusionEnvironmentFamilyState,
    });

});
Copy
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.GetFusionEnvironmentFamiliesArgs;
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 testFusionEnvironmentFamilies = FunctionsFunctions.getFusionEnvironmentFamilies(GetFusionEnvironmentFamiliesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(fusionEnvironmentFamilyDisplayName)
            .fusionEnvironmentFamilyId(testFusionEnvironmentFamily.id())
            .state(fusionEnvironmentFamilyState)
            .build());

    }
}
Copy
variables:
  testFusionEnvironmentFamilies:
    fn::invoke:
      function: oci:Functions:getFusionEnvironmentFamilies
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${fusionEnvironmentFamilyDisplayName}
        fusionEnvironmentFamilyId: ${testFusionEnvironmentFamily.id}
        state: ${fusionEnvironmentFamilyState}
Copy

Using getFusionEnvironmentFamilies

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 getFusionEnvironmentFamilies(args: GetFusionEnvironmentFamiliesArgs, opts?: InvokeOptions): Promise<GetFusionEnvironmentFamiliesResult>
function getFusionEnvironmentFamiliesOutput(args: GetFusionEnvironmentFamiliesOutputArgs, opts?: InvokeOptions): Output<GetFusionEnvironmentFamiliesResult>
Copy
def get_fusion_environment_families(compartment_id: Optional[str] = None,
                                    display_name: Optional[str] = None,
                                    filters: Optional[Sequence[_functions.GetFusionEnvironmentFamiliesFilter]] = None,
                                    fusion_environment_family_id: Optional[str] = None,
                                    state: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetFusionEnvironmentFamiliesResult
def get_fusion_environment_families_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                    display_name: Optional[pulumi.Input[str]] = None,
                                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_functions.GetFusionEnvironmentFamiliesFilterArgs]]]] = None,
                                    fusion_environment_family_id: Optional[pulumi.Input[str]] = None,
                                    state: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetFusionEnvironmentFamiliesResult]
Copy
func GetFusionEnvironmentFamilies(ctx *Context, args *GetFusionEnvironmentFamiliesArgs, opts ...InvokeOption) (*GetFusionEnvironmentFamiliesResult, error)
func GetFusionEnvironmentFamiliesOutput(ctx *Context, args *GetFusionEnvironmentFamiliesOutputArgs, opts ...InvokeOption) GetFusionEnvironmentFamiliesResultOutput
Copy

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

public static class GetFusionEnvironmentFamilies 
{
    public static Task<GetFusionEnvironmentFamiliesResult> InvokeAsync(GetFusionEnvironmentFamiliesArgs args, InvokeOptions? opts = null)
    public static Output<GetFusionEnvironmentFamiliesResult> Invoke(GetFusionEnvironmentFamiliesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFusionEnvironmentFamiliesResult> getFusionEnvironmentFamilies(GetFusionEnvironmentFamiliesArgs args, InvokeOptions options)
public static Output<GetFusionEnvironmentFamiliesResult> getFusionEnvironmentFamilies(GetFusionEnvironmentFamiliesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Functions/getFusionEnvironmentFamilies:getFusionEnvironmentFamilies
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetFusionEnvironmentFamiliesFilter>
FusionEnvironmentFamilyId string
The ID of the fusion environment family in which to list resources.
State string
A filter that returns all resources that match the specified lifecycle state.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetFusionEnvironmentFamiliesFilter
FusionEnvironmentFamilyId string
The ID of the fusion environment family in which to list resources.
State string
A filter that returns all resources that match the specified lifecycle state.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetFusionEnvironmentFamiliesFilter>
fusionEnvironmentFamilyId String
The ID of the fusion environment family in which to list resources.
state String
A filter that returns all resources that match the specified lifecycle state.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetFusionEnvironmentFamiliesFilter[]
fusionEnvironmentFamilyId string
The ID of the fusion environment family in which to list resources.
state string
A filter that returns all resources that match the specified lifecycle state.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
display_name str
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. Sequence[functions.GetFusionEnvironmentFamiliesFilter]
fusion_environment_family_id str
The ID of the fusion environment family in which to list resources.
state str
A filter that returns all resources that match the specified lifecycle state.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>
fusionEnvironmentFamilyId String
The ID of the fusion environment family in which to list resources.
state String
A filter that returns all resources that match the specified lifecycle state.

getFusionEnvironmentFamilies Result

The following output properties are available:

CompartmentId string
The OCID of the compartment where the environment family is located.
FusionEnvironmentFamilyCollections List<GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection>
The list of fusion_environment_family_collection.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
Filters List<GetFusionEnvironmentFamiliesFilter>
FusionEnvironmentFamilyId string
State string
The current state of the FusionEnvironmentFamily.
CompartmentId string
The OCID of the compartment where the environment family is located.
FusionEnvironmentFamilyCollections []GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection
The list of fusion_environment_family_collection.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
Filters []GetFusionEnvironmentFamiliesFilter
FusionEnvironmentFamilyId string
State string
The current state of the FusionEnvironmentFamily.
compartmentId String
The OCID of the compartment where the environment family is located.
fusionEnvironmentFamilyCollections List<GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection>
The list of fusion_environment_family_collection.
id String
The provider-assigned unique ID for this managed resource.
displayName String
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
filters List<GetFusionEnvironmentFamiliesFilter>
fusionEnvironmentFamilyId String
state String
The current state of the FusionEnvironmentFamily.
compartmentId string
The OCID of the compartment where the environment family is located.
fusionEnvironmentFamilyCollections GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection[]
The list of fusion_environment_family_collection.
id string
The provider-assigned unique ID for this managed resource.
displayName string
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
filters GetFusionEnvironmentFamiliesFilter[]
fusionEnvironmentFamilyId string
state string
The current state of the FusionEnvironmentFamily.
compartment_id str
The OCID of the compartment where the environment family is located.
fusion_environment_family_collections Sequence[functions.GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection]
The list of fusion_environment_family_collection.
id str
The provider-assigned unique ID for this managed resource.
display_name str
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
filters Sequence[functions.GetFusionEnvironmentFamiliesFilter]
fusion_environment_family_id str
state str
The current state of the FusionEnvironmentFamily.
compartmentId String
The OCID of the compartment where the environment family is located.
fusionEnvironmentFamilyCollections List<Property Map>
The list of fusion_environment_family_collection.
id String
The provider-assigned unique ID for this managed resource.
displayName String
A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
filters List<Property Map>
fusionEnvironmentFamilyId String
state String
The current state of the FusionEnvironmentFamily.

Supporting Types

GetFusionEnvironmentFamiliesFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection

items This property is required. List<Property Map>

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FamilyMaintenancePolicies This property is required. List<GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy>
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
FreeformTags This property is required. 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 This property is required. string
The unique identifier (OCID) of the environment family. Can't be changed after creation.
IsSubscriptionUpdateNeeded This property is required. bool
When set to True, a subscription update is required for the environment family.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State This property is required. string
A filter that returns all resources that match the specified lifecycle state.
SubscriptionIds This property is required. List<string>
The list of the IDs of the applications subscriptions that are associated with the environment family.
SystemName This property is required. string
Environment Specific Guid/ System Name
TimeCreated This property is required. string
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
TimeUpdated This property is required. string
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FamilyMaintenancePolicies This property is required. []GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
FreeformTags This property is required. 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 This property is required. string
The unique identifier (OCID) of the environment family. Can't be changed after creation.
IsSubscriptionUpdateNeeded This property is required. bool
When set to True, a subscription update is required for the environment family.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State This property is required. string
A filter that returns all resources that match the specified lifecycle state.
SubscriptionIds This property is required. []string
The list of the IDs of the applications subscriptions that are associated with the environment family.
SystemName This property is required. string
Environment Specific Guid/ System Name
TimeCreated This property is required. string
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
TimeUpdated This property is required. string
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
familyMaintenancePolicies This property is required. List<GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy>
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
freeformTags This property is required. 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 This property is required. String
The unique identifier (OCID) of the environment family. Can't be changed after creation.
isSubscriptionUpdateNeeded This property is required. Boolean
When set to True, a subscription update is required for the environment family.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state This property is required. String
A filter that returns all resources that match the specified lifecycle state.
subscriptionIds This property is required. List<String>
The list of the IDs of the applications subscriptions that are associated with the environment family.
systemName This property is required. String
Environment Specific Guid/ System Name
timeCreated This property is required. String
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. String
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
A filter to return only resources that match the entire display name given.
familyMaintenancePolicies This property is required. GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy[]
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
freeformTags This property is required. {[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 This property is required. string
The unique identifier (OCID) of the environment family. Can't be changed after creation.
isSubscriptionUpdateNeeded This property is required. boolean
When set to True, a subscription update is required for the environment family.
lifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state This property is required. string
A filter that returns all resources that match the specified lifecycle state.
subscriptionIds This property is required. string[]
The list of the IDs of the applications subscriptions that are associated with the environment family.
systemName This property is required. string
Environment Specific Guid/ System Name
timeCreated This property is required. string
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. string
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name This property is required. str
A filter to return only resources that match the entire display name given.
family_maintenance_policies This property is required. Sequence[functions.GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy]
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
freeform_tags This property is required. 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 This property is required. str
The unique identifier (OCID) of the environment family. Can't be changed after creation.
is_subscription_update_needed This property is required. bool
When set to True, a subscription update is required for the environment family.
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state This property is required. str
A filter that returns all resources that match the specified lifecycle state.
subscription_ids This property is required. Sequence[str]
The list of the IDs of the applications subscriptions that are associated with the environment family.
system_name This property is required. str
Environment Specific Guid/ System Name
time_created This property is required. str
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
time_updated This property is required. str
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
familyMaintenancePolicies This property is required. List<Property Map>
The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
freeformTags This property is required. 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 This property is required. String
The unique identifier (OCID) of the environment family. Can't be changed after creation.
isSubscriptionUpdateNeeded This property is required. Boolean
When set to True, a subscription update is required for the environment family.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state This property is required. String
A filter that returns all resources that match the specified lifecycle state.
subscriptionIds This property is required. List<String>
The list of the IDs of the applications subscriptions that are associated with the environment family.
systemName This property is required. String
Environment Specific Guid/ System Name
timeCreated This property is required. String
The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. String

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy

ConcurrentMaintenance This property is required. string
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
IsMonthlyPatchingEnabled This property is required. bool
When True, monthly patching is enabled for the environment family.
QuarterlyUpgradeBeginTimes This property is required. string
The quarterly maintenance month group schedule of the Fusion environment family.
ConcurrentMaintenance This property is required. string
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
IsMonthlyPatchingEnabled This property is required. bool
When True, monthly patching is enabled for the environment family.
QuarterlyUpgradeBeginTimes This property is required. string
The quarterly maintenance month group schedule of the Fusion environment family.
concurrentMaintenance This property is required. String
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
isMonthlyPatchingEnabled This property is required. Boolean
When True, monthly patching is enabled for the environment family.
quarterlyUpgradeBeginTimes This property is required. String
The quarterly maintenance month group schedule of the Fusion environment family.
concurrentMaintenance This property is required. string
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
isMonthlyPatchingEnabled This property is required. boolean
When True, monthly patching is enabled for the environment family.
quarterlyUpgradeBeginTimes This property is required. string
The quarterly maintenance month group schedule of the Fusion environment family.
concurrent_maintenance This property is required. str
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
is_monthly_patching_enabled This property is required. bool
When True, monthly patching is enabled for the environment family.
quarterly_upgrade_begin_times This property is required. str
The quarterly maintenance month group schedule of the Fusion environment family.
concurrentMaintenance This property is required. String
Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
isMonthlyPatchingEnabled This property is required. Boolean
When True, monthly patching is enabled for the environment family.
quarterlyUpgradeBeginTimes This property is required. String
The quarterly maintenance month group schedule of the Fusion environment family.

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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi