UserArgs

data class UserArgs(val appType: Output<Either<String, AppType>>? = null, val confirmation: Output<Either<String, Confirmation>>? = null, val email: Output<String>? = null, val firstName: Output<String>? = null, val identities: Output<List<UserIdentityContractArgs>>? = null, val lastName: Output<String>? = null, val note: Output<String>? = null, val notify: Output<Boolean>? = null, val password: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val state: Output<Either<String, UserState>>? = null, val userId: Output<String>? = null) : ConvertibleToJava<UserArgs>

User details. Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01. Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiManagementCreateUser

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var user = new AzureNative.ApiManagement.User("user", new()
{
Confirmation = AzureNative.ApiManagement.Confirmation.Signup,
Email = "foobar@outlook.com",
FirstName = "foo",
LastName = "bar",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
UserId = "5931a75ae4bbd512288c680b",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewUser(ctx, "user", &apimanagement.UserArgs{
Confirmation: pulumi.String(apimanagement.ConfirmationSignup),
Email: pulumi.String("foobar@outlook.com"),
FirstName: pulumi.String("foo"),
LastName: pulumi.String("bar"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
UserId: pulumi.String("5931a75ae4bbd512288c680b"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.User;
import com.pulumi.azurenative.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 user = new User("user", UserArgs.builder()
.confirmation("signup")
.email("foobar@outlook.com")
.firstName("foo")
.lastName("bar")
.resourceGroupName("rg1")
.serviceName("apimService1")
.userId("5931a75ae4bbd512288c680b")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:User 5931a75ae4bbd512288c680b /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}

Constructors

Link copied to clipboard
constructor(appType: Output<Either<String, AppType>>? = null, confirmation: Output<Either<String, Confirmation>>? = null, email: Output<String>? = null, firstName: Output<String>? = null, identities: Output<List<UserIdentityContractArgs>>? = null, lastName: Output<String>? = null, note: Output<String>? = null, notify: Output<Boolean>? = null, password: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, state: Output<Either<String, UserState>>? = null, userId: Output<String>? = null)

Properties

Link copied to clipboard
val appType: Output<Either<String, AppType>>? = null

Determines the type of application which send the create user request. Default is legacy portal.

Link copied to clipboard
val confirmation: Output<Either<String, Confirmation>>? = null

Determines the type of confirmation e-mail that will be sent to the newly created user.

Link copied to clipboard
val email: Output<String>? = null

Email address. Must not be empty and must be unique within the service instance.

Link copied to clipboard
val firstName: Output<String>? = null

First name.

Link copied to clipboard

Collection of user identities.

Link copied to clipboard
val lastName: Output<String>? = null

Last name.

Link copied to clipboard
val note: Output<String>? = null

Optional note about a user set by the administrator.

Link copied to clipboard
val notify: Output<Boolean>? = null

Send an Email notification to the User.

Link copied to clipboard
val password: Output<String>? = null

User Password. If no value is provided, a default password is generated.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Link copied to clipboard
val state: Output<Either<String, UserState>>? = null

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

Link copied to clipboard
val userId: Output<String>? = null

User identifier. Must be unique in the current API Management service instance.

Functions

Link copied to clipboard
open override fun toJava(): UserArgs