UserContract interface

Package:

@azure/arm-apimanagement

User details.

Extends

ProxyResource

Properties

email	Email address.
firstName	First name.
groups	Collection of groups user is part of. NOTE: This property will not be serialized. It can only be populated by the server.
identities	Collection of user identities.
lastName	Last name.
note	Optional note about a user set by the administrator.
registrationDate	Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
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.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

email

Email address.

email?: string

Property Value

string

firstName

First name.

firstName?: string

Property Value

string

groups

Collection of groups user is part of. NOTE: This property will not be serialized. It can only be populated by the server.

groups?: GroupContractProperties[]

Property Value

GroupContractProperties[]

identities

Collection of user identities.

identities?: UserIdentityContract[]

Property Value

UserIdentityContract[]

lastName

Last name.

lastName?: string

Property Value

string

note

Optional note about a user set by the administrator.

note?: string

Property Value

string

registrationDate

Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

registrationDate?: Date

Property Value

Date

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.

state?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type