Skip to content

Data Source: azurermApiManagementUser

Use this data source to access information about an existing API Management User.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermApiManagementUserExample =
  new azurerm.dataAzurermApiManagementUser.DataAzurermApiManagementUser(
    this,
    "example",
    {
      api_management_name: "example-apim",
      resource_group_name: "search-service",
      user_id: "my-user",
    }
  );
new cdktf.TerraformOutput(this, "notes", {
  value: dataAzurermApiManagementUserExample.notes,
});

Argument Reference

  • apiManagementName - The Name of the API Management Service in which this User exists.

  • resourceGroupName - The Name of the Resource Group in which the API Management Service exists.

  • userId - The Identifier for the User.

Attributes Reference

  • id - The ID of the API Management User.

  • firstName - The First Name for the User.

  • lastName - The Last Name for the User.

  • email - The Email Address used for this User.

  • note - Any notes about this User.

  • state - The current state of this User, for example active, blocked or pending.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the API Management User.