Class GroupUser

Manages an API Management User Assignment to a Group.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleUser = Output.Create(Azure.ApiManagement.GetUser.InvokeAsync(new Azure.ApiManagement.GetUserArgs
    {
        UserId = "my-user",
        ApiManagementName = "example-apim",
        ResourceGroupName = "search-service",
    }));
    var exampleGroupUser = new Azure.ApiManagement.GroupUser("exampleGroupUser", new Azure.ApiManagement.GroupUserArgs
    {
        UserId = exampleUser.Apply(exampleUser => exampleUser.Id),
        GroupName = "example-group",
        ResourceGroupName = exampleUser.Apply(exampleUser => exampleUser.ResourceGroupName),
        ApiManagementName = exampleUser.Apply(exampleUser => exampleUser.ApiManagementName),
    });
}

}

Inheritance

System.Object

Resource

CustomResource

GroupUser

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 GroupUser : CustomResource

Constructors

GroupUser(String, GroupUserArgs, CustomResourceOptions)

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

Declaration

public GroupUser(string name, GroupUserArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GroupUserArgs	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. Changing this forces a new resource to be created.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

GroupName

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

Declaration

public Output<string> GroupName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

UserId

The ID of the API Management User which should be assigned to this API Management Group. Changing this forces a new resource to be created.

Declaration

public Output<string> UserId { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static GroupUser Get(string name, Input<string> id, GroupUserState 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.
GroupUserState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
GroupUser