» azurerm_api_management_user

Manages an API Management User.

» Example Usage

resource "azurerm_resource_group" "test" {
  name     = "example-resources"
  location = "West Europe"
}

resource "azurerm_api_management" "test" {
  name                = "example-apim"
  location            = "${azurerm_resource_group.test.location}"
  resource_group_name = "${azurerm_resource_group.test.name}"
  publisher_name      = "My Company"
  publisher_email     = "company@terraform.io"

  sku {
    name     = "Developer"
    capacity = 1
  }
}

resource "azurerm_api_management_user" "test" {
  user_id               = "5931a75ae4bbd512288c680b"
  api_management_name   = "${azurerm_api_management.test.name}"
  resource_group_name   = "${azurerm_resource_group.test.name}"
  first_name            = "Example"
  last_name             = "User"
  email                 = "tom+tfdev@hashicorp.com"
  state                 = "active"
}

» Argument Reference

The following arguments are supported:

  • api_management_name - (Required) The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.

  • resource_group_name - (Required) The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

  • email - (Required) The email address associated with this user.

  • first_name - (Required) The first name for this user.

  • last_name - (Required) The last name for this user.

  • user_id - (Required) The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.


  • confirmation - (Optional) The kind of confirmation email which will be sent to this user. Possible values are invite and signup. Changing this forces a new resource to be created.

  • note - (Optional) A note about this user.

  • password - (Optional) The password associated with this user.

  • state - (Optional) The state of this user. Possible values are active, blocked and pending.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the API Management User.

» Import

API Management Users can be imported using the resource id, e.g.

terraform import azurerm_api_management_user.test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/users/abc123