AuthorizationRule

class AuthorizationRule : KotlinCustomResource

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 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,
});
const exampleAuthorizationRule = new azure.notificationhub.AuthorizationRule("example", {
name: "management-auth-rule",
notificationHubName: exampleHub.name,
namespaceName: exampleNamespace.name,
resourceGroupName: example.name,
manage: true,
send: true,
listen: true,
});
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)
example_authorization_rule = azure.notificationhub.AuthorizationRule("example",
name="management-auth-rule",
notification_hub_name=example_hub.name,
namespace_name=example_namespace.name,
resource_group_name=example.name,
manage=True,
send=True,
listen=True)
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,
});
var exampleAuthorizationRule = new Azure.NotificationHub.AuthorizationRule("example", new()
{
Name = "management-auth-rule",
NotificationHubName = exampleHub.Name,
NamespaceName = exampleNamespace.Name,
ResourceGroupName = example.Name,
Manage = true,
Send = true,
Listen = true,
});
});
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
}
exampleHub, 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
}
_, err = notificationhub.NewAuthorizationRule(ctx, "example", &notificationhub.AuthorizationRuleArgs{
Name: pulumi.String("management-auth-rule"),
NotificationHubName: exampleHub.Name,
NamespaceName: exampleNamespace.Name,
ResourceGroupName: example.Name,
Manage: pulumi.Bool(true),
Send: pulumi.Bool(true),
Listen: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.azure.notificationhub.AuthorizationRule;
import com.pulumi.azure.notificationhub.AuthorizationRuleArgs;
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());
var exampleAuthorizationRule = new AuthorizationRule("exampleAuthorizationRule", AuthorizationRuleArgs.builder()
.name("management-auth-rule")
.notificationHubName(exampleHub.name())
.namespaceName(exampleNamespace.name())
.resourceGroupName(example.name())
.manage(true)
.send(true)
.listen(true)
.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}
exampleAuthorizationRule:
type: azure:notificationhub:AuthorizationRule
name: example
properties:
name: management-auth-rule
notificationHubName: ${exampleHub.name}
namespaceName: ${exampleNamespace.name}
resourceGroupName: ${example.name}
manage: true
send: true
listen: true

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.NotificationHubs: 2023-09-01

Import

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

$ pulumi import azure:notificationhub/authorizationRule:AuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1/notificationHubs/hub1/authorizationRules/rule1

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val listen: Output<Boolean>?

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

Link copied to clipboard
val manage: Output<Boolean>?

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

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard
val namespaceName: Output<String>

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

Link copied to clipboard

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

Link copied to clipboard

The Primary Access Key associated with this Authorization Rule.

Link copied to clipboard

The Primary Connetion String associated with this Authorization Rule.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The Secondary Access Key associated with this Authorization Rule.

Link copied to clipboard

The Secondary Connetion String associated with this Authorization Rule.

Link copied to clipboard
val send: Output<Boolean>?

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

Link copied to clipboard
val urn: Output<String>