Oracle Cloud Infrastructure v2.31.0, Apr 17 25

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

oci.Identity.getGroups

Explore with Pulumi AI

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

Example Usage

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

const testGroups = oci.Identity.getGroups({
    compartmentId: tenancyOcid,
    name: groupName,
    state: groupState,
});

import pulumi
import pulumi_oci as oci

test_groups = oci.Identity.get_groups(compartment_id=tenancy_ocid,
    name=group_name,
    state=group_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.GetGroups(ctx, &identity.GetGroupsArgs{
			CompartmentId: tenancyOcid,
			Name:          pulumi.StringRef(groupName),
			State:         pulumi.StringRef(groupState),
		}, 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 testGroups = Oci.Identity.GetGroups.Invoke(new()
    {
        CompartmentId = tenancyOcid,
        Name = groupName,
        State = groupState,
    });

});

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.GetGroupsArgs;
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 testGroups = IdentityFunctions.getGroups(GetGroupsArgs.builder()
            .compartmentId(tenancyOcid)
            .name(groupName)
            .state(groupState)
            .build());

    }
}

variables:
  testGroups:
    fn::invoke:
      function: oci:Identity:getGroups
      arguments:
        compartmentId: ${tenancyOcid}
        name: ${groupName}
        state: ${groupState}

Using getGroups

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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>

def get_groups(compartment_id: Optional[str] = None,
               filters: Optional[Sequence[_identity.GetGroupsFilter]] = None,
               name: Optional[str] = None,
               state: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(compartment_id: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetGroupsFilterArgs]]]] = None,
               name: Optional[pulumi.Input[str]] = None,
               state: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]

func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

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

public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Identity/getGroups:getGroups
  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<GetGroupsFilter>
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 []GetGroupsFilter
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<GetGroupsFilter>
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 GetGroupsFilter[]
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 Sequence[identity.GetGroupsFilter]
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.

getGroups Result

The following output properties are available:

CompartmentId string: The OCID of the tenancy containing the group.
Groups List<GetGroupsGroup>: The list of groups.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetGroupsFilter>
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.
Groups []GetGroupsGroup: The list of groups.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetGroupsFilter
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.
groups List<GetGroupsGroup>: The list of groups.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetGroupsFilter>
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.
groups GetGroupsGroup[]: The list of groups.
id string: The provider-assigned unique ID for this managed resource.
filters GetGroupsFilter[]
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.
groups Sequence[identity.GetGroupsGroup]: The list of groups.
id str: The provider-assigned unique ID for this managed resource.
filters Sequence[identity.GetGroupsFilter]
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.
groups List<Property Map>: The list of 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

GetGroupsFilter

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

GetGroupsGroup

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
DefinedTags Dictionary<string, string>: 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, string>: 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.
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]string: 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]string: 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.
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,String>: 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,String>: 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.
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]: string}: 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]: string}: 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.
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, str]: 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, str]: 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.
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<String>: 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>: 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.
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

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

pulumi/pulumi-oci

oci.Identity.getGroups

On this page

On this page

Example Usage

Using getGroups

getGroups Result

Supporting Types

GetGroupsFilter

GetGroupsGroup

Package Details

On this page

On this page