getGroup

suspend fun getGroup(argument: GetGroupPlainArgs): GetGroupResult

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

Example Usage

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);
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)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ApiManagement.GetGroup.Invoke(new()
{
Name = "my-group",
ApiManagementName = "example-apim",
ResourceGroupName = "search-service",
});
return new Dictionary<string, object?>
{
["groupType"] = example.Apply(getGroupResult => getGroupResult.Type),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi/sdk/v3/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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.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) {
final var example = ApimanagementFunctions.getGroup(GetGroupArgs.builder()
.name("my-group")
.apiManagementName("example-apim")
.resourceGroupName("search-service")
.build());
ctx.export("groupType", example.type());
}
}
variables:
example:
fn::invoke:
function: azure:apimanagement:getGroup
arguments:
name: my-group
apiManagementName: example-apim
resourceGroupName: search-service
outputs:
groupType: ${example.type}

API Providers

This data source uses the following Azure API Providers:

  • Microsoft.ApiManagement: 2022-08-01

Return

A collection of values returned by getGroup.

Parameters

argument

A collection of arguments for invoking getGroup.


suspend fun getGroup(apiManagementName: String, name: String, resourceGroupName: String): GetGroupResult

Return

A collection of values returned by getGroup.

Parameters

apiManagementName

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

name

The Name of the API Management Group.

resourceGroupName

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

See also


suspend fun getGroup(argument: suspend GetGroupPlainArgsBuilder.() -> Unit): GetGroupResult

Return

A collection of values returned by getGroup.

Parameters

argument

Builder for com.pulumi.azure.apimanagement.kotlin.inputs.GetGroupPlainArgs.

See also