Hub

Manages a Notification Hub within a Notification Hub Namespace.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "Australia East",
        });
        var exampleNamespace = new Azure.NotificationHub.Namespace("exampleNamespace", new Azure.NotificationHub.NamespaceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            NamespaceType = "NotificationHub",
            SkuName = "Free",
        });
        var exampleHub = new Azure.NotificationHub.Hub("exampleHub", new Azure.NotificationHub.HubArgs
        {
            NamespaceName = exampleNamespace.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/notificationhub"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("Australia East"),
        })
        if err != nil {
            return err
        }
        exampleNamespace, err := notificationhub.NewNamespace(ctx, "exampleNamespace", &notificationhub.NamespaceArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            NamespaceType:     pulumi.String("NotificationHub"),
            SkuName:           pulumi.String("Free"),
        })
        if err != nil {
            return err
        }
        _, err = notificationhub.NewHub(ctx, "exampleHub", &notificationhub.HubArgs{
            NamespaceName:     exampleNamespace.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="Australia East")
example_namespace = azure.notificationhub.Namespace("exampleNamespace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    namespace_type="NotificationHub",
    sku_name="Free")
example_hub = azure.notificationhub.Hub("exampleHub",
    namespace_name=example_namespace.name,
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "Australia East"});
const exampleNamespace = new azure.notificationhub.Namespace("exampleNamespace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    namespaceType: "NotificationHub",
    skuName: "Free",
});
const exampleHub = new azure.notificationhub.Hub("exampleHub", {
    namespaceName: exampleNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});

Create a Hub Resource

new Hub(name: string, args: HubArgs, opts?: CustomResourceOptions);

def Hub(resource_name, opts=None, apns_credential=None, gcm_credential=None, location=None, name=None, namespace_name=None, resource_group_name=None, tags=None, __props__=None);

func NewHub(ctx *Context, name string, args HubArgs, opts ...ResourceOption) (*Hub, error)

public Hub(string name, HubArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args HubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Hub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Hub resource accepts the following input properties:

NamespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
ApnsCredential HubApnsCredentialArgs: A apns_credential block as defined below.
GcmCredential HubGcmCredentialArgs: A gcm_credential block as defined below.
Location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
Name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

NamespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
ApnsCredential HubApnsCredential: A apns_credential block as defined below.
GcmCredential HubGcmCredential: A gcm_credential block as defined below.
Location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
Name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

namespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
apnsCredential HubApnsCredential: A apns_credential block as defined below.
gcmCredential HubGcmCredential: A gcm_credential block as defined below.
location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

namespace_name str: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
apns_credential Dict[HubApnsCredential]: A apns_credential block as defined below.
gcm_credential Dict[HubGcmCredential]: A gcm_credential block as defined below.
location str: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
name str: The name to use for this Notification Hub. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Hub resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Hub Resource

Get an existing Hub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HubState, opts?: CustomResourceOptions): Hub

static get(resource_name, id, opts=None, apns_credential=None, gcm_credential=None, location=None, name=None, namespace_name=None, resource_group_name=None, tags=None, __props__=None);

func GetHub(ctx *Context, name string, id IDInput, state *HubState, opts ...ResourceOption) (*Hub, error)

public static Hub Get(string name, Input<string> id, HubState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApnsCredential HubApnsCredentialArgs: A apns_credential block as defined below.
GcmCredential HubGcmCredentialArgs: A gcm_credential block as defined below.
Location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
Name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
NamespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ApnsCredential HubApnsCredential: A apns_credential block as defined below.
GcmCredential HubGcmCredential: A gcm_credential block as defined below.
Location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
Name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
NamespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

apnsCredential HubApnsCredential: A apns_credential block as defined below.
gcmCredential HubGcmCredential: A gcm_credential block as defined below.
location string: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
name string: The name to use for this Notification Hub. Changing this forces a new resource to be created.
namespaceName string: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

apns_credential Dict[HubApnsCredential]: A apns_credential block as defined below.
gcm_credential Dict[HubGcmCredential]: A gcm_credential block as defined below.
location str: The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
name str: The name to use for this Notification Hub. Changing this forces a new resource to be created.
namespace_name str: The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

HubApnsCredential

See the input and output API doc for this type.

ApplicationMode string: The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.
BundleId string: The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.
KeyId string: The Apple Push Notifications Service (APNS) Key.
TeamId string: The ID of the team the Token.
Token string: The Push Token associated with the Apple Developer Account. This is the contents of the key downloaded from the Apple Developer Portal between the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- blocks.

ApplicationMode string: The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.
BundleId string: The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.
KeyId string: The Apple Push Notifications Service (APNS) Key.
TeamId string: The ID of the team the Token.
Token string: The Push Token associated with the Apple Developer Account. This is the contents of the key downloaded from the Apple Developer Portal between the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- blocks.

applicationMode string: The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.
bundleId string: The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.
keyId string: The Apple Push Notifications Service (APNS) Key.
teamId string: The ID of the team the Token.
token string: The Push Token associated with the Apple Developer Account. This is the contents of the key downloaded from the Apple Developer Portal between the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- blocks.

applicationMode str: The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.
bundleId str: The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.
keyId str: The Apple Push Notifications Service (APNS) Key.
teamId str: The ID of the team the Token.
token str: The Push Token associated with the Apple Developer Account. This is the contents of the key downloaded from the Apple Developer Portal between the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- blocks.

HubGcmCredential

See the input and output API doc for this type.

ApiKey string: The API Key associated with the Google Cloud Messaging service.

ApiKey string: The API Key associated with the Google Cloud Messaging service.

apiKey string: The API Key associated with the Google Cloud Messaging service.

api_key str: The API Key associated with the Google Cloud Messaging service.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Hub