1. Docs
  2. Reference
  3. API
  4. Azure
  5. management
  6. GetGroup

GetGroup

Use this data source to access information about an existing Management Group.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Management.GetGroup.InvokeAsync(new Azure.Management.GetGroupArgs
        {
            Name = "00000000-0000-0000-0000-000000000000",
        }));
        this.DisplayName = example.Apply(example => example.DisplayName);
    }

    [Output("displayName")]
    public Output<string> DisplayName { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/management"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := "00000000-0000-0000-0000-000000000000"
        example, err := management.LookupGroup(ctx, &management.LookupGroupArgs{
            Name: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("displayName", example.DisplayName)
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.management.get_group(name="00000000-0000-0000-0000-000000000000")
pulumi.export("displayName", example.display_name)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.management.getGroup({
    name: "00000000-0000-0000-0000-000000000000",
});
export const displayName = example.then(example => example.displayName);

Using GetGroup

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function  get_group(display_name=None, group_id=None, name=None, opts=None)
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)

Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup {
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DisplayName string

Specifies the display name of this Management Group.

GroupId string

Specifies the name or UUID of this Management Group.

Deprecated: Deprecated in favour of name

Name string

Specifies the name or UUID of this Management Group.

DisplayName string

Specifies the display name of this Management Group.

GroupId string

Specifies the name or UUID of this Management Group.

Deprecated: Deprecated in favour of name

Name string

Specifies the name or UUID of this Management Group.

displayName string

Specifies the display name of this Management Group.

groupId string

Specifies the name or UUID of this Management Group.

Deprecated: Deprecated in favour of name

name string

Specifies the name or UUID of this Management Group.

display_name str

Specifies the display name of this Management Group.

group_id str

Specifies the name or UUID of this Management Group.

Deprecated: Deprecated in favour of name

name str

Specifies the name or UUID of this Management Group.

GetGroup Result

The following output properties are available:

DisplayName string
GroupId string

Deprecated: Deprecated in favour of name

Id string

The provider-assigned unique ID for this managed resource.

Name string
ParentManagementGroupId string

The ID of any Parent Management Group.

SubscriptionIds List<string>

A list of Subscription IDs which are assigned to the Management Group.

DisplayName string
GroupId string

Deprecated: Deprecated in favour of name

Id string

The provider-assigned unique ID for this managed resource.

Name string
ParentManagementGroupId string

The ID of any Parent Management Group.

SubscriptionIds []string

A list of Subscription IDs which are assigned to the Management Group.

displayName string
groupId string

Deprecated: Deprecated in favour of name

id string

The provider-assigned unique ID for this managed resource.

name string
parentManagementGroupId string

The ID of any Parent Management Group.

subscriptionIds string[]

A list of Subscription IDs which are assigned to the Management Group.

display_name str
group_id str

Deprecated: Deprecated in favour of name

id str

The provider-assigned unique ID for this managed resource.

name str
parent_management_group_id str

The ID of any Parent Management Group.

subscription_ids List[str]

A list of Subscription IDs which are assigned to the Management Group.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.