1. Packages
  2. OVH
  3. API Docs
  4. Me
  5. getIdentityGroup
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

ovh.Me.getIdentityGroup

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

    Use this data source to retrieve information about an identity group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@pulumi/ovh";
    
    const myGroup = ovh.Me.getIdentityGroup({
        name: "my_group_name",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    my_group = ovh.Me.get_identity_group(name="my_group_name")
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Me"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Me.GetIdentityGroup(ctx, &me.GetIdentityGroupArgs{
    			Name: "my_group_name",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var myGroup = Ovh.Me.GetIdentityGroup.Invoke(new()
        {
            Name = "my_group_name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.Me.MeFunctions;
    import com.pulumi.ovh.Me.inputs.GetIdentityGroupArgs;
    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 myGroup = MeFunctions.getIdentityGroup(GetIdentityGroupArgs.builder()
                .name("my_group_name")
                .build());
    
        }
    }
    
    variables:
      myGroup:
        fn::invoke:
          Function: ovh:Me:getIdentityGroup
          Arguments:
            name: my_group_name
    

    Using getIdentityGroup

    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 getIdentityGroup(args: GetIdentityGroupArgs, opts?: InvokeOptions): Promise<GetIdentityGroupResult>
    function getIdentityGroupOutput(args: GetIdentityGroupOutputArgs, opts?: InvokeOptions): Output<GetIdentityGroupResult>
    def get_identity_group(name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetIdentityGroupResult
    def get_identity_group_output(name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetIdentityGroupResult]
    func GetIdentityGroup(ctx *Context, args *GetIdentityGroupArgs, opts ...InvokeOption) (*GetIdentityGroupResult, error)
    func GetIdentityGroupOutput(ctx *Context, args *GetIdentityGroupOutputArgs, opts ...InvokeOption) GetIdentityGroupResultOutput

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

    public static class GetIdentityGroup 
    {
        public static Task<GetIdentityGroupResult> InvokeAsync(GetIdentityGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentityGroupResult> Invoke(GetIdentityGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: ovh:Me/getIdentityGroup:getIdentityGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Group name.
    Name string
    Group name.
    name String
    Group name.
    name string
    Group name.
    name str
    Group name.
    name String
    Group name.

    getIdentityGroup Result

    The following output properties are available:

    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    Description string
    Group description.
    GroupURN string
    Identity URN of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Date of the last update of this group.
    Name string
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    Description string
    Group description.
    GroupURN string
    Identity URN of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Date of the last update of this group.
    Name string
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN String
    Identity URN of the group.
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    description String
    Group description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Date of the last update of this group.
    name String
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN string
    Identity URN of the group.
    creation string
    Creation date of this group.
    defaultGroup boolean
    Is the group a default and immutable one.
    description string
    Group description.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdate string
    Date of the last update of this group.
    name string
    role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    creation str
    Creation date of this group.
    default_group bool
    Is the group a default and immutable one.
    description str
    Group description.
    group_urn str
    Identity URN of the group.
    id str
    The provider-assigned unique ID for this managed resource.
    last_update str
    Date of the last update of this group.
    name str
    role str
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN String
    Identity URN of the group.
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    description String
    Group description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Date of the last update of this group.
    name String
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud