1. Packages
  2. Azure Classic
  3. API Docs
  4. notificationhub
  5. Hub

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.notificationhub.Hub

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages a Notification Hub within a Notification Hub Namespace.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "notificationhub-resources",
        location: "West Europe",
    });
    const exampleNamespace = new azure.notificationhub.Namespace("example", {
        name: "myappnamespace",
        resourceGroupName: example.name,
        location: example.location,
        namespaceType: "NotificationHub",
        skuName: "Free",
    });
    const exampleHub = new azure.notificationhub.Hub("example", {
        name: "mynotificationhub",
        namespaceName: exampleNamespace.name,
        resourceGroupName: example.name,
        location: example.location,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="notificationhub-resources",
        location="West Europe")
    example_namespace = azure.notificationhub.Namespace("example",
        name="myappnamespace",
        resource_group_name=example.name,
        location=example.location,
        namespace_type="NotificationHub",
        sku_name="Free")
    example_hub = azure.notificationhub.Hub("example",
        name="mynotificationhub",
        namespace_name=example_namespace.name,
        resource_group_name=example.name,
        location=example.location)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/notificationhub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("notificationhub-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNamespace, err := notificationhub.NewNamespace(ctx, "example", &notificationhub.NamespaceArgs{
    			Name:              pulumi.String("myappnamespace"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			NamespaceType:     pulumi.String("NotificationHub"),
    			SkuName:           pulumi.String("Free"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = notificationhub.NewHub(ctx, "example", &notificationhub.HubArgs{
    			Name:              pulumi.String("mynotificationhub"),
    			NamespaceName:     exampleNamespace.Name,
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "notificationhub-resources",
            Location = "West Europe",
        });
    
        var exampleNamespace = new Azure.NotificationHub.Namespace("example", new()
        {
            Name = "myappnamespace",
            ResourceGroupName = example.Name,
            Location = example.Location,
            NamespaceType = "NotificationHub",
            SkuName = "Free",
        });
    
        var exampleHub = new Azure.NotificationHub.Hub("example", new()
        {
            Name = "mynotificationhub",
            NamespaceName = exampleNamespace.Name,
            ResourceGroupName = example.Name,
            Location = example.Location,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.notificationhub.Namespace;
    import com.pulumi.azure.notificationhub.NamespaceArgs;
    import com.pulumi.azure.notificationhub.Hub;
    import com.pulumi.azure.notificationhub.HubArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("notificationhub-resources")
                .location("West Europe")
                .build());
    
            var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
                .name("myappnamespace")
                .resourceGroupName(example.name())
                .location(example.location())
                .namespaceType("NotificationHub")
                .skuName("Free")
                .build());
    
            var exampleHub = new Hub("exampleHub", HubArgs.builder()
                .name("mynotificationhub")
                .namespaceName(exampleNamespace.name())
                .resourceGroupName(example.name())
                .location(example.location())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: notificationhub-resources
          location: West Europe
      exampleNamespace:
        type: azure:notificationhub:Namespace
        name: example
        properties:
          name: myappnamespace
          resourceGroupName: ${example.name}
          location: ${example.location}
          namespaceType: NotificationHub
          skuName: Free
      exampleHub:
        type: azure:notificationhub:Hub
        name: example
        properties:
          name: mynotificationhub
          namespaceName: ${exampleNamespace.name}
          resourceGroupName: ${example.name}
          location: ${example.location}
    

    Create Hub Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Hub(name: string, args: HubArgs, opts?: CustomResourceOptions);
    @overload
    def Hub(resource_name: str,
            args: HubArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Hub(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            namespace_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            apns_credential: Optional[HubApnsCredentialArgs] = None,
            browser_credential: Optional[HubBrowserCredentialArgs] = None,
            gcm_credential: Optional[HubGcmCredentialArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewHub(ctx *Context, name string, args HubArgs, opts ...ResourceOption) (*Hub, error)
    public Hub(string name, HubArgs args, CustomResourceOptions? opts = null)
    public Hub(String name, HubArgs args)
    public Hub(String name, HubArgs args, CustomResourceOptions options)
    
    type: azure:notificationhub:Hub
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.
    args HubArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hubResource = new Azure.NotificationHub.Hub("hubResource", new()
    {
        NamespaceName = "string",
        ResourceGroupName = "string",
        ApnsCredential = new Azure.NotificationHub.Inputs.HubApnsCredentialArgs
        {
            ApplicationMode = "string",
            BundleId = "string",
            KeyId = "string",
            TeamId = "string",
            Token = "string",
        },
        BrowserCredential = new Azure.NotificationHub.Inputs.HubBrowserCredentialArgs
        {
            Subject = "string",
            VapidPrivateKey = "string",
            VapidPublicKey = "string",
        },
        GcmCredential = new Azure.NotificationHub.Inputs.HubGcmCredentialArgs
        {
            ApiKey = "string",
        },
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := notificationhub.NewHub(ctx, "hubResource", &notificationhub.HubArgs{
    	NamespaceName:     pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	ApnsCredential: &notificationhub.HubApnsCredentialArgs{
    		ApplicationMode: pulumi.String("string"),
    		BundleId:        pulumi.String("string"),
    		KeyId:           pulumi.String("string"),
    		TeamId:          pulumi.String("string"),
    		Token:           pulumi.String("string"),
    	},
    	BrowserCredential: &notificationhub.HubBrowserCredentialArgs{
    		Subject:         pulumi.String("string"),
    		VapidPrivateKey: pulumi.String("string"),
    		VapidPublicKey:  pulumi.String("string"),
    	},
    	GcmCredential: &notificationhub.HubGcmCredentialArgs{
    		ApiKey: pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var hubResource = new Hub("hubResource", HubArgs.builder()
        .namespaceName("string")
        .resourceGroupName("string")
        .apnsCredential(HubApnsCredentialArgs.builder()
            .applicationMode("string")
            .bundleId("string")
            .keyId("string")
            .teamId("string")
            .token("string")
            .build())
        .browserCredential(HubBrowserCredentialArgs.builder()
            .subject("string")
            .vapidPrivateKey("string")
            .vapidPublicKey("string")
            .build())
        .gcmCredential(HubGcmCredentialArgs.builder()
            .apiKey("string")
            .build())
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    hub_resource = azure.notificationhub.Hub("hubResource",
        namespace_name="string",
        resource_group_name="string",
        apns_credential={
            "application_mode": "string",
            "bundle_id": "string",
            "key_id": "string",
            "team_id": "string",
            "token": "string",
        },
        browser_credential={
            "subject": "string",
            "vapid_private_key": "string",
            "vapid_public_key": "string",
        },
        gcm_credential={
            "api_key": "string",
        },
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const hubResource = new azure.notificationhub.Hub("hubResource", {
        namespaceName: "string",
        resourceGroupName: "string",
        apnsCredential: {
            applicationMode: "string",
            bundleId: "string",
            keyId: "string",
            teamId: "string",
            token: "string",
        },
        browserCredential: {
            subject: "string",
            vapidPrivateKey: "string",
            vapidPublicKey: "string",
        },
        gcmCredential: {
            apiKey: "string",
        },
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:notificationhub:Hub
    properties:
        apnsCredential:
            applicationMode: string
            bundleId: string
            keyId: string
            teamId: string
            token: string
        browserCredential:
            subject: string
            vapidPrivateKey: string
            vapidPublicKey: string
        gcmCredential:
            apiKey: string
        location: string
        name: string
        namespaceName: string
        resourceGroupName: string
        tags:
            string: string
    

    Hub Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 HubApnsCredential

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    BrowserCredential HubBrowserCredential
    A browser_credential block as defined below.
    GcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 HubApnsCredentialArgs

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    BrowserCredential HubBrowserCredentialArgs
    A browser_credential block as defined below.
    GcmCredential HubGcmCredentialArgs

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential HubBrowserCredential
    A browser_credential block as defined below.
    gcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential HubBrowserCredential
    A browser_credential block as defined below.
    gcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 HubApnsCredentialArgs

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browser_credential HubBrowserCredentialArgs
    A browser_credential block as defined below.
    gcm_credential HubGcmCredentialArgs

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 Mapping[str, str]
    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 Property Map

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential Property Map
    A browser_credential block as defined below.
    gcmCredential Property Map

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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>
    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apns_credential: Optional[HubApnsCredentialArgs] = None,
            browser_credential: Optional[HubBrowserCredentialArgs] = None,
            gcm_credential: Optional[HubGcmCredentialArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            namespace_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Hub
    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)
    public static Hub get(String name, Output<String> id, HubState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 HubApnsCredential

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    BrowserCredential HubBrowserCredential
    A browser_credential block as defined below.
    GcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 HubApnsCredentialArgs

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    BrowserCredential HubBrowserCredentialArgs
    A browser_credential block as defined below.
    GcmCredential HubGcmCredentialArgs

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential HubBrowserCredential
    A browser_credential block as defined below.
    gcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential HubBrowserCredential
    A browser_credential block as defined below.
    gcmCredential HubGcmCredential

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 HubApnsCredentialArgs

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browser_credential HubBrowserCredentialArgs
    A browser_credential block as defined below.
    gcm_credential HubGcmCredentialArgs

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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 Mapping[str, str]
    A mapping of tags to assign to the resource.
    apnsCredential Property Map

    A apns_credential block as defined below.

    NOTE: Removing the apns_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    browserCredential Property Map
    A browser_credential block as defined below.
    gcmCredential Property Map

    A gcm_credential block as defined below.

    NOTE: Removing the gcm_credential block will currently force a recreation of this resource due to this bug in the Azure SDK for Go - we'll remove this limitation when the SDK bug is fixed.

    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>
    A mapping of tags to assign to the resource.

    Supporting Types

    HubApnsCredential, HubApnsCredentialArgs

    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 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.
    application_mode str
    The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.
    bundle_id str
    The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.
    key_id str
    The Apple Push Notifications Service (APNS) Key.
    team_id 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.
    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.

    HubBrowserCredential, HubBrowserCredentialArgs

    Subject string
    The subject name of web push.
    VapidPrivateKey string
    The Voluntary Application Server Identification (VAPID) private key.
    VapidPublicKey string
    The Voluntary Application Server Identification (VAPID) public key.
    Subject string
    The subject name of web push.
    VapidPrivateKey string
    The Voluntary Application Server Identification (VAPID) private key.
    VapidPublicKey string
    The Voluntary Application Server Identification (VAPID) public key.
    subject String
    The subject name of web push.
    vapidPrivateKey String
    The Voluntary Application Server Identification (VAPID) private key.
    vapidPublicKey String
    The Voluntary Application Server Identification (VAPID) public key.
    subject string
    The subject name of web push.
    vapidPrivateKey string
    The Voluntary Application Server Identification (VAPID) private key.
    vapidPublicKey string
    The Voluntary Application Server Identification (VAPID) public key.
    subject str
    The subject name of web push.
    vapid_private_key str
    The Voluntary Application Server Identification (VAPID) private key.
    vapid_public_key str
    The Voluntary Application Server Identification (VAPID) public key.
    subject String
    The subject name of web push.
    vapidPrivateKey String
    The Voluntary Application Server Identification (VAPID) private key.
    vapidPublicKey String
    The Voluntary Application Server Identification (VAPID) public key.

    HubGcmCredential, HubGcmCredentialArgs

    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.
    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.
    apiKey String
    The API Key associated with the Google Cloud Messaging service.

    Import

    Notification Hubs can be imported using the resource id, e.g.

    $ pulumi import azure:notificationhub/hub:Hub hub1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1/notificationHubs/hub1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi