Azure Native
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)
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.
- First
Name string First name.
- Last
Name string Last name.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- App
Type string | Pulumi.Azure Native. Api Management. App Type Determines the type of application which send the create user request. Default is legacy portal.
- Confirmation
string | Pulumi.
Azure Native. Api Management. Confirmation Determines the type of confirmation e-mail that will be sent to the newly created user.
- Identities
List<Pulumi.
Azure Native. Api Management. Inputs. User Identity Contract Args> 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.
Azure Native. Api Management. User State 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 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.
- First
Name string First name.
- Last
Name string Last name.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- App
Type 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
[]User
Identity Contract Args 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 | User
State Enum 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 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.
- first
Name String First name.
- last
Name String Last name.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
- app
Type 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
Identity Contract Args> 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 | User
State 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 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.
- first
Name string First name.
- last
Name string Last name.
- resource
Group stringName The name of the resource group.
- service
Name string The name of the API Management service.
- app
Type 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
User
Identity Contract Args[] 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 | User
State 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 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_ strname 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[User
Identity Contract Args] 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 | User
State 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.
- first
Name String First name.
- last
Name String Last name.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
- app
Type 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
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.
- user
Id 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.
Azure Native. Api Management. Outputs. Group Contract Properties Response> 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.
- Registration
Date 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
[]Group
Contract Properties Response 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.
- Registration
Date 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
Contract Properties Response> 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.
- registration
Date 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
Group
Contract Properties Response[] 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.
- registration
Date 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[Group
Contract Properties Response] 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
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.
- registration
Date 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.
- Developer
Portal - developerPortal
User create request was sent by new developer portal.
- App
Type Portal - portal
User create request was sent by legacy developer portal.
- App
Type Developer Portal - 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.
- Developer
Portal - 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.
- "developer
Portal" - 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.
- Confirmation
Signup - signup
Send an e-mail to the user confirming they have successfully signed up.
- Confirmation
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.
- "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
- Built
In bool true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- Display
Name string Group name.
- Description string
Group description. Can contain HTML formatting tags.
- External
Id 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 string Group name.
- Description string
Group description. Can contain HTML formatting tags.
- External
Id 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 Boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name String Group name.
- description String
Group description. Can contain HTML formatting tags.
- external
Id 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 boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name string Group name.
- description string
Group description. Can contain HTML formatting tags.
- external
Id 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.
- built
In Boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name String Group name.
- description String
Group description. Can contain HTML formatting tags.
- external
Id 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
UserIdentityContractResponse
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.
- User
State Active - active
User state is active.
- User
State Blocked - blocked
User is blocked. Blocked users cannot authenticate at developer portal or call API.
- User
State Pending - pending
User account is pending. Requires identity confirmation before it can be made active.
- User
State 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.
- "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