Harness v0.4.4, Nov 12 24

Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

harness.platform.getUsergroup

Explore with Pulumi AI

Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

Example Usage

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

const exampleById = harness.platform.getUsergroup({
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
});
const exampleByName = harness.platform.getUsergroup({
    name: "name",
    orgId: "org_id",
    projectId: "project_id",
});

import pulumi
import pulumi_harness as harness

example_by_id = harness.platform.get_usergroup(identifier="identifier",
    org_id="org_id",
    project_id="project_id")
example_by_name = harness.platform.get_usergroup(name="name",
    org_id="org_id",
    project_id="project_id")

package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.LookupUsergroup(ctx, &platform.LookupUsergroupArgs{
			Identifier: pulumi.StringRef("identifier"),
			OrgId:      pulumi.StringRef("org_id"),
			ProjectId:  pulumi.StringRef("project_id"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = platform.LookupUsergroup(ctx, &platform.LookupUsergroupArgs{
			Name:      pulumi.StringRef("name"),
			OrgId:     pulumi.StringRef("org_id"),
			ProjectId: pulumi.StringRef("project_id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var exampleById = Harness.Platform.GetUsergroup.Invoke(new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
    });

    var exampleByName = Harness.Platform.GetUsergroup.Invoke(new()
    {
        Name = "name",
        OrgId = "org_id",
        ProjectId = "project_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetUsergroupArgs;
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 exampleById = PlatformFunctions.getUsergroup(GetUsergroupArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .build());

        final var exampleByName = PlatformFunctions.getUsergroup(GetUsergroupArgs.builder()
            .name("name")
            .orgId("org_id")
            .projectId("project_id")
            .build());

    }
}

variables:
  exampleById:
    fn::invoke:
      Function: harness:platform:getUsergroup
      Arguments:
        identifier: identifier
        orgId: org_id
        projectId: project_id
  exampleByName:
    fn::invoke:
      Function: harness:platform:getUsergroup
      Arguments:
        name: name
        orgId: org_id
        projectId: project_id

Using getUsergroup

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 getUsergroup(args: GetUsergroupArgs, opts?: InvokeOptions): Promise<GetUsergroupResult>
function getUsergroupOutput(args: GetUsergroupOutputArgs, opts?: InvokeOptions): Output<GetUsergroupResult>

def get_usergroup(identifier: Optional[str] = None,
                  name: Optional[str] = None,
                  notification_configs: Optional[Sequence[GetUsergroupNotificationConfig]] = None,
                  org_id: Optional[str] = None,
                  project_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsergroupResult
def get_usergroup_output(identifier: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  notification_configs: Optional[pulumi.Input[Sequence[pulumi.Input[GetUsergroupNotificationConfigArgs]]]] = None,
                  org_id: Optional[pulumi.Input[str]] = None,
                  project_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsergroupResult]

func LookupUsergroup(ctx *Context, args *LookupUsergroupArgs, opts ...InvokeOption) (*LookupUsergroupResult, error)
func LookupUsergroupOutput(ctx *Context, args *LookupUsergroupOutputArgs, opts ...InvokeOption) LookupUsergroupResultOutput

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

public static class GetUsergroup 
{
    public static Task<GetUsergroupResult> InvokeAsync(GetUsergroupArgs args, InvokeOptions? opts = null)
    public static Output<GetUsergroupResult> Invoke(GetUsergroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUsergroupResult> getUsergroup(GetUsergroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: harness:platform/getUsergroup:getUsergroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
NotificationConfigs List<GetUsergroupNotificationConfig>: List of notification settings.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.

Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
NotificationConfigs []GetUsergroupNotificationConfig: List of notification settings.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.

identifier String: Unique identifier of the resource.
name String: Name of the resource.
notificationConfigs List<GetUsergroupNotificationConfig>: List of notification settings.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.

identifier string: Unique identifier of the resource.
name string: Name of the resource.
notificationConfigs GetUsergroupNotificationConfig[]: List of notification settings.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.

identifier str: Unique identifier of the resource.
name str: Name of the resource.
notification_configs Sequence[GetUsergroupNotificationConfig]: List of notification settings.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.

identifier String: Unique identifier of the resource.
name String: Name of the resource.
notificationConfigs List<Property Map>: List of notification settings.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.

getUsergroup Result

The following output properties are available:

Description string: Description of the resource.
ExternallyManaged bool: Whether the user group is externally managed.
Id string: The provider-assigned unique ID for this managed resource.
LinkedSsoDisplayName string: Name of the linked SSO.
LinkedSsoId string: The SSO account ID that the user group is linked to.
LinkedSsoType string: Type of linked SSO.
SsoGroupId string: Identifier of the userGroup in SSO.
SsoGroupName string: Name of the SSO userGroup.
SsoLinked bool: Whether sso is linked or not.
Tags List<string>: Tags to associate with the resource.
Users List<string>: List of users in the UserGroup.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
NotificationConfigs List<GetUsergroupNotificationConfig>: List of notification settings.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.

Description string: Description of the resource.
ExternallyManaged bool: Whether the user group is externally managed.
Id string: The provider-assigned unique ID for this managed resource.
LinkedSsoDisplayName string: Name of the linked SSO.
LinkedSsoId string: The SSO account ID that the user group is linked to.
LinkedSsoType string: Type of linked SSO.
SsoGroupId string: Identifier of the userGroup in SSO.
SsoGroupName string: Name of the SSO userGroup.
SsoLinked bool: Whether sso is linked or not.
Tags []string: Tags to associate with the resource.
Users []string: List of users in the UserGroup.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
NotificationConfigs []GetUsergroupNotificationConfig: List of notification settings.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.

description String: Description of the resource.
externallyManaged Boolean: Whether the user group is externally managed.
id String: The provider-assigned unique ID for this managed resource.
linkedSsoDisplayName String: Name of the linked SSO.
linkedSsoId String: The SSO account ID that the user group is linked to.
linkedSsoType String: Type of linked SSO.
ssoGroupId String: Identifier of the userGroup in SSO.
ssoGroupName String: Name of the SSO userGroup.
ssoLinked Boolean: Whether sso is linked or not.
tags List<String>: Tags to associate with the resource.
users List<String>: List of users in the UserGroup.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
notificationConfigs List<GetUsergroupNotificationConfig>: List of notification settings.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.

description string: Description of the resource.
externallyManaged boolean: Whether the user group is externally managed.
id string: The provider-assigned unique ID for this managed resource.
linkedSsoDisplayName string: Name of the linked SSO.
linkedSsoId string: The SSO account ID that the user group is linked to.
linkedSsoType string: Type of linked SSO.
ssoGroupId string: Identifier of the userGroup in SSO.
ssoGroupName string: Name of the SSO userGroup.
ssoLinked boolean: Whether sso is linked or not.
tags string[]: Tags to associate with the resource.
users string[]: List of users in the UserGroup.
identifier string: Unique identifier of the resource.
name string: Name of the resource.
notificationConfigs GetUsergroupNotificationConfig[]: List of notification settings.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.

description str: Description of the resource.
externally_managed bool: Whether the user group is externally managed.
id str: The provider-assigned unique ID for this managed resource.
linked_sso_display_name str: Name of the linked SSO.
linked_sso_id str: The SSO account ID that the user group is linked to.
linked_sso_type str: Type of linked SSO.
sso_group_id str: Identifier of the userGroup in SSO.
sso_group_name str: Name of the SSO userGroup.
sso_linked bool: Whether sso is linked or not.
tags Sequence[str]: Tags to associate with the resource.
users Sequence[str]: List of users in the UserGroup.
identifier str: Unique identifier of the resource.
name str: Name of the resource.
notification_configs Sequence[GetUsergroupNotificationConfig]: List of notification settings.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.

description String: Description of the resource.
externallyManaged Boolean: Whether the user group is externally managed.
id String: The provider-assigned unique ID for this managed resource.
linkedSsoDisplayName String: Name of the linked SSO.
linkedSsoId String: The SSO account ID that the user group is linked to.
linkedSsoType String: Type of linked SSO.
ssoGroupId String: Identifier of the userGroup in SSO.
ssoGroupName String: Name of the SSO userGroup.
ssoLinked Boolean: Whether sso is linked or not.
tags List<String>: Tags to associate with the resource.
users List<String>: List of users in the UserGroup.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
notificationConfigs List<Property Map>: List of notification settings.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.

Supporting Types

GetUsergroupNotificationConfig

GroupEmail string: Group email.
MicrosoftTeamsWebhookUrl string: Url of Microsoft teams webhook.
PagerDutyKey string: Pager duty key.
SendEmailToAllUsers bool: Send email to all the group members.
SlackWebhookUrl string: Url of slack webhook.
Type string: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

GroupEmail string: Group email.
MicrosoftTeamsWebhookUrl string: Url of Microsoft teams webhook.
PagerDutyKey string: Pager duty key.
SendEmailToAllUsers bool: Send email to all the group members.
SlackWebhookUrl string: Url of slack webhook.
Type string: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

groupEmail String: Group email.
microsoftTeamsWebhookUrl String: Url of Microsoft teams webhook.
pagerDutyKey String: Pager duty key.
sendEmailToAllUsers Boolean: Send email to all the group members.
slackWebhookUrl String: Url of slack webhook.
type String: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

groupEmail string: Group email.
microsoftTeamsWebhookUrl string: Url of Microsoft teams webhook.
pagerDutyKey string: Pager duty key.
sendEmailToAllUsers boolean: Send email to all the group members.
slackWebhookUrl string: Url of slack webhook.
type string: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

group_email str: Group email.
microsoft_teams_webhook_url str: Url of Microsoft teams webhook.
pager_duty_key str: Pager duty key.
send_email_to_all_users bool: Send email to all the group members.
slack_webhook_url str: Url of slack webhook.
type str: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

groupEmail String: Group email.
microsoftTeamsWebhookUrl String: Url of Microsoft teams webhook.
pagerDutyKey String: Pager duty key.
sendEmailToAllUsers Boolean: Send email to all the group members.
slackWebhookUrl String: Url of slack webhook.
type String: Can be one of EMAIL, SLACK, PAGERDUTY, MSTEAMS.

Package Details

Repository: harness pulumi/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

pulumi/pulumi-harness

harness.platform.getUsergroup

On this page

On this page

Example Usage

Using getUsergroup

getUsergroup Result

Supporting Types

GetUsergroupNotificationConfig

Package Details

On this page

On this page