Skip to content

azurermApiManagementNotificationRecipientUser

Manages a API Management Notification Recipient User.

Example Usage

/*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 azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermApiManagementExample = new azurerm.apiManagement.ApiManagement(
  this,
  "example_1",
  {
    location: azurermResourceGroupExample.location,
    name: "example-apim",
    publisher_email: "company@terraform.io",
    publisher_name: "My Company",
    resource_group_name: azurermResourceGroupExample.name,
    sku_name: "Developer_1",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementExample.overrideLogicalId("example");
const azurermApiManagementUserExample =
  new azurerm.apiManagementUser.ApiManagementUser(this, "example_2", {
    api_management_name: azurermApiManagementExample.name,
    email: "foo@bar.com",
    first_name: "Example",
    last_name: "User",
    resource_group_name: azurermResourceGroupExample.name,
    state: "active",
    user_id: "123",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementUserExample.overrideLogicalId("example");
const azurermApiManagementNotificationRecipientUserExample =
  new azurerm.apiManagementNotificationRecipientUser.ApiManagementNotificationRecipientUser(
    this,
    "example_3",
    {
      api_management_id: azurermApiManagementExample.id,
      notification_type: "AccountClosedPublisher",
      user_id: azurermApiManagementUserExample.userId,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementNotificationRecipientUserExample.overrideLogicalId(
  "example"
);

Arguments Reference

The following arguments are supported:

  • apiManagementId - (Required) The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

  • userId - (Required) The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

  • notificationType - (Required) The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are accountClosedPublisher, bcc, newApplicationNotificationMessage, newIssuePublisherNotificationMessage, purchasePublisherNotificationMessage, quotaLimitApproachingPublisherNotificationMessage, and requestPublisherNotificationMessage.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the API Management Notification Recipient User.

Timeouts

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

  • create - (Defaults to 30 minutes) Used when creating the API Management Notification Recipient User.
  • read - (Defaults to 5 minutes) Used when retrieving the API Management Notification Recipient User.
  • delete - (Defaults to 30 minutes) Used when deleting the API Management Notification Recipient User.

Import

API Management Notification Recipient Users can be imported using the resourceId, e.g.

terraform import azurerm_api_management_notification_recipient_user.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/notifications/notificationName1/recipientUsers/userid1