Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.Identity.getDynamicGroups

This data source provides the list of Dynamic Groups in Oracle Cloud Infrastructure Identity service.

Lists the dynamic groups in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDynamicGroups = Oci.Identity.GetDynamicGroups.Invoke(new()
    {
        CompartmentId = @var.Tenancy_ocid,
        Name = @var.Dynamic_group_name,
        State = @var.Dynamic_group_state,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Identity.GetDynamicGroups(ctx, &identity.GetDynamicGroupsArgs{
			CompartmentId: _var.Tenancy_ocid,
			Name:          pulumi.StringRef(_var.Dynamic_group_name),
			State:         pulumi.StringRef(_var.Dynamic_group_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.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetDynamicGroupsArgs;
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 testDynamicGroups = IdentityFunctions.getDynamicGroups(GetDynamicGroupsArgs.builder()
            .compartmentId(var_.tenancy_ocid())
            .name(var_.dynamic_group_name())
            .state(var_.dynamic_group_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_dynamic_groups = oci.Identity.get_dynamic_groups(compartment_id=var["tenancy_ocid"],
    name=var["dynamic_group_name"],
    state=var["dynamic_group_state"])

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

const testDynamicGroups = oci.Identity.getDynamicGroups({
    compartmentId: _var.tenancy_ocid,
    name: _var.dynamic_group_name,
    state: _var.dynamic_group_state,
});

variables:
  testDynamicGroups:
    fn::invoke:
      Function: oci:Identity:getDynamicGroups
      Arguments:
        compartmentId: ${var.tenancy_ocid}
        name: ${var.dynamic_group_name}
        state: ${var.dynamic_group_state}

Using getDynamicGroups

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 getDynamicGroups(args: GetDynamicGroupsArgs, opts?: InvokeOptions): Promise<GetDynamicGroupsResult>
function getDynamicGroupsOutput(args: GetDynamicGroupsOutputArgs, opts?: InvokeOptions): Output<GetDynamicGroupsResult>

def get_dynamic_groups(compartment_id: Optional[str] = None,
                       filters: Optional[Sequence[_identity.GetDynamicGroupsFilter]] = None,
                       name: Optional[str] = None,
                       state: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDynamicGroupsResult
def get_dynamic_groups_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetDynamicGroupsFilterArgs]]]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       state: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDynamicGroupsResult]

func GetDynamicGroups(ctx *Context, args *GetDynamicGroupsArgs, opts ...InvokeOption) (*GetDynamicGroupsResult, error)
func GetDynamicGroupsOutput(ctx *Context, args *GetDynamicGroupsOutputArgs, opts ...InvokeOption) GetDynamicGroupsResultOutput

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

public static class GetDynamicGroups 
{
    public static Task<GetDynamicGroupsResult> InvokeAsync(GetDynamicGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetDynamicGroupsResult> Invoke(GetDynamicGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDynamicGroupsResult> getDynamicGroups(GetDynamicGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Identity/getDynamicGroups:getDynamicGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Filters List<GetDynamicGroupsFilter>
Name string: A filter to only return resources that match the given name exactly.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Filters []GetDynamicGroupsFilter
Name string: A filter to only return resources that match the given name exactly.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters List<GetDynamicGroupsFilter>
name String: A filter to only return resources that match the given name exactly.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters GetDynamicGroupsFilter[]
name string: A filter to only return resources that match the given name exactly.
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters GetDynamicGroupsFilter]
name str: A filter to only return resources that match the given name exactly.
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters List<Property Map>
name String: A filter to only return resources that match the given name exactly.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

getDynamicGroups Result

The following output properties are available:

CompartmentId string: The OCID of the tenancy containing the group.
DynamicGroups List<GetDynamicGroupsDynamicGroup>: The list of dynamic_groups.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetDynamicGroupsFilter>
Name string: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
State string: The group's current state.

CompartmentId string: The OCID of the tenancy containing the group.
DynamicGroups []GetDynamicGroupsDynamicGroup: The list of dynamic_groups.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetDynamicGroupsFilter
Name string: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
State string: The group's current state.

compartmentId String: The OCID of the tenancy containing the group.
dynamicGroups List<GetDynamicGroupsDynamicGroup>: The list of dynamic_groups.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetDynamicGroupsFilter>
name String: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
state String: The group's current state.

compartmentId string: The OCID of the tenancy containing the group.
dynamicGroups GetDynamicGroupsDynamicGroup[]: The list of dynamic_groups.
id string: The provider-assigned unique ID for this managed resource.
filters GetDynamicGroupsFilter[]
name string: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
state string: The group's current state.

compartment_id str: The OCID of the tenancy containing the group.
dynamic_groups GetDynamicGroupsDynamicGroup]: The list of dynamic_groups.
id str: The provider-assigned unique ID for this managed resource.
filters GetDynamicGroupsFilter]
name str: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
state str: The group's current state.

compartmentId String: The OCID of the tenancy containing the group.
dynamicGroups List<Property Map>: The list of dynamic_groups.
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>
name String: The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
state String: The group's current state.

Supporting Types

GetDynamicGroupsDynamicGroup

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
Description string: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
Id string: The OCID of the group.
InactiveState string: The detailed status of INACTIVE lifecycleState.
MatchingRule string: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
Name string: A filter to only return resources that match the given name exactly.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
Description string: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
Id string: The OCID of the group.
InactiveState string: The detailed status of INACTIVE lifecycleState.
MatchingRule string: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
Name string: A filter to only return resources that match the given name exactly.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
description String: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
id String: The OCID of the group.
inactiveState String: The detailed status of INACTIVE lifecycleState.
matchingRule String: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
name String: A filter to only return resources that match the given name exactly.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
description string: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
id string: The OCID of the group.
inactiveState string: The detailed status of INACTIVE lifecycleState.
matchingRule string: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
name string: A filter to only return resources that match the given name exactly.
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated string: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
description str: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
id str: The OCID of the group.
inactive_state str: The detailed status of INACTIVE lifecycleState.
matching_rule str: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
name str: A filter to only return resources that match the given name exactly.
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
time_created str: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
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"}
description String: The description you assign to the group. Does not have to be unique, and it's changeable.
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"}
id String: The OCID of the group.
inactiveState String: The detailed status of INACTIVE lifecycleState.
matchingRule String: A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
name String: A filter to only return resources that match the given name exactly.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

GetDynamicGroupsFilter

Name string: A filter to only return resources that match the given name exactly.
Values List<string>
Regex bool

Name string: A filter to only return resources that match the given name exactly.
Values []string
Regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

name string: A filter to only return resources that match the given name exactly.
values string[]
regex boolean

name str: A filter to only return resources that match the given name exactly.
values Sequence[str]
regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

Package Details

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