Group

Manages an API Management Group.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "pub1",
            PublisherEmail = "pub1@email.com",
            SkuName = "Developer_1",
        });
        var exampleGroup = new Azure.ApiManagement.Group("exampleGroup", new Azure.ApiManagement.GroupArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            ApiManagementName = exampleService.Name,
            DisplayName = "Example Group",
            Description = "This is an example API management group.",
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.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, "exampleGroup", &apimanagement.GroupArgs{
            ResourceGroupName: exampleResourceGroup.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
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_group = azure.apimanagement.Group("exampleGroup",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="Example Group",
    description="This is an example API management group.")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleGroup = new azure.apimanagement.Group("exampleGroup", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "Example Group",
    description: "This is an example API management group.",
});

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

def Group(resource_name, opts=None, api_management_name=None, description=None, display_name=None, external_id=None, name=None, resource_group_name=None, type=None, __props__=None);

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Group resource accepts the following input properties:

ApiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Group.
ResourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
Description string: The description of this API Management Group.
ExternalId string: The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
Name string: The name of the API Management Group. Changing this forces a new resource to be created.
Type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

ApiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Group.
ResourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
Description string: The description of this API Management Group.
ExternalId string: The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
Name string: The name of the API Management Group. Changing this forces a new resource to be created.
Type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

apiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
displayName string: The display name of this API Management Group.
resourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
description string: The description of this API Management Group.
externalId string: The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
name string: The name of the API Management Group. Changing this forces a new resource to be created.
type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

api_management_name str: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
display_name str: The display name of this API Management Group.
resource_group_name str: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
description str: The description of this API Management Group.
external_id str: The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
name str: The name of the API Management Group. Changing this forces a new resource to be created.
type str: The type of this API Management Group. Possible values are custom and external. Default is custom.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group

static get(resource_name, id, opts=None, api_management_name=None, description=None, display_name=None, external_id=None, name=None, resource_group_name=None, type=None, __props__=None);

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
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. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
Name string: The name of the API Management Group. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
Type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

ApiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
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. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
Name string: The name of the API Management Group. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
Type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

apiManagementName string: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
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. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
name string: The name of the API Management Group. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
type string: The type of this API Management Group. Possible values are custom and external. Default is custom.

api_management_name str: The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
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. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
name str: The name of the API Management Group. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
type str: The type of this API Management Group. Possible values are custom and external. Default is custom.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud