Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. User
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.User

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

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

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 = "signup",
        Email = "foobar@outlook.com",
        FirstName = "foo",
        LastName = "bar",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        UserId = "5931a75ae4bbd512288c680b",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  user:
    type: azure-native:apimanagement:User
    properties:
      confirmation: signup
      email: foobar@outlook.com
      firstName: foo
      lastName: bar
      resourceGroupName: rg1
      serviceName: apimService1
      userId: 5931a75ae4bbd512288c680b
Copy

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,
         resource_group_name: Optional[str] = None,
         email: Optional[str] = None,
         first_name: Optional[str] = None,
         last_name: Optional[str] = None,
         service_name: Optional[str] = None,
         confirmation: Optional[Union[str, Confirmation]] = None,
         identities: Optional[Sequence[UserIdentityContractArgs]] = None,
         note: Optional[str] = None,
         notify: Optional[bool] = None,
         password: Optional[str] = None,
         app_type: Optional[Union[str, AppType]] = None,
         state: Optional[Union[str, UserState]] = None,
         user_id: 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-native:apimanagement:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 AzureNative.Apimanagement.User("userResource", new()
{
    ResourceGroupName = "string",
    Email = "string",
    FirstName = "string",
    LastName = "string",
    ServiceName = "string",
    Confirmation = "string",
    Identities = new[]
    {
        
        {
            { "id", "string" },
            { "provider", "string" },
        },
    },
    Note = "string",
    Notify = false,
    Password = "string",
    AppType = "string",
    State = "string",
    UserId = "string",
});
Copy
example, err := apimanagement.NewUser(ctx, "userResource", &apimanagement.UserArgs{
	ResourceGroupName: "string",
	Email:             "string",
	FirstName:         "string",
	LastName:          "string",
	ServiceName:       "string",
	Confirmation:      "string",
	Identities: []map[string]interface{}{
		map[string]interface{}{
			"id":       "string",
			"provider": "string",
		},
	},
	Note:     "string",
	Notify:   false,
	Password: "string",
	AppType:  "string",
	State:    "string",
	UserId:   "string",
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .resourceGroupName("string")
    .email("string")
    .firstName("string")
    .lastName("string")
    .serviceName("string")
    .confirmation("string")
    .identities(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .note("string")
    .notify(false)
    .password("string")
    .appType("string")
    .state("string")
    .userId("string")
    .build());
Copy
user_resource = azure_native.apimanagement.User("userResource",
    resource_group_name=string,
    email=string,
    first_name=string,
    last_name=string,
    service_name=string,
    confirmation=string,
    identities=[{
        id: string,
        provider: string,
    }],
    note=string,
    notify=False,
    password=string,
    app_type=string,
    state=string,
    user_id=string)
Copy
const userResource = new azure_native.apimanagement.User("userResource", {
    resourceGroupName: "string",
    email: "string",
    firstName: "string",
    lastName: "string",
    serviceName: "string",
    confirmation: "string",
    identities: [{
        id: "string",
        provider: "string",
    }],
    note: "string",
    notify: false,
    password: "string",
    appType: "string",
    state: "string",
    userId: "string",
});
Copy
type: azure-native:apimanagement:User
properties:
    appType: string
    confirmation: string
    email: string
    firstName: string
    identities:
        - id: string
          provider: string
    lastName: string
    note: string
    notify: false
    password: string
    resourceGroupName: string
    serviceName: string
    state: string
    userId: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

Email This property is required. string
Email address. Must not be empty and must be unique within the service instance.
FirstName This property is required. string
First name.
LastName This property is required. string
Last name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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.UserIdentityContract>
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 Changes to this property will trigger replacement. string
User identifier. Must be unique in the current API Management service instance.
Email This property is required. string
Email address. Must not be empty and must be unique within the service instance.
FirstName This property is required. string
First name.
LastName This property is required. string
Last name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. string
User identifier. Must be unique in the current API Management service instance.
email This property is required. String
Email address. Must not be empty and must be unique within the service instance.
firstName This property is required. String
First name.
lastName This property is required. String
Last name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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<UserIdentityContract>
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 Changes to this property will trigger replacement. String
User identifier. Must be unique in the current API Management service instance.
email This property is required. string
Email address. Must not be empty and must be unique within the service instance.
firstName This property is required. string
First name.
lastName This property is required. string
Last name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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 UserIdentityContract[]
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 Changes to this property will trigger replacement. string
User identifier. Must be unique in the current API Management service instance.
email This property is required. str
Email address. Must not be empty and must be unique within the service instance.
first_name This property is required. str
First name.
last_name This property is required. str
Last name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
service_name
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. str
User identifier. Must be unique in the current API Management service instance.
email This property is required. String
Email address. Must not be empty and must be unique within the service instance.
firstName This property is required. String
First name.
lastName This property is required. String
Last name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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
, AppTypeArgs

Portal
portalUser create request was sent by legacy developer portal.
DeveloperPortal
developerPortalUser create request was sent by new developer portal.
AppTypePortal
portalUser create request was sent by legacy developer portal.
AppTypeDeveloperPortal
developerPortalUser create request was sent by new developer portal.
Portal
portalUser create request was sent by legacy developer portal.
DeveloperPortal
developerPortalUser create request was sent by new developer portal.
Portal
portalUser create request was sent by legacy developer portal.
DeveloperPortal
developerPortalUser create request was sent by new developer portal.
PORTAL
portalUser create request was sent by legacy developer portal.
DEVELOPER_PORTAL
developerPortalUser create request was sent by new developer portal.
"portal"
portalUser create request was sent by legacy developer portal.
"developerPortal"
developerPortalUser create request was sent by new developer portal.

Confirmation
, ConfirmationArgs

Signup
signupSend an e-mail to the user confirming they have successfully signed up.
Invite
inviteSend an e-mail inviting the user to sign-up and complete registration.
ConfirmationSignup
signupSend an e-mail to the user confirming they have successfully signed up.
ConfirmationInvite
inviteSend an e-mail inviting the user to sign-up and complete registration.
Signup
signupSend an e-mail to the user confirming they have successfully signed up.
Invite
inviteSend an e-mail inviting the user to sign-up and complete registration.
Signup
signupSend an e-mail to the user confirming they have successfully signed up.
Invite
inviteSend an e-mail inviting the user to sign-up and complete registration.
SIGNUP
signupSend an e-mail to the user confirming they have successfully signed up.
INVITE
inviteSend an e-mail inviting the user to sign-up and complete registration.
"signup"
signupSend an e-mail to the user confirming they have successfully signed up.
"invite"
inviteSend an e-mail inviting the user to sign-up and complete registration.

GroupContractPropertiesResponse
, GroupContractPropertiesResponseArgs

BuiltIn This property is required. bool
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
DisplayName This property is required. 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 This property is required. bool
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
DisplayName This property is required. 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 This property is required. Boolean
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName This property is required. 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 This property is required. boolean
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName This property is required. 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 This property is required. bool
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
display_name This property is required. 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 This property is required. Boolean
true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
displayName This property is required. 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
, UserIdentityContractArgs

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
, UserIdentityContractResponseArgs

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
, UserStateArgs

Active
activeUser state is active.
Blocked
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending
pendingUser account is pending. Requires identity confirmation before it can be made active.
Deleted
deletedUser account is closed. All identities and related entities are removed.
UserStateActive
activeUser state is active.
UserStateBlocked
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
UserStatePending
pendingUser account is pending. Requires identity confirmation before it can be made active.
UserStateDeleted
deletedUser account is closed. All identities and related entities are removed.
Active
activeUser state is active.
Blocked
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending
pendingUser account is pending. Requires identity confirmation before it can be made active.
Deleted
deletedUser account is closed. All identities and related entities are removed.
Active
activeUser state is active.
Blocked
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
Pending
pendingUser account is pending. Requires identity confirmation before it can be made active.
Deleted
deletedUser account is closed. All identities and related entities are removed.
ACTIVE
activeUser state is active.
BLOCKED
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
PENDING
pendingUser account is pending. Requires identity confirmation before it can be made active.
DELETED
deletedUser account is closed. All identities and related entities are removed.
"active"
activeUser state is active.
"blocked"
blockedUser is blocked. Blocked users cannot authenticate at developer portal or call API.
"pending"
pendingUser account is pending. Requires identity confirmation before it can be made active.
"deleted"
deletedUser 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
Copy

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

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native