Module notificationhub

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Resource AuthorizationRule

class AuthorizationRule extends CustomResource

Manages an Authorization Rule associated with a Notification Hub within a Notification Hub Namespace.

Example Usage

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,
});
const exampleAuthorizationRule = new azure.notificationhub.AuthorizationRule("exampleAuthorizationRule", {
    notificationHubName: exampleHub.name,
    namespaceName: exampleNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    manage: true,
    send: true,
    listen: true,
});

constructor

new AuthorizationRule(name: string, args: AuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthorizationRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthorizationRuleState, opts?: pulumi.CustomResourceOptions): AuthorizationRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthorizationRule

Returns true if the given object is an instance of AuthorizationRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property listen

public listen: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

property manage

public manage: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

property name

public name: pulumi.Output<string>;

The name to use for this Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

property notificationHubName

public notificationHubName: pulumi.Output<string>;

The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The Primary Access Key associated with this Authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The Secondary Access Key associated with this Authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Hub

class Hub extends CustomResource

Manages a Notification Hub within a Notification Hub Namespace.

Example Usage

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,
});

constructor

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

Create a Hub resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Hub

Returns true if the given object is an instance of Hub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apnsCredential

public apnsCredential: pulumi.Output<HubApnsCredential | undefined>;

A apnsCredential block as defined below.

property gcmCredential

public gcmCredential: pulumi.Output<HubGcmCredential | undefined>;

A gcmCredential block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name to use for this Notification Hub. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Namespace

class Namespace extends CustomResource

Manages a Notification Hub Namespace.

Example Usage

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",
});

constructor

new Namespace(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a Namespace resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Namespace

Returns true if the given object is an instance of Namespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Is this Notification Hub Namespace enabled? Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The Azure Region in which this Notification Hub Namespace should be created.

property name

public name: pulumi.Output<string>;

The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

property namespaceType

public namespaceType: pulumi.Output<string>;

The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

property servicebusEndpoint

public servicebusEndpoint: pulumi.Output<string>;

The ServiceBus Endpoint for this Notification Hub Namespace.

property skuName

public skuName: pulumi.Output<string>;

The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getHub

getHub(args: GetHubArgs, opts?: pulumi.InvokeOptions): Promise<GetHubResult>

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

Example Usage

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

const example = azure.notificationhub.getHub({
    name: "notification-hub",
    namespaceName: "namespace-name",
    resourceGroupName: "resource-group-name",
});
export const id = example.then(example => example.id);

Function getNamespace

getNamespace(args: GetNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceResult>

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

Example Usage

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

const example = azure.notificationhub.getNamespace({
    name: "my-namespace",
    resourceGroupName: "my-resource-group",
});
export const servicebusEndpoint = example.then(example => example.servicebusEndpoint);

Others

interface AuthorizationRuleArgs

interface AuthorizationRuleArgs

The set of arguments for constructing a AuthorizationRule resource.

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

property name

name?: pulumi.Input<string>;

The name to use for this Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

property notificationHubName

notificationHubName: pulumi.Input<string>;

The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

interface AuthorizationRuleState

interface AuthorizationRuleState

Input properties used for looking up and filtering AuthorizationRule resources.

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

property name

name?: pulumi.Input<string>;

The name to use for this Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

property notificationHubName

notificationHubName?: pulumi.Input<string>;

The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The Primary Access Key associated with this Authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The Secondary Access Key associated with this Authorization Rule.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

interface GetHubArgs

interface GetHubArgs

A collection of arguments for invoking getHub.

property name

name: string;

Specifies the Name of the Notification Hub.

property namespaceName

namespaceName: string;

Specifies the Name of the Notification Hub Namespace which contains the Notification Hub.

property resourceGroupName

resourceGroupName: string;

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

interface GetHubResult

interface GetHubResult

A collection of values returned by getHub.

property apnsCredentials

apnsCredentials: GetHubApnsCredential[];

A apnsCredential block as defined below.

property gcmCredentials

gcmCredentials: GetHubGcmCredential[];

A gcmCredential block as defined below.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region in which this Notification Hub exists.

property name

name: string;

property namespaceName

namespaceName: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the resource.

interface GetNamespaceArgs

interface GetNamespaceArgs

A collection of arguments for invoking getNamespace.

property name

name: string;

Specifies the Name of the Notification Hub Namespace.

property resourceGroupName

resourceGroupName: string;

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

interface GetNamespaceResult

interface GetNamespaceResult

A collection of values returned by getNamespace.

property enabled

enabled: boolean;

Is this Notification Hub Namespace enabled?

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region in which this Notification Hub Namespace exists.

property name

name: string;

The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.

property namespaceType

namespaceType: string;

The Type of Namespace, such as Messaging or NotificationHub.

property resourceGroupName

resourceGroupName: string;

property servicebusEndpoint

servicebusEndpoint: string;

property sku

sku: GetNamespaceSku;

A sku block as defined below.

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the resource.

interface HubArgs

interface HubArgs

The set of arguments for constructing a Hub resource.

property apnsCredential

apnsCredential?: pulumi.Input<HubApnsCredential>;

A apnsCredential block as defined below.

property gcmCredential

gcmCredential?: pulumi.Input<HubGcmCredential>;

A gcmCredential block as defined below.

property location

location?: pulumi.Input<string>;

The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name to use for this Notification Hub. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface HubState

interface HubState

Input properties used for looking up and filtering Hub resources.

property apnsCredential

apnsCredential?: pulumi.Input<HubApnsCredential>;

A apnsCredential block as defined below.

property gcmCredential

gcmCredential?: pulumi.Input<HubGcmCredential>;

A gcmCredential block as defined below.

property location

location?: pulumi.Input<string>;

The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name to use for this Notification Hub. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NamespaceArgs

interface NamespaceArgs

The set of arguments for constructing a Namespace resource.

property enabled

enabled?: pulumi.Input<boolean>;

Is this Notification Hub Namespace enabled? Defaults to true.

property location

location?: pulumi.Input<string>;

The Azure Region in which this Notification Hub Namespace should be created.

property name

name?: pulumi.Input<string>;

The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

property namespaceType

namespaceType: pulumi.Input<string>;

The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

property skuName

skuName: pulumi.Input<string>;

The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NamespaceState

interface NamespaceState

Input properties used for looking up and filtering Namespace resources.

property enabled

enabled?: pulumi.Input<boolean>;

Is this Notification Hub Namespace enabled? Defaults to true.

property location

location?: pulumi.Input<string>;

The Azure Region in which this Notification Hub Namespace should be created.

property name

name?: pulumi.Input<string>;

The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

property namespaceType

namespaceType?: pulumi.Input<string>;

The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

property servicebusEndpoint

servicebusEndpoint?: pulumi.Input<string>;

The ServiceBus Endpoint for this Notification Hub Namespace.

property skuName

skuName?: pulumi.Input<string>;

The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module notificationhub

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Others