Class User

Manages an API Management User.

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 Europe",
    });
    var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
    });
    var exampleUser = new Azure.ApiManagement.User("exampleUser", new Azure.ApiManagement.UserArgs
    {
        UserId = "5931a75ae4bbd512288c680b",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = exampleResourceGroup.Name,
        FirstName = "Example",
        LastName = "User",
        Email = "user@example.com",
        State = "active",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

User

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

Constructors

User(String, UserArgs, CustomResourceOptions)

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

Declaration

public User(string name, UserArgs args, CustomResourceOptions options = null)

Parameters

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

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

Confirmation

The kind of confirmation email which will be sent to this user. Possible values are invite and signup. Changing this forces a new resource to be created.

Declaration

public Output<string> Confirmation { get; }

Property Value

Type	Description
Output<System.String>

Email

The email address associated with this user.

Declaration

public Output<string> Email { get; }

Property Value

Type	Description
Output<System.String>

FirstName

The first name for this user.

Declaration

public Output<string> FirstName { get; }

Property Value

Type	Description
Output<System.String>

LastName

The last name for this user.

Declaration

public Output<string> LastName { get; }

Property Value

Type	Description
Output<System.String>

Note

A note about this user.

Declaration

public Output<string> Note { get; }

Property Value

Type	Description
Output<System.String>

Password

The password associated with this user.

Declaration

public Output<string> Password { 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>

State

The state of this user. Possible values are active, blocked and pending.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

UserId

The Identifier for this User, which must be unique within the API Management Service. 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>, UserState, CustomResourceOptions)

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

Declaration

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

Returns

Type	Description
User