import * as pulumi from "@pulumi/pulumi"; /** * Manages an API Management User. * * ## Example Usage * * ```typescript * 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", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2022-08-01 * * ## Import * * API Management Users can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/user:User example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/users/abc123 * ``` */ export declare class User extends pulumi.CustomResource { /** * Get an existing User resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: UserState, opts?: pulumi.CustomResourceOptions): User; /** * Returns true if the given object is an instance of User. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is User; /** * The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created. */ readonly apiManagementName: pulumi.Output; /** * 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. */ readonly confirmation: pulumi.Output; /** * The email address associated with this user. */ readonly email: pulumi.Output; /** * The first name for this user. */ readonly firstName: pulumi.Output; /** * The last name for this user. */ readonly lastName: pulumi.Output; /** * A note about this user. */ readonly note: pulumi.Output; /** * The password associated with this user. */ readonly password: pulumi.Output; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * 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. */ readonly state: pulumi.Output; /** * The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created. */ readonly userId: pulumi.Output; /** * Create a User resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering User resources. */ export interface UserState { /** * The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created. */ apiManagementName?: pulumi.Input; /** * 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. */ confirmation?: pulumi.Input; /** * The email address associated with this user. */ email?: pulumi.Input; /** * The first name for this user. */ firstName?: pulumi.Input; /** * The last name for this user. */ lastName?: pulumi.Input; /** * A note about this user. */ note?: pulumi.Input; /** * The password associated with this user. */ password?: pulumi.Input; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * 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. */ state?: pulumi.Input; /** * The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created. */ userId?: pulumi.Input; } /** * The set of arguments for constructing a User resource. */ export interface UserArgs { /** * The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created. */ apiManagementName: pulumi.Input; /** * 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. */ confirmation?: pulumi.Input; /** * The email address associated with this user. */ email: pulumi.Input; /** * The first name for this user. */ firstName: pulumi.Input; /** * The last name for this user. */ lastName: pulumi.Input; /** * A note about this user. */ note?: pulumi.Input; /** * The password associated with this user. */ password?: pulumi.Input; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * 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. */ state?: pulumi.Input; /** * The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created. */ userId: pulumi.Input; }