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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.notificationhub.Namespace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages 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",
    });
    
    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    		}
    		_, 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
    		}
    		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",
        });
    
    });
    
    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 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());
    
        }
    }
    
    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
    

    Create Namespace Resource

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

    Constructor syntax

    new Namespace(name: string, args: NamespaceArgs, opts?: CustomResourceOptions);
    @overload
    def Namespace(resource_name: str,
                  args: NamespaceArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Namespace(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  namespace_type: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  sku_name: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  location: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewNamespace(ctx *Context, name string, args NamespaceArgs, opts ...ResourceOption) (*Namespace, error)
    public Namespace(string name, NamespaceArgs args, CustomResourceOptions? opts = null)
    public Namespace(String name, NamespaceArgs args)
    public Namespace(String name, NamespaceArgs args, CustomResourceOptions options)
    
    type: azure:notificationhub:Namespace
    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 NamespaceArgs
    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 NamespaceArgs
    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 NamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var namespaceResource = new Azure.NotificationHub.Namespace("namespaceResource", new()
    {
        NamespaceType = "string",
        ResourceGroupName = "string",
        SkuName = "string",
        Enabled = false,
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := notificationhub.NewNamespace(ctx, "namespaceResource", &notificationhub.NamespaceArgs{
    	NamespaceType:     pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	SkuName:           pulumi.String("string"),
    	Enabled:           pulumi.Bool(false),
    	Location:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var namespaceResource = new Namespace("namespaceResource", NamespaceArgs.builder()
        .namespaceType("string")
        .resourceGroupName("string")
        .skuName("string")
        .enabled(false)
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    namespace_resource = azure.notificationhub.Namespace("namespaceResource",
        namespace_type="string",
        resource_group_name="string",
        sku_name="string",
        enabled=False,
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const namespaceResource = new azure.notificationhub.Namespace("namespaceResource", {
        namespaceType: "string",
        resourceGroupName: "string",
        skuName: "string",
        enabled: false,
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:notificationhub:Namespace
    properties:
        enabled: false
        location: string
        name: string
        namespaceType: string
        resourceGroupName: string
        skuName: string
        tags:
            string: string
    

    Namespace Resource Properties

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

    Inputs

    The Namespace resource accepts the following input properties:

    NamespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    ResourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    SkuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    Enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    Location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    Name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    NamespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    ResourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    SkuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    Enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    Location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    Name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    namespaceType String
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName String
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    skuName String
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    enabled Boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location String
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name String
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    namespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    skuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    enabled boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    namespace_type str
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resource_group_name str
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    sku_name str
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    location str
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name str
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    namespaceType String
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName String
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    skuName String
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    enabled Boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location String
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name String
    The name to use for this Notification Hub Namespace. 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 Namespace resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ServicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    id String
    The provider-assigned unique ID for this managed resource.
    servicebusEndpoint String
    The ServiceBus Endpoint for this Notification Hub Namespace.
    id string
    The provider-assigned unique ID for this managed resource.
    servicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    id str
    The provider-assigned unique ID for this managed resource.
    servicebus_endpoint str
    The ServiceBus Endpoint for this Notification Hub Namespace.
    id String
    The provider-assigned unique ID for this managed resource.
    servicebusEndpoint String
    The ServiceBus Endpoint for this Notification Hub Namespace.

    Look up Existing Namespace Resource

    Get an existing Namespace 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?: NamespaceState, opts?: CustomResourceOptions): Namespace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            namespace_type: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            servicebus_endpoint: Optional[str] = None,
            sku_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Namespace
    func GetNamespace(ctx *Context, name string, id IDInput, state *NamespaceState, opts ...ResourceOption) (*Namespace, error)
    public static Namespace Get(string name, Input<string> id, NamespaceState? state, CustomResourceOptions? opts = null)
    public static Namespace get(String name, Output<String> id, NamespaceState 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:
    Enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    Location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    Name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    NamespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    ResourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    ServicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    SkuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    Location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    Name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    NamespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    ResourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    ServicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    SkuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    enabled Boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location String
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name String
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    namespaceType String
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName String
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    servicebusEndpoint String
    The ServiceBus Endpoint for this Notification Hub Namespace.
    skuName String
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    enabled boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location string
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name string
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    namespaceType string
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName string
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    servicebusEndpoint string
    The ServiceBus Endpoint for this Notification Hub Namespace.
    skuName string
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    enabled bool
    Is this Notification Hub Namespace enabled? Defaults to true.
    location str
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name str
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    namespace_type str
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resource_group_name str
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    servicebus_endpoint str
    The ServiceBus Endpoint for this Notification Hub Namespace.
    sku_name str
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    enabled Boolean
    Is this Notification Hub Namespace enabled? Defaults to true.
    location String
    The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
    name String
    The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
    namespaceType String
    The Type of Namespace - possible values are Messaging or NotificationHub.
    resourceGroupName String
    The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
    servicebusEndpoint String
    The ServiceBus Endpoint for this Notification Hub Namespace.
    skuName String
    The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

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

    $ pulumi import azure:notificationhub/namespace:Namespace namespace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1
    

    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 Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi