scaleway.iam.getGroup
Explore with Pulumi AI
Gets information about an existing IAM group.
For more information, refer to the IAM API documentation
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";
// Get info by name
const findByName = scaleway.iam.getGroup({
    name: "foobar",
});
// Get info by group ID
const findById = scaleway.iam.getGroup({
    groupId: "11111111-1111-1111-1111-111111111111",
});
import pulumi
import pulumi_scaleway as scaleway
# Get info by name
find_by_name = scaleway.iam.get_group(name="foobar")
# Get info by group ID
find_by_id = scaleway.iam.get_group(group_id="11111111-1111-1111-1111-111111111111")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/iam"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by name
		_, err := iam.LookupGroup(ctx, &iam.LookupGroupArgs{
			Name: pulumi.StringRef("foobar"),
		}, nil)
		if err != nil {
			return err
		}
		// Get info by group ID
		_, err = iam.LookupGroup(ctx, &iam.LookupGroupArgs{
			GroupId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;
return await Deployment.RunAsync(() => 
{
    // Get info by name
    var findByName = Scaleway.Iam.GetGroup.Invoke(new()
    {
        Name = "foobar",
    });
    // Get info by group ID
    var findById = Scaleway.Iam.GetGroup.Invoke(new()
    {
        GroupId = "11111111-1111-1111-1111-111111111111",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.iam.IamFunctions;
import com.pulumi.scaleway.iam.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) {
        // Get info by name
        final var findByName = IamFunctions.getGroup(GetGroupArgs.builder()
            .name("foobar")
            .build());
        // Get info by group ID
        final var findById = IamFunctions.getGroup(GetGroupArgs.builder()
            .groupId("11111111-1111-1111-1111-111111111111")
            .build());
    }
}
variables:
  # Get info by name
  findByName:
    fn::invoke:
      function: scaleway:iam:getGroup
      arguments:
        name: foobar
  # Get info by group ID
  findById:
    fn::invoke:
      function: scaleway:iam:getGroup
      arguments:
        groupId: 11111111-1111-1111-1111-111111111111
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,
              name: Optional[str] = None,
              organization_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              organization_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput> Note: This function is named LookupGroup 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)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
fn::invoke:
  function: scaleway:iam/getGroup:getGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Group
Id string The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- Name string
 - The name of the IAM group.
 - Organization
Id string organization_id) The ID of the organization the group is associated with.
- Group
Id string The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- Name string
 - The name of the IAM group.
 - Organization
Id string organization_id) The ID of the organization the group is associated with.
- group
Id String The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- name String
 - The name of the IAM group.
 - organization
Id String organization_id) The ID of the organization the group is associated with.
- group
Id string The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- name string
 - The name of the IAM group.
 - organization
Id string organization_id) The ID of the organization the group is associated with.
- group_
id str The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- name str
 - The name of the IAM group.
 - organization_
id str organization_id) The ID of the organization the group is associated with.
- group
Id String The ID of the IAM group.
Note You must specify at least one:
nameand/orgroup_id.- name String
 - The name of the IAM group.
 - organization
Id String organization_id) The ID of the organization the group is associated with.
getGroup Result
The following output properties are available:
- Application
Ids List<string> - Created
At string - Description string
 - External
Membership bool - Id string
 - The provider-assigned unique ID for this managed resource.
 - List<string>
 - Updated
At string - User
Ids List<string> - Group
Id string - Name string
 - Organization
Id string 
- Application
Ids []string - Created
At string - Description string
 - External
Membership bool - Id string
 - The provider-assigned unique ID for this managed resource.
 - []string
 - Updated
At string - User
Ids []string - Group
Id string - Name string
 - Organization
Id string 
- application
Ids List<String> - created
At String - description String
 - external
Membership Boolean - id String
 - The provider-assigned unique ID for this managed resource.
 - List<String>
 - updated
At String - user
Ids List<String> - group
Id String - name String
 - organization
Id String 
- application
Ids string[] - created
At string - description string
 - external
Membership boolean - id string
 - The provider-assigned unique ID for this managed resource.
 - string[]
 - updated
At string - user
Ids string[] - group
Id string - name string
 - organization
Id string 
- application_
ids Sequence[str] - created_
at str - description str
 - external_
membership bool - id str
 - The provider-assigned unique ID for this managed resource.
 - Sequence[str]
 - updated_
at str - user_
ids Sequence[str] - group_
id str - name str
 - organization_
id str 
- application
Ids List<String> - created
At String - description String
 - external
Membership Boolean - id String
 - The provider-assigned unique ID for this managed resource.
 - List<String>
 - updated
At String - user
Ids List<String> - group
Id String - name String
 - organization
Id String 
Package Details
- Repository
 - scaleway pulumiverse/pulumi-scaleway
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
scalewayTerraform Provider.