pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/GroupArgs

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

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Developer_1")
            .build());
        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .apiManagementName(exampleService.name())
            .displayName("Example Group")
            .description("This is an example API management group.")
            .build());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun GroupArgs(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)

Functions

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

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.