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

GetGroup

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.ApiManagement.GetGroup.InvokeAsync(new Azure.ApiManagement.GetGroupArgs
        {
            Name = "my-group",
            ApiManagementName = "example-apim",
            ResourceGroupName = "search-service",
        }));
        this.GroupType = example.Apply(example => example.Type);
    }

    [Output("groupType")]
    public Output<string> GroupType { get; set; }
}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := apimanagement.LookupGroup(ctx, &apimanagement.LookupGroupArgs{
            Name:              "my-group",
            ApiManagementName: "example-apim",
            ResourceGroupName: "search-service",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("groupType", example.Type)
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_group(name="my-group",
    api_management_name="example-apim",
    resource_group_name="search-service")
pulumi.export("groupType", example.type)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getGroup({
    name: "my-group",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
export const groupType = example.then(example => example.type);

Using GetGroup

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function  get_group(api_management_name=None, name=None, resource_group_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:

ApiManagementName string

The Name of the API Management Service in which this Group exists.

Name string

The Name of the API Management Group.

ResourceGroupName string

The Name of the Resource Group in which the API Management Service exists.

ApiManagementName string

The Name of the API Management Service in which this Group exists.

Name string

The Name of the API Management Group.

ResourceGroupName string

The Name of the Resource Group in which the API Management Service exists.

apiManagementName string

The Name of the API Management Service in which this Group exists.

name string

The Name of the API Management Group.

resourceGroupName string

The Name of the Resource Group in which the API Management Service exists.

api_management_name str

The Name of the API Management Service in which this Group exists.

name str

The Name of the API Management Group.

resource_group_name str

The Name of the Resource Group in which the API Management Service exists.

GetGroup Result

The following output properties are available:

ApiManagementName string
Description string

The description of this API Management Group.

DisplayName string

The display name of this API Management Group.

ExternalId string

The identifier of the external Group.

Id string

The provider-assigned unique ID for this managed resource.

Name string
ResourceGroupName string
Type string

The type of this API Management Group, such as custom or external.

ApiManagementName string
Description string

The description of this API Management Group.

DisplayName string

The display name of this API Management Group.

ExternalId string

The identifier of the external Group.

Id string

The provider-assigned unique ID for this managed resource.

Name string
ResourceGroupName string
Type string

The type of this API Management Group, such as custom or external.

apiManagementName string
description string

The description of this API Management Group.

displayName string

The display name of this API Management Group.

externalId string

The identifier of the external Group.

id string

The provider-assigned unique ID for this managed resource.

name string
resourceGroupName string
type string

The type of this API Management Group, such as custom or external.

api_management_name str
description str

The description of this API Management Group.

display_name str

The display name of this API Management Group.

external_id str

The identifier of the external Group.

id str

The provider-assigned unique ID for this managed resource.

name str
resource_group_name str
type str

The type of this API Management Group, such as custom or external.

Package Details

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