1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. User

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.apimanagement.User

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages an API Management User.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleService = new azure.apimanagement.Service("example", {
        name: "example-apim",
        location: example.location,
        resourceGroupName: example.name,
        publisherName: "My Company",
        publisherEmail: "company@exmaple.com",
        skuName: "Developer_1",
    });
    const exampleUser = new azure.apimanagement.User("example", {
        userId: "5931a75ae4bbd512288c680b",
        apiManagementName: exampleService.name,
        resourceGroupName: example.name,
        firstName: "Example",
        lastName: "User",
        email: "user@example.com",
        state: "active",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service = azure.apimanagement.Service("example",
        name="example-apim",
        location=example.location,
        resource_group_name=example.name,
        publisher_name="My Company",
        publisher_email="company@exmaple.com",
        sku_name="Developer_1")
    example_user = azure.apimanagement.User("example",
        user_id="5931a75ae4bbd512288c680b",
        api_management_name=example_service.name,
        resource_group_name=example.name,
        first_name="Example",
        last_name="User",
        email="user@example.com",
        state="active")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
    			Name:              pulumi.String("example-apim"),
    			Location:          example.Location,
    			ResourceGroupName: example.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, "example", &apimanagement.UserArgs{
    			UserId:            pulumi.String("5931a75ae4bbd512288c680b"),
    			ApiManagementName: exampleService.Name,
    			ResourceGroupName: example.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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleService = new Azure.ApiManagement.Service("example", new()
        {
            Name = "example-apim",
            Location = example.Location,
            ResourceGroupName = example.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
        });
    
        var exampleUser = new Azure.ApiManagement.User("example", new()
        {
            UserId = "5931a75ae4bbd512288c680b",
            ApiManagementName = exampleService.Name,
            ResourceGroupName = example.Name,
            FirstName = "Example",
            LastName = "User",
            Email = "user@example.com",
            State = "active",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.User;
    import com.pulumi.azure.apimanagement.UserArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .name("example-apim")
                .location(example.location())
                .resourceGroupName(example.name())
                .publisherName("My Company")
                .publisherEmail("company@exmaple.com")
                .skuName("Developer_1")
                .build());
    
            var exampleUser = new User("exampleUser", UserArgs.builder()
                .userId("5931a75ae4bbd512288c680b")
                .apiManagementName(exampleService.name())
                .resourceGroupName(example.name())
                .firstName("Example")
                .lastName("User")
                .email("user@example.com")
                .state("active")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        name: example
        properties:
          name: example-apim
          location: ${example.location}
          resourceGroupName: ${example.name}
          publisherName: My Company
          publisherEmail: company@exmaple.com
          skuName: Developer_1
      exampleUser:
        type: azure:apimanagement:User
        name: example
        properties:
          userId: 5931a75ae4bbd512288c680b
          apiManagementName: ${exampleService.name}
          resourceGroupName: ${example.name}
          firstName: Example
          lastName: User
          email: user@example.com
          state: active
    

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_management_name: Optional[str] = None,
             email: Optional[str] = None,
             first_name: Optional[str] = None,
             last_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             user_id: Optional[str] = None,
             confirmation: Optional[str] = None,
             note: Optional[str] = None,
             password: Optional[str] = None,
             state: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Azure.ApiManagement.User("userResource", new()
    {
        ApiManagementName = "string",
        Email = "string",
        FirstName = "string",
        LastName = "string",
        ResourceGroupName = "string",
        UserId = "string",
        Confirmation = "string",
        Note = "string",
        Password = "string",
        State = "string",
    });
    
    example, err := apimanagement.NewUser(ctx, "userResource", &apimanagement.UserArgs{
    	ApiManagementName: pulumi.String("string"),
    	Email:             pulumi.String("string"),
    	FirstName:         pulumi.String("string"),
    	LastName:          pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	UserId:            pulumi.String("string"),
    	Confirmation:      pulumi.String("string"),
    	Note:              pulumi.String("string"),
    	Password:          pulumi.String("string"),
    	State:             pulumi.String("string"),
    })
    
    var userResource = new User("userResource", UserArgs.builder()
        .apiManagementName("string")
        .email("string")
        .firstName("string")
        .lastName("string")
        .resourceGroupName("string")
        .userId("string")
        .confirmation("string")
        .note("string")
        .password("string")
        .state("string")
        .build());
    
    user_resource = azure.apimanagement.User("userResource",
        api_management_name="string",
        email="string",
        first_name="string",
        last_name="string",
        resource_group_name="string",
        user_id="string",
        confirmation="string",
        note="string",
        password="string",
        state="string")
    
    const userResource = new azure.apimanagement.User("userResource", {
        apiManagementName: "string",
        email: "string",
        firstName: "string",
        lastName: "string",
        resourceGroupName: "string",
        userId: "string",
        confirmation: "string",
        note: "string",
        password: "string",
        state: "string",
    });
    
    type: azure:apimanagement:User
    properties:
        apiManagementName: string
        confirmation: string
        email: string
        firstName: string
        lastName: string
        note: string
        password: string
        resourceGroupName: string
        state: string
        userId: string
    

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            confirmation: Optional[str] = None,
            email: Optional[str] = None,
            first_name: Optional[str] = None,
            last_name: Optional[str] = None,
            note: Optional[str] = None,
            password: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            state: Optional[str] = None,
            user_id: Optional[str] = None) -> User
    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)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.
    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.

    NOTE: the State can be changed from Pending > Active/Blocked but not from Active/Blocked > 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.

    Import

    API Management Users can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/user:User example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/users/abc123
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi