oci.Identity.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 System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testGroup = Oci.Identity.GetGroup.Invoke(new()
{
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
})
}
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.GetGroupArgs;
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 testGroup = IdentityFunctions.getGroup(GetGroupArgs.builder()
.groupId(oci_identity_group.test_group().id())
.build());
}
}
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,
});
variables:
testGroup:
fn::invoke:
Function: oci:Identity:getGroup
Arguments:
groupId: ${oci_identity_group.test_group.id}
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:
- Group
Id string The OCID of the group.
- Group
Id string The OCID of the group.
- group
Id String The OCID of the group.
- group
Id string The OCID of the group.
- group_
id str The OCID of the group.
- group
Id String The OCID of the group.
getGroup Result
The following output properties are available:
- Compartment
Id string The OCID of the tenancy containing the group.
- 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.
- 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"}
- Group
Id string - Id string
The OCID of the group.
- Inactive
State 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.
- Time
Created string Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Compartment
Id string The OCID of the tenancy containing the group.
- 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.
- 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"}
- Group
Id string - Id string
The OCID of the group.
- Inactive
State 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.
- Time
Created string Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String The OCID of the tenancy containing the group.
- 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.
- 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"}
- group
Id String - id String
The OCID of the group.
- inactive
State 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.
- time
Created String Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id string The OCID of the tenancy containing the group.
- {[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.
- {[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"}
- group
Id string - id string
The OCID of the group.
- inactive
State 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.
- time
Created 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.
- 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.
- 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
- compartment
Id String The OCID of the tenancy containing the group.
- 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.
- 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"}
- group
Id String - id String
The OCID of the group.
- inactive
State 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.
- time
Created 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.