Skip to content

azurermNotificationHubNamespace

Manages a Notification Hub Namespace.

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: "notificationhub-resources",
  }
);
const azurermNotificationHubNamespaceExample =
  new azurerm.notificationHubNamespace.NotificationHubNamespace(
    this,
    "example_1",
    {
      location: azurermResourceGroupExample.location,
      name: "myappnamespace",
      namespace_type: "NotificationHub",
      resource_group_name: azurermResourceGroupExample.name,
      sku_name: "Free",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermNotificationHubNamespaceExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

  • location - (Required) The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.

  • namespaceType - (Required) The Type of Namespace - possible values are messaging or notificationHub.

  • skuName - (Required) The name of the SKU to use for this Notification Hub Namespace. Possible values are free, basic or standard.

  • enabled - (Optional) Is this Notification Hub Namespace enabled? Defaults to true.

  • tags - (Optional) A mapping of tags to assign to the resource.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Notification Hub Namespace.

  • servicebusEndpoint - The ServiceBus Endpoint for this Notification Hub Namespace.

Timeouts

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

  • create - (Defaults to 30 minutes) Used when creating the Notification Hub Namespace.
  • update - (Defaults to 30 minutes) Used when updating the Notification Hub Namespace.
  • read - (Defaults to 5 minutes) Used when retrieving the Notification Hub Namespace.
  • delete - (Defaults to 30 minutes) Used when deleting the Notification Hub Namespace.

Import

Notification Hub Namespaces can be imported using the resourceId, e.g.

terraform import azurerm_notification_hub_namespace.namespace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1