Group
data class GroupArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val externalId: Output<String>? = null, val groupId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val type: Output<GroupType>? = null) : ConvertibleToJava<GroupArgs>
Contract details. Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01. Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
Example Usage
ApiManagementCreateGroup
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var @group = new AzureNative.ApiManagement.Group("group", new()
{
DisplayName = "temp group",
GroupId = "tempgroup",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});Content copied to clipboard
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewGroup(ctx, "group", &apimanagement.GroupArgs{
DisplayName: pulumi.String("temp group"),
GroupId: pulumi.String("tempgroup"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Group;
import com.pulumi.azurenative.apimanagement.GroupArgs;
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) {
var group = new Group("group", GroupArgs.builder()
.displayName("temp group")
.groupId("tempgroup")
.resourceGroupName("rg1")
.serviceName("apimService1")
.build());
}
}Content copied to clipboard
ApiManagementCreateGroupExternal
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var @group = new AzureNative.ApiManagement.Group("group", new()
{
Description = "new group to test",
DisplayName = "NewGroup (samiraad.onmicrosoft.com)",
ExternalId = "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d",
GroupId = "aadGroup",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Type = AzureNative.ApiManagement.GroupType.External,
});
});Content copied to clipboard
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewGroup(ctx, "group", &apimanagement.GroupArgs{
Description: pulumi.String("new group to test"),
DisplayName: pulumi.String("NewGroup (samiraad.onmicrosoft.com)"),
ExternalId: pulumi.String("aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"),
GroupId: pulumi.String("aadGroup"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Type: apimanagement.GroupTypeExternal,
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Group;
import com.pulumi.azurenative.apimanagement.GroupArgs;
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) {
var group = new Group("group", GroupArgs.builder()
.description("new group to test")
.displayName("NewGroup (samiraad.onmicrosoft.com)")
.externalId("aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d")
.groupId("aadGroup")
.resourceGroupName("rg1")
.serviceName("apimService1")
.type("external")
.build());
}
}Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:Group aadGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}Content copied to clipboard
Properties
Link copied to clipboard
Group description.
Link copied to clipboard
Group name.
Link copied to clipboard
Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
Link copied to clipboard
The name of the resource group. The name is case insensitive.
Link copied to clipboard
The name of the API Management service.