Oracle Cloud Infrastructure

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

getFusionEnvironmentFamilies

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

Returns a list of FusionEnvironmentFamilies.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testFusionEnvironmentFamilies = Oci.Functions.GetFusionEnvironmentFamilies.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Fusion_environment_family_display_name,
        FusionEnvironmentFamilyId = oci_fusion_apps_fusion_environment_family.Test_fusion_environment_family.Id,
        State = @var.Fusion_environment_family_state,
    });

});
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.GetFusionEnvironmentFamilies(ctx, &functions.GetFusionEnvironmentFamiliesArgs{
			CompartmentId:             _var.Compartment_id,
			DisplayName:               pulumi.StringRef(_var.Fusion_environment_family_display_name),
			FusionEnvironmentFamilyId: pulumi.StringRef(oci_fusion_apps_fusion_environment_family.Test_fusion_environment_family.Id),
			State:                     pulumi.StringRef(_var.Fusion_environment_family_state),
		}, 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.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(var_.compartment_id())
            .displayName(var_.fusion_environment_family_display_name())
            .fusionEnvironmentFamilyId(oci_fusion_apps_fusion_environment_family.test_fusion_environment_family().id())
            .state(var_.fusion_environment_family_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_fusion_environment_families = oci.Functions.get_fusion_environment_families(compartment_id=var["compartment_id"],
    display_name=var["fusion_environment_family_display_name"],
    fusion_environment_family_id=oci_fusion_apps_fusion_environment_family["test_fusion_environment_family"]["id"],
    state=var["fusion_environment_family_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testFusionEnvironmentFamilies = oci.Functions.getFusionEnvironmentFamilies({
    compartmentId: _var.compartment_id,
    displayName: _var.fusion_environment_family_display_name,
    fusionEnvironmentFamilyId: oci_fusion_apps_fusion_environment_family.test_fusion_environment_family.id,
    state: _var.fusion_environment_family_state,
});
variables:
  testFusionEnvironmentFamilies:
    Fn::Invoke:
      Function: oci:Functions:getFusionEnvironmentFamilies
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.fusion_environment_family_display_name}
        fusionEnvironmentFamilyId: ${oci_fusion_apps_fusion_environment_family.test_fusion_environment_family.id}
        state: ${var.fusion_environment_family_state}

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>
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]
func GetFusionEnvironmentFamilies(ctx *Context, args *GetFusionEnvironmentFamiliesArgs, opts ...InvokeOption) (*GetFusionEnvironmentFamiliesResult, error)
func GetFusionEnvironmentFamiliesOutput(ctx *Context, args *GetFusionEnvironmentFamiliesOutputArgs, opts ...InvokeOption) GetFusionEnvironmentFamiliesResultOutput

> 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)
}
public static CompletableFuture<GetFusionEnvironmentFamiliesResult> getFusionEnvironmentFamilies(GetFusionEnvironmentFamiliesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Functions/getFusionEnvironmentFamilies:getFusionEnvironmentFamilies
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId 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 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 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 []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 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 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 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 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 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 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 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 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 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 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 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

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItem

CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

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

FamilyMaintenancePolicies 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 Dictionary<string, object>

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

IsSubscriptionUpdateNeeded bool

When set to True, a subscription update is required for the environment family.

LifecycleDetails 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 string

A filter that returns all resources that match the specified lifecycle state.

SubscriptionIds List<string>

The list of the IDs of the applications subscriptions that are associated with the environment family.

SystemName string

Environment Specific Guid/ System Name

TimeCreated string

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

TimeUpdated string
CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

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

FamilyMaintenancePolicies []GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy

The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.

FreeformTags map[string]interface{}

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

IsSubscriptionUpdateNeeded bool

When set to True, a subscription update is required for the environment family.

LifecycleDetails 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 string

A filter that returns all resources that match the specified lifecycle state.

SubscriptionIds []string

The list of the IDs of the applications subscriptions that are associated with the environment family.

SystemName string

Environment Specific Guid/ System Name

TimeCreated string

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

TimeUpdated string
compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

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

familyMaintenancePolicies 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 Map<String,Object>

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

isSubscriptionUpdateNeeded Boolean

When set to True, a subscription update is required for the environment family.

lifecycleDetails 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 String

A filter that returns all resources that match the specified lifecycle state.

subscriptionIds List<String>

The list of the IDs of the applications subscriptions that are associated with the environment family.

systemName String

Environment Specific Guid/ System Name

timeCreated String

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

timeUpdated String
compartmentId string

The ID of the compartment in which to list resources.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

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

familyMaintenancePolicies GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy[]

The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.

freeformTags {[key: string]: any}

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

isSubscriptionUpdateNeeded boolean

When set to True, a subscription update is required for the environment family.

lifecycleDetails 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 string

A filter that returns all resources that match the specified lifecycle state.

subscriptionIds string[]

The list of the IDs of the applications subscriptions that are associated with the environment family.

systemName string

Environment Specific Guid/ System Name

timeCreated string

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

timeUpdated string
compartment_id str

The ID of the compartment in which to list resources.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

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

family_maintenance_policies 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 Mapping[str, Any]

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

is_subscription_update_needed bool

When set to True, a subscription update is required for the environment family.

lifecycle_details 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 str

A filter that returns all resources that match the specified lifecycle state.

subscription_ids Sequence[str]

The list of the IDs of the applications subscriptions that are associated with the environment family.

system_name str

Environment Specific Guid/ System Name

time_created str

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

time_updated str
compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

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

familyMaintenancePolicies 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 Map<Any>

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

The unique identifier (OCID) of the environment family. Can't be changed after creation.

isSubscriptionUpdateNeeded Boolean

When set to True, a subscription update is required for the environment family.

lifecycleDetails 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 String

A filter that returns all resources that match the specified lifecycle state.

subscriptionIds List<String>

The list of the IDs of the applications subscriptions that are associated with the environment family.

systemName String

Environment Specific Guid/ System Name

timeCreated String

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

timeUpdated String

GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy

ConcurrentMaintenance 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 bool

When True, monthly patching is enabled for the environment family.

QuarterlyUpgradeBeginTimes string

The quarterly maintenance month group schedule of the Fusion environment family.

ConcurrentMaintenance 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 bool

When True, monthly patching is enabled for the environment family.

QuarterlyUpgradeBeginTimes string

The quarterly maintenance month group schedule of the Fusion environment family.

concurrentMaintenance 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 Boolean

When True, monthly patching is enabled for the environment family.

quarterlyUpgradeBeginTimes String

The quarterly maintenance month group schedule of the Fusion environment family.

concurrentMaintenance 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 boolean

When True, monthly patching is enabled for the environment family.

quarterlyUpgradeBeginTimes string

The quarterly maintenance month group schedule of the Fusion environment family.

concurrent_maintenance 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 bool

When True, monthly patching is enabled for the environment family.

quarterly_upgrade_begin_times str

The quarterly maintenance month group schedule of the Fusion environment family.

concurrentMaintenance 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 Boolean

When True, monthly patching is enabled for the environment family.

quarterlyUpgradeBeginTimes String

The quarterly maintenance month group schedule of the Fusion environment family.

Package Details

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

This Pulumi package is based on the oci Terraform Provider.