← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.66.0 published on Thursday, Jun 23, 2022 by Pulumi

Source code

User

User details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateUser

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var user = new AzureNative.ApiManagement.User("user", new AzureNative.ApiManagement.UserArgs
        {
            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/go/azure/apimanagement"
	"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("signup"),
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 pulumi
import pulumi_azure_native as azure_native

user = azure_native.apimanagement.User("user",
    confirmation="signup",
    email="foobar@outlook.com",
    first_name="foo",
    last_name="bar",
    resource_group_name="rg1",
    service_name="apimService1",
    user_id="5931a75ae4bbd512288c680b")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const user = new azure_native.apimanagement.User("user", {
    confirmation: "signup",
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    userId: "5931a75ae4bbd512288c680b",
});

resources:
  user:
    type: azure-native:apimanagement:User
    properties:
      confirmation: signup
      email: foobar@outlook.com
      firstName: foo
      lastName: bar
      resourceGroupName: rg1
      serviceName: apimService1
      userId: 5931a75ae4bbd512288c680b

Create a User Resource

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         app_type: Optional[Union[str, AppType]] = None,
         confirmation: Optional[Union[str, Confirmation]] = None,
         email: Optional[str] = None,
         first_name: Optional[str] = None,
         identities: Optional[Sequence[UserIdentityContractArgs]] = None,
         last_name: Optional[str] = None,
         note: Optional[str] = None,
         notify: Optional[bool] = None,
         password: Optional[str] = None,
         resource_group_name: Optional[str] = None,
         service_name: Optional[str] = None,
         state: Optional[Union[str, UserState]] = None,
         user_id: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = 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-native:apimanagement:User
properties: # The arguments to resource properties.
options: # 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.

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.

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:

Email string: Email address. Must not be empty and must be unique within the service instance.
FirstName string: First name.
LastName string: Last name.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
AppType string | Pulumi.AzureNative.ApiManagement.AppType: Determines the type of application which send the create user request. Default is legacy portal.
Confirmation string | Pulumi.AzureNative.ApiManagement.Confirmation: Determines the type of confirmation e-mail that will be sent to the newly created user.
Identities List<Pulumi.AzureNative.ApiManagement.Inputs.UserIdentityContractArgs>: Collection of user identities.
Note string: Optional note about a user set by the administrator.
Notify bool: Send an Email notification to the User.
Password string: User Password. If no value is provided, a default password is generated.
State string | Pulumi.AzureNative.ApiManagement.UserState: 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.
UserId string: User identifier. Must be unique in the current API Management service instance.

Email string: Email address. Must not be empty and must be unique within the service instance.
FirstName string: First name.
LastName string: Last name.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
AppType string | AppType: Determines the type of application which send the create user request. Default is legacy portal.
Confirmation string | Confirmation: Determines the type of confirmation e-mail that will be sent to the newly created user.
Identities []UserIdentityContractArgs: Collection of user identities.
Note string: Optional note about a user set by the administrator.
Notify bool: Send an Email notification to the User.
Password string: User Password. If no value is provided, a default password is generated.
State string | UserStateEnum: 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.
UserId string: User identifier. Must be unique in the current API Management service instance.

email String: Email address. Must not be empty and must be unique within the service instance.
firstName String: First name.
lastName String: Last name.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
appType String | AppType: Determines the type of application which send the create user request. Default is legacy portal.
confirmation String | Confirmation: Determines the type of confirmation e-mail that will be sent to the newly created user.
identities List<UserIdentityContractArgs>: Collection of user identities.
note String: Optional note about a user set by the administrator.
notify_ Boolean: Send an Email notification to the User.
password String: User Password. If no value is provided, a default password is generated.
state String | UserState: 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.
userId String: User identifier. Must be unique in the current API Management service instance.

email string: Email address. Must not be empty and must be unique within the service instance.
firstName string: First name.
lastName string: Last name.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.
appType string | AppType: Determines the type of application which send the create user request. Default is legacy portal.
confirmation string | Confirmation: Determines the type of confirmation e-mail that will be sent to the newly created user.
identities UserIdentityContractArgs[]: Collection of user identities.
note string: Optional note about a user set by the administrator.
notify boolean: Send an Email notification to the User.
password string: User Password. If no value is provided, a default password is generated.
state string | UserState: 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.
userId string: User identifier. Must be unique in the current API Management service instance.

email str: Email address. Must not be empty and must be unique within the service instance.
first_name str: First name.
last_name str: Last name.
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.
app_type str | AppType: Determines the type of application which send the create user request. Default is legacy portal.
confirmation str | Confirmation: Determines the type of confirmation e-mail that will be sent to the newly created user.
identities Sequence[UserIdentityContractArgs]: Collection of user identities.
note str: Optional note about a user set by the administrator.
notify bool: Send an Email notification to the User.
password str: User Password. If no value is provided, a default password is generated.
state str | UserState: 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.
user_id str: User identifier. Must be unique in the current API Management service instance.

email String: Email address. Must not be empty and must be unique within the service instance.
firstName String: First name.
lastName String: Last name.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
appType String | "portal" | "developerPortal": Determines the type of application which send the create user request. Default is legacy portal.
confirmation String | "signup" | "invite": Determines the type of confirmation e-mail that will be sent to the newly created user.
identities List<Property Map>: Collection of user identities.
note String: Optional note about a user set by the administrator.
notify Boolean: Send an Email notification to the User.
password String: User Password. If no value is provided, a default password is generated.
state String | "active" | "blocked" | "pending" | "deleted": 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.
userId String: User identifier. Must be unique in the current API Management service instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Groups List<Pulumi.AzureNative.ApiManagement.Outputs.GroupContractPropertiesResponse>: Collection of groups user is part of.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.
RegistrationDate string: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Groups []GroupContractPropertiesResponse: Collection of groups user is part of.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.
RegistrationDate string: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

groups List<GroupContractPropertiesResponse>: Collection of groups user is part of.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.
registrationDate String: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

groups GroupContractPropertiesResponse[]: Collection of groups user is part of.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
type string: Resource type for API Management resource.
registrationDate string: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

groups Sequence[GroupContractPropertiesResponse]: Collection of groups user is part of.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
type str: Resource type for API Management resource.
registration_date str: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

groups List<Property Map>: Collection of groups user is part of.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.
registrationDate String: Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Supporting Types

AppType

Portal: portal
User create request was sent by legacy developer portal.
DeveloperPortal: developerPortal
User create request was sent by new developer portal.

AppTypePortal: portal
User create request was sent by legacy developer portal.
AppTypeDeveloperPortal: developerPortal
User create request was sent by new developer portal.

Portal: portal
User create request was sent by legacy developer portal.
DeveloperPortal: developerPortal
User create request was sent by new developer portal.

Portal: portal
User create request was sent by legacy developer portal.
DeveloperPortal: developerPortal
User create request was sent by new developer portal.

PORTAL: portal
User create request was sent by legacy developer portal.
DEVELOPER_PORTAL: developerPortal
User create request was sent by new developer portal.

"portal": portal
User create request was sent by legacy developer portal.
"developerPortal": developerPortal
User create request was sent by new developer portal.

Confirmation

Signup: signup
Send an e-mail to the user confirming they have successfully signed up.
Invite: invite
Send an e-mail inviting the user to sign-up and complete registration.

ConfirmationSignup: signup
Send an e-mail to the user confirming they have successfully signed up.
ConfirmationInvite: invite
Send an e-mail inviting the user to sign-up and complete registration.

Signup: signup
Send an e-mail to the user confirming they have successfully signed up.
Invite: invite
Send an e-mail inviting the user to sign-up and complete registration.

Signup: signup
Send an e-mail to the user confirming they have successfully signed up.
Invite: invite
Send an e-mail inviting the user to sign-up and complete registration.

SIGNUP: signup
Send an e-mail to the user confirming they have successfully signed up.
INVITE: invite
Send an e-mail inviting the user to sign-up and complete registration.

"signup": signup
Send an e-mail to the user confirming they have successfully signed up.
"invite": invite
Send an e-mail inviting the user to sign-up and complete registration.

GroupContractPropertiesResponse

BuiltIn bool: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
DisplayName string: Group name.
Description string: Group description. Can contain HTML formatting tags.
ExternalId string: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
Type string: Group type.

BuiltIn bool: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
DisplayName string: Group name.
Description string: Group description. Can contain HTML formatting tags.
ExternalId string: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
Type string: Group type.

builtIn Boolean: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName String: Group name.
description String: Group description. Can contain HTML formatting tags.
externalId String: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
type String: Group type.

builtIn boolean: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName string: Group name.
description string: Group description. Can contain HTML formatting tags.
externalId string: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
type string: Group type.

built_in bool: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
display_name str: Group name.
description str: Group description. Can contain HTML formatting tags.
external_id str: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
type str: Group type.

builtIn Boolean: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName String: Group name.
description String: Group description. Can contain HTML formatting tags.
externalId String: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
type String: Group type.

UserIdentityContract

Id string: Identifier value within provider.
Provider string: Identity provider name.

Id string: Identifier value within provider.
Provider string: Identity provider name.

id String: Identifier value within provider.
provider String: Identity provider name.

id string: Identifier value within provider.
provider string: Identity provider name.

id str: Identifier value within provider.
provider str: Identity provider name.

id String: Identifier value within provider.
provider String: Identity provider name.

UserIdentityContractResponse

Id string: Identifier value within provider.
Provider string: Identity provider name.

Id string: Identifier value within provider.
Provider string: Identity provider name.

id String: Identifier value within provider.
provider String: Identity provider name.

id string: Identifier value within provider.
provider string: Identity provider name.

id str: Identifier value within provider.
provider str: Identity provider name.

id String: Identifier value within provider.
provider String: Identity provider name.

UserState

Active: active
User state is active.
Blocked: blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending: pending
User account is pending. Requires identity confirmation before it can be made active.
Deleted: deleted
User account is closed. All identities and related entities are removed.

UserStateActive: active
User state is active.
UserStateBlocked: blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
UserStatePending: pending
User account is pending. Requires identity confirmation before it can be made active.
UserStateDeleted: deleted
User account is closed. All identities and related entities are removed.

Active: active
User state is active.
Blocked: blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending: pending
User account is pending. Requires identity confirmation before it can be made active.
Deleted: deleted
User account is closed. All identities and related entities are removed.

Active: active
User state is active.
Blocked: blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending: pending
User account is pending. Requires identity confirmation before it can be made active.
Deleted: deleted
User account is closed. All identities and related entities are removed.

ACTIVE: active
User state is active.
BLOCKED: blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
PENDING: pending
User account is pending. Requires identity confirmation before it can be made active.
DELETED: deleted
User account is closed. All identities and related entities are removed.

"active": active
User state is active.
"blocked": blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
"pending": pending
User account is pending. Requires identity confirmation before it can be made active.
"deleted": deleted
User account is closed. All identities and related entities are removed.

Import

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

$ pulumi import azure-native:apimanagement:User 5931a75ae4bbd512288c680b /subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0