GroupArgs

data class GroupArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val externalId: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<GroupArgs>

Manages an API Management Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
name: "example-apim",
location: example.location,
resourceGroupName: example.name,
publisherName: "pub1",
publisherEmail: "pub1@email.com",
skuName: "Developer_1",
});
const exampleGroup = new azure.apimanagement.Group("example", {
name: "example-apimg",
resourceGroupName: example.name,
apiManagementName: exampleService.name,
displayName: "Example Group",
description: "This is an example API management group.",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service = azure.apimanagement.Service("example",
name="example-apim",
location=example.location,
resource_group_name=example.name,
publisher_name="pub1",
publisher_email="pub1@email.com",
sku_name="Developer_1")
example_group = azure.apimanagement.Group("example",
name="example-apimg",
resource_group_name=example.name,
api_management_name=example_service.name,
display_name="Example Group",
description="This is an example API management group.")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("example", new()
{
Name = "example-apim",
Location = example.Location,
ResourceGroupName = example.Name,
PublisherName = "pub1",
PublisherEmail = "pub1@email.com",
SkuName = "Developer_1",
});
var exampleGroup = new Azure.ApiManagement.Group("example", new()
{
Name = "example-apimg",
ResourceGroupName = example.Name,
ApiManagementName = exampleService.Name,
DisplayName = "Example Group",
Description = "This is an example API management group.",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
Name: pulumi.String("example-apim"),
Location: example.Location,
ResourceGroupName: example.Name,
PublisherName: pulumi.String("pub1"),
PublisherEmail: pulumi.String("pub1@email.com"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
_, err = apimanagement.NewGroup(ctx, "example", &apimanagement.GroupArgs{
Name: pulumi.String("example-apimg"),
ResourceGroupName: example.Name,
ApiManagementName: exampleService.Name,
DisplayName: pulumi.String("Example Group"),
Description: pulumi.String("This is an example API management group."),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Group;
import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.name("example-apim")
.location(example.location())
.resourceGroupName(example.name())
.publisherName("pub1")
.publisherEmail("pub1@email.com")
.skuName("Developer_1")
.build());
var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
.name("example-apimg")
.resourceGroupName(example.name())
.apiManagementName(exampleService.name())
.displayName("Example Group")
.description("This is an example API management group.")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:apimanagement:Service
name: example
properties:
name: example-apim
location: ${example.location}
resourceGroupName: ${example.name}
publisherName: pub1
publisherEmail: pub1@email.com
skuName: Developer_1
exampleGroup:
type: azure:apimanagement:Group
name: example
properties:
name: example-apimg
resourceGroupName: ${example.name}
apiManagementName: ${exampleService.name}
displayName: Example Group
description: This is an example API management group.

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.ApiManagement: 2022-08-01

Import

API Management Groups can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/group:Group example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/groups/example-apimg

Constructors

Link copied to clipboard
constructor(apiManagementName: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, externalId: Output<String>? = null, name: Output<String>? = null, resourceGroupName: Output<String>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard
val apiManagementName: Output<String>? = null

The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val description: Output<String>? = null

The description of this API Management Group.

Link copied to clipboard
val displayName: Output<String>? = null

The display name of this API Management Group.

Link copied to clipboard
val externalId: Output<String>? = null

The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.

Link copied to clipboard
val name: Output<String>? = null

The name of the API Management Group. Changing this forces a new resource to be created.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val type: Output<String>? = null

The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.

Functions

Link copied to clipboard
open override fun toJava(): GroupArgs