Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

getUser

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

Using getUser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
def get_user(resource_group_name: Optional[str] = None,
             service_name: Optional[str] = None,
             user_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(resource_group_name: Optional[pulumi.Input[str]] = None,
             service_name: Optional[pulumi.Input[str]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

> Note: This function is named LookupUser in the Go SDK.

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getUser
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

UserId string

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

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

UserId string

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

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

userId String

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

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

userId string

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

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

user_id str

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

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

userId String

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

getUser Result

The following output properties are available:

Groups List<Pulumi.AzureNative.ApiManagement.Outputs.GroupContractPropertiesResponse>

Collection of groups user is part of.

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Email string

Email address.

FirstName string

First name.

Identities List<Pulumi.AzureNative.ApiManagement.Outputs.UserIdentityContractResponse>

Collection of user identities.

LastName string

Last name.

Note string

Optional note about a user set by the administrator.

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.

State string

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.

Groups []GroupContractPropertiesResponse

Collection of groups user is part of.

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Email string

Email address.

FirstName string

First name.

Identities []UserIdentityContractResponse

Collection of user identities.

LastName string

Last name.

Note string

Optional note about a user set by the administrator.

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.

State string

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.

groups ListContractPropertiesResponse>

Collection of groups user is part of.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

email String

Email address.

firstName String

First name.

identities ListIdentityContractResponse>

Collection of user identities.

lastName String

Last name.

note String

Optional note about a user set by the administrator.

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.

state String

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.

groups GroupContractPropertiesResponse[]

Collection of groups user is part of.

id string

Resource ID.

name string

Resource name.

type string

Resource type for API Management resource.

email string

Email address.

firstName string

First name.

identities UserIdentityContractResponse[]

Collection of user identities.

lastName string

Last name.

note string

Optional note about a user set by the administrator.

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.

state string

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.

groups Sequence[GroupContractPropertiesResponse]

Collection of groups user is part of.

id str

Resource ID.

name str

Resource name.

type str

Resource type for API Management resource.

email str

Email address.

first_name str

First name.

identities Sequence[UserIdentityContractResponse]

Collection of user identities.

last_name str

Last name.

note str

Optional note about a user set by the administrator.

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.

state str

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.

groups List

Collection of groups user is part of.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

email String

Email address.

firstName String

First name.

identities List

Collection of user identities.

lastName String

Last name.

note String

Optional note about a user set by the administrator.

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.

state String

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.

Supporting Types

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.

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.

Package Details

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