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

}

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 Europe"),
        })
        if err != nil {
            return err
        }
        exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            PublisherName:     pulumi.String("My Company"),
            PublisherEmail:    pulumi.String("company@exmaple.com"),
            SkuName:           pulumi.String("Developer_1"),
        })
        if err != nil {
            return err
        }
        _, err = apimanagement.NewUser(ctx, "exampleUser", &apimanagement.UserArgs{
            UserId:            pulumi.String("5931a75ae4bbd512288c680b"),
            ApiManagementName: exampleService.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            FirstName:         pulumi.String("Example"),
            LastName:          pulumi.String("User"),
            Email:             pulumi.String("user@example.com"),
            State:             pulumi.String("active"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_user = azure.apimanagement.User("exampleUser",
    user_id="5931a75ae4bbd512288c680b",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    first_name="Example",
    last_name="User",
    email="user@example.com",
    state="active")

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleUser = new azure.apimanagement.User("exampleUser", {
    userId: "5931a75ae4bbd512288c680b",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    firstName: "Example",
    lastName: "User",
    email: "user@example.com",
    state: "active",
});

Create a User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);

def User(resource_name, opts=None, api_management_name=None, confirmation=None, email=None, first_name=None, last_name=None, note=None, password=None, resource_group_name=None, state=None, user_id=None, __props__=None);

func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)

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

name string: The unique name of the resource.
args UserArgs: 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 UserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

User Resource Properties

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

Inputs

The User resource accepts the following input properties:

ApiManagementName string: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
Email string: The email address associated with this user.
FirstName string: The first name for this user.
LastName string: The last name for this user.
ResourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
UserId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Confirmation string: 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.
Note string: A note about this user.
Password string: The password associated with this user.
State string: The state of this user. Possible values are active, blocked and pending.

ApiManagementName string: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
Email string: The email address associated with this user.
FirstName string: The first name for this user.
LastName string: The last name for this user.
ResourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
UserId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Confirmation string: 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.
Note string: A note about this user.
Password string: The password associated with this user.
State string: The state of this user. Possible values are active, blocked and pending.

apiManagementName string: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
email string: The email address associated with this user.
firstName string: The first name for this user.
lastName string: The last name for this user.
resourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
userId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
confirmation string: 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.
note string: A note about this user.
password string: The password associated with this user.
state string: The state of this user. Possible values are active, blocked and pending.

api_management_name str: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
email str: The email address associated with this user.
first_name str: The first name for this user.
last_name str: The last name for this user.
resource_group_name str: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
user_id str: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
confirmation str: 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.
note str: A note about this user.
password str: The password associated with this user.
state str: The state of this user. Possible values are active, blocked and pending.

Outputs

All input properties are implicitly available as output properties. Additionally, the User 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 User Resource

Get an existing User 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?: UserState, opts?: CustomResourceOptions): User

static get(resource_name, id, opts=None, api_management_name=None, confirmation=None, email=None, first_name=None, last_name=None, note=None, password=None, resource_group_name=None, state=None, user_id=None, __props__=None);

func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)

public static User Get(string name, Input<string> id, UserState? 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 User should be created. Changing this forces a new resource to be created.
Confirmation string: 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.
Email string: The email address associated with this user.
FirstName string: The first name for this user.
LastName string: The last name for this user.
Note string: A note about this user.
Password string: The password associated with this user.
ResourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
State string: The state of this user. Possible values are active, blocked and pending.
UserId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.

ApiManagementName string: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
Confirmation string: 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.
Email string: The email address associated with this user.
FirstName string: The first name for this user.
LastName string: The last name for this user.
Note string: A note about this user.
Password string: The password associated with this user.
ResourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
State string: The state of this user. Possible values are active, blocked and pending.
UserId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.

apiManagementName string: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
confirmation string: 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.
email string: The email address associated with this user.
firstName string: The first name for this user.
lastName string: The last name for this user.
note string: A note about this user.
password string: The password associated with this user.
resourceGroupName string: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
state string: The state of this user. Possible values are active, blocked and pending.
userId string: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.

api_management_name str: The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
confirmation str: 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.
email str: The email address associated with this user.
first_name str: The first name for this user.
last_name str: The last name for this user.
note str: A note about this user.
password str: The password associated with this user.
resource_group_name str: The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
state str: The state of this user. Possible values are active, blocked and pending.
user_id str: The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.

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