Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.apimanagement.getUser

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:apimanagement:getUser
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
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. The name is case insensitive.
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. The name is case insensitive.
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. The name is case insensitive.
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. The name is case insensitive.
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. The name is case insensitive.
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:

AzureApiVersion string: The Azure API version of the resource.
Groups List<Pulumi.AzureNative.ApiManagement.Outputs.GroupContractPropertiesResponse>: Collection of groups user is part of.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

AzureApiVersion string: The Azure API version of the resource.
Groups []GroupContractPropertiesResponse: Collection of groups user is part of.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

azureApiVersion String: The Azure API version of the resource.
groups List<GroupContractPropertiesResponse>: Collection of groups user is part of.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
email String: Email address.
firstName String: First name.
identities List<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.

azureApiVersion string: The Azure API version of the resource.
groups GroupContractPropertiesResponse[]: Collection of groups user is part of.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

azure_api_version str: The Azure API version of the resource.
groups Sequence[GroupContractPropertiesResponse]: Collection of groups user is part of.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

azureApiVersion String: The Azure API version of the resource.
groups List<Property Map>: Collection of groups user is part of.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
email String: Email address.
firstName String: First name.
identities List<Property Map>: 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: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.apimanagement.getUser

On this page

On this page

Using getUser

getUser Result

Supporting Types

GroupContractPropertiesResponse

UserIdentityContractResponse

Package Details

On this page

On this page