Class 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.",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Group

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class Group : CustomResource

Constructors

Group(String, GroupArgs, CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

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

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of this API Management Group.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

The display name of this API Management Group.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

ExternalId

The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.

Declaration

public Output<string> ExternalId { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Type

The type of this API Management Group. Possible values are custom and external. Default is custom.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, GroupState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Group