We recommend using Azure Native.
Azure v6.30.0 published on Thursday, Nov 20, 2025 by Pulumi
Use this data source to access information about an existing API Management User.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.apimanagement.getUser({
userId: "my-user",
apiManagementName: "example-apim",
resourceGroupName: "search-service",
});
export const notes = example.then(example => example.notes);
import pulumi
import pulumi_azure as azure
example = azure.apimanagement.get_user(user_id="my-user",
api_management_name="example-apim",
resource_group_name="search-service")
pulumi.export("notes", example.notes)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := apimanagement.LookupUser(ctx, &apimanagement.LookupUserArgs{
UserId: "my-user",
ApiManagementName: "example-apim",
ResourceGroupName: "search-service",
}, nil)
if err != nil {
return err
}
ctx.Export("notes", example.Notes)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ApiManagement.GetUser.Invoke(new()
{
UserId = "my-user",
ApiManagementName = "example-apim",
ResourceGroupName = "search-service",
});
return new Dictionary<string, object?>
{
["notes"] = example.Apply(getUserResult => getUserResult.Notes),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ApimanagementFunctions.getUser(GetUserArgs.builder()
.userId("my-user")
.apiManagementName("example-apim")
.resourceGroupName("search-service")
.build());
ctx.export("notes", example.notes());
}
}
variables:
example:
fn::invoke:
function: azure:apimanagement:getUser
arguments:
userId: my-user
apiManagementName: example-apim
resourceGroupName: search-service
outputs:
notes: ${example.notes}
API Providers
This data source uses the following Azure API Providers:
Microsoft.ApiManagement- 2022-08-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(api_management_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
user_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(api_management_name: Optional[pulumi.Input[str]] = None,
resource_group_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:apimanagement/getUser:getUser
arguments:
# arguments dictionaryThe following arguments are supported:
- Api
Management stringName - The Name of the API Management Service in which this User exists.
- Resource
Group stringName - The Name of the Resource Group in which the API Management Service exists.
- User
Id string - The Identifier for the User.
- Api
Management stringName - The Name of the API Management Service in which this User exists.
- Resource
Group stringName - The Name of the Resource Group in which the API Management Service exists.
- User
Id string - The Identifier for the User.
- api
Management StringName - The Name of the API Management Service in which this User exists.
- resource
Group StringName - The Name of the Resource Group in which the API Management Service exists.
- user
Id String - The Identifier for the User.
- api
Management stringName - The Name of the API Management Service in which this User exists.
- resource
Group stringName - The Name of the Resource Group in which the API Management Service exists.
- user
Id string - The Identifier for the User.
- api_
management_ strname - The Name of the API Management Service in which this User exists.
- resource_
group_ strname - The Name of the Resource Group in which the API Management Service exists.
- user_
id str - The Identifier for the User.
- api
Management StringName - The Name of the API Management Service in which this User exists.
- resource
Group StringName - The Name of the Resource Group in which the API Management Service exists.
- user
Id String - The Identifier for the User.
getUser Result
The following output properties are available:
- Api
Management stringName - Email string
- The Email Address used for this User.
- First
Name string - The First Name for the User.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Name string - The Last Name for the User.
- Note string
- Any notes about this User.
- Resource
Group stringName - State string
- The current state of this User, for example
active,blockedorpending. - User
Id string
- Api
Management stringName - Email string
- The Email Address used for this User.
- First
Name string - The First Name for the User.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Name string - The Last Name for the User.
- Note string
- Any notes about this User.
- Resource
Group stringName - State string
- The current state of this User, for example
active,blockedorpending. - User
Id string
- api
Management StringName - email String
- The Email Address used for this User.
- first
Name String - The First Name for the User.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Name String - The Last Name for the User.
- note String
- Any notes about this User.
- resource
Group StringName - state String
- The current state of this User, for example
active,blockedorpending. - user
Id String
- api
Management stringName - email string
- The Email Address used for this User.
- first
Name string - The First Name for the User.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Name string - The Last Name for the User.
- note string
- Any notes about this User.
- resource
Group stringName - state string
- The current state of this User, for example
active,blockedorpending. - user
Id string
- api_
management_ strname - email str
- The Email Address used for this User.
- first_
name str - The First Name for the User.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
name str - The Last Name for the User.
- note str
- Any notes about this User.
- resource_
group_ strname - state str
- The current state of this User, for example
active,blockedorpending. - user_
id str
- api
Management StringName - email String
- The Email Address used for this User.
- first
Name String - The First Name for the User.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Name String - The Last Name for the User.
- note String
- Any notes about this User.
- resource
Group StringName - state String
- The current state of this User, for example
active,blockedorpending. - user
Id String
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
