Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getGroup

This data source provides details about a specific Group resource in Oracle Cloud Infrastructure Identity service.

Gets the specified group’s information.

This operation does not return a list of all the users in the group. To do that, use ListUserGroupMemberships and provide the group’s OCID as a query parameter in the request.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testGroup = Output.Create(Oci.Identity.GetGroup.InvokeAsync(new Oci.Identity.GetGroupArgs
        {
            GroupId = oci_identity_group.Test_group.Id,
        }));
    }

}
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.GetGroup(ctx, &identity.GetGroupArgs{
			GroupId: oci_identity_group.Test_group.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_group = oci.Identity.get_group(group_id=oci_identity_group["test_group"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testGroup = oci.Identity.getGroup({
    groupId: oci_identity_group.test_group.id,
});

Coming soon!

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(group_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func GetGroup(ctx *Context, args *GetGroupArgs, opts ...InvokeOption) (*GetGroupResult, error)
func GetGroupOutput(ctx *Context, args *GetGroupOutputArgs, opts ...InvokeOption) GetGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Identity/getGroup:getGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GroupId string

The OCID of the group.

GroupId string

The OCID of the group.

groupId String

The OCID of the group.

groupId string

The OCID of the group.

group_id str

The OCID of the group.

groupId String

The OCID of the group.

getGroup Result

The following output properties are available:

CompartmentId string

The OCID of the tenancy containing the group.

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"}

GroupId string
Id string

The OCID of the group.

InactiveState string

The detailed status of INACTIVE lifecycleState.

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.

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 tenancy containing the group.

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"}

GroupId string
Id string

The OCID of the group.

InactiveState string

The detailed status of INACTIVE lifecycleState.

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.

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 tenancy containing the group.

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"}

groupId String
id String

The OCID of the group.

inactiveState String

The detailed status of INACTIVE lifecycleState.

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.

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 tenancy containing the group.

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"}

groupId string
id string

The OCID of the group.

inactiveState string

The detailed status of INACTIVE lifecycleState.

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.

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 tenancy containing the group.

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"}

group_id str
id str

The OCID of the group.

inactive_state str

The detailed status of INACTIVE lifecycleState.

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.

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 tenancy containing the group.

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"}

groupId String
id String

The OCID of the group.

inactiveState String

The detailed status of INACTIVE lifecycleState.

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.

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.