This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.apimanagement.getUser
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
Gets the details of the user specified by its identifier. Azure REST API version: 2022-08-01.
Other available API versions: 2016-10-10, 2017-03-01, 2018-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
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:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- User
Id string - User identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- User
Id string - User identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- user
Id String - User identifier. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- user
Id string - User identifier. Must be unique in the current API Management service instance.
- resource_
group_ strname - 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- user
Id String - User identifier. Must be unique in the current API Management service instance.
getUser Result
The following output properties are available:
- Groups
List<Pulumi.
Azure Native. Api Management. Outputs. Group Contract Properties Response> - 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.
- First
Name string - First name.
- Identities
List<Pulumi.
Azure Native. Api Management. Outputs. User Identity Contract Response> - Collection of user identities.
- Last
Name string - Last name.
- Note string
- Optional note about a user set by the administrator.
- 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. - 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
[]Group
Contract Properties Response - 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.
- First
Name string - First name.
- Identities
[]User
Identity Contract Response - Collection of user identities.
- Last
Name string - Last name.
- Note string
- Optional note about a user set by the administrator.
- 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. - 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
List<Group
Contract Properties Response> - 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.
- first
Name String - First name.
- identities
List<User
Identity Contract Response> - Collection of user identities.
- last
Name String - Last name.
- note String
- Optional note about a user set by the administrator.
- 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. - 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
Group
Contract Properties Response[] - 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.
- first
Name string - First name.
- identities
User
Identity Contract Response[] - Collection of user identities.
- last
Name string - Last name.
- note string
- Optional note about a user set by the administrator.
- 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. - 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[Group
Contract Properties Response] - 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[User
Identity Contract Response] - 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<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.
- first
Name String - First name.
- identities List<Property Map>
- Collection of user identities.
- last
Name String - Last name.
- note String
- Optional note about a user set by the administrator.
- 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. - 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
- 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.
UserIdentityContractResponse
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 v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi