Skip to content

Data Source: azurermNotificationHub

Use this data source to access information about an existing Notification Hub within a Notification Hub Namespace.

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 dataAzurermNotificationHubExample =
  new azurerm.dataAzurermNotificationHub.DataAzurermNotificationHub(
    this,
    "example",
    {
      name: "notification-hub",
      namespace_name: "namespace-name",
      resource_group_name: "resource-group-name",
    }
  );
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermNotificationHubExample.id,
});

Argument Reference

  • name - Specifies the Name of the Notification Hub.

  • namespaceName - Specifies the Name of the Notification Hub Namespace which contains the Notification Hub.

  • resourceGroupName - Specifies the Name of the Resource Group within which the Notification Hub exists.

Attributes Reference

  • id - The ID of the Notification Hub.

  • location - The Azure Region in which this Notification Hub exists.

  • apnsCredential - A apnsCredential block as defined below.

  • gcmCredential - A gcmCredential block as defined below.

  • tags - A mapping of tags to assign to the resource.

A apnsCredential block exports:

  • applicationMode - The Application Mode which defines which server the APNS Messages should be sent to. Possible values are production and sandbox.

  • bundleId - The Bundle ID of the iOS/macOS application to send push notifications for, such as comHashicorpExample.

  • keyId - The Apple Push Notifications Service (APNS) Key.

  • teamId - The ID of the team the Token.

  • token - The Push Token associated with the Apple Developer Account.

A gcmCredential block exports:

  • apiKey - The API Key associated with the Google Cloud Messaging service.

Timeouts

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

  • read - (Defaults to 5 minutes) Used when retrieving the Notification Hub within a Notification Hub Namespace.