Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

AuthorizationRule

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleNamespace = new Azure.NotificationHub.Namespace("exampleNamespace", new Azure.NotificationHub.NamespaceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            NamespaceType = "NotificationHub",
            SkuName = "Free",
        });
        var exampleHub = new Azure.NotificationHub.Hub("exampleHub", new Azure.NotificationHub.HubArgs
        {
            NamespaceName = exampleNamespace.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var exampleAuthorizationRule = new Azure.NotificationHub.AuthorizationRule("exampleAuthorizationRule", new Azure.NotificationHub.AuthorizationRuleArgs
        {
            NotificationHubName = exampleHub.Name,
            NamespaceName = exampleNamespace.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Manage = true,
            Send = true,
            Listen = true,
        });
    }

}
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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := notificationhub.NewNamespace(ctx, "exampleNamespace", &notificationhub.NamespaceArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			NamespaceType:     pulumi.String("NotificationHub"),
			SkuName:           pulumi.String("Free"),
		})
		if err != nil {
			return err
		}
		exampleHub, err := notificationhub.NewHub(ctx, "exampleHub", &notificationhub.HubArgs{
			NamespaceName:     exampleNamespace.Name,
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
		})
		if err != nil {
			return err
		}
		_, err = notificationhub.NewAuthorizationRule(ctx, "exampleAuthorizationRule", &notificationhub.AuthorizationRuleArgs{
			NotificationHubName: exampleHub.Name,
			NamespaceName:       exampleNamespace.Name,
			ResourceGroupName:   exampleResourceGroup.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .namespaceType("NotificationHub")
            .skuName("Free")
            .build());

        var exampleHub = new Hub("exampleHub", HubArgs.builder()        
            .namespaceName(exampleNamespace.name())
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .build());

        var exampleAuthorizationRule = new AuthorizationRule("exampleAuthorizationRule", AuthorizationRuleArgs.builder()        
            .notificationHubName(exampleHub.name())
            .namespaceName(exampleNamespace.name())
            .resourceGroupName(exampleResourceGroup.name())
            .manage(true)
            .send(true)
            .listen(true)
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.notificationhub.Namespace("exampleNamespace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    namespace_type="NotificationHub",
    sku_name="Free")
example_hub = azure.notificationhub.Hub("exampleHub",
    namespace_name=example_namespace.name,
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_authorization_rule = azure.notificationhub.AuthorizationRule("exampleAuthorizationRule",
    notification_hub_name=example_hub.name,
    namespace_name=example_namespace.name,
    resource_group_name=example_resource_group.name,
    manage=True,
    send=True,
    listen=True)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
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,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleNamespace:
    type: azure:notificationhub:Namespace
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      namespaceType: NotificationHub
      skuName: Free
  exampleHub:
    type: azure:notificationhub:Hub
    properties:
      namespaceName: ${exampleNamespace.name}
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
  exampleAuthorizationRule:
    type: azure:notificationhub:AuthorizationRule
    properties:
      notificationHubName: ${exampleHub.name}
      namespaceName: ${exampleNamespace.name}
      resourceGroupName: ${exampleResourceGroup.name}
      manage: true
      send: true
      listen: true

Create a AuthorizationRule Resource

new AuthorizationRule(name: string, args: AuthorizationRuleArgs, opts?: CustomResourceOptions);
@overload
def AuthorizationRule(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      listen: Optional[bool] = None,
                      manage: Optional[bool] = None,
                      name: Optional[str] = None,
                      namespace_name: Optional[str] = None,
                      notification_hub_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      send: Optional[bool] = None)
@overload
def AuthorizationRule(resource_name: str,
                      args: AuthorizationRuleArgs,
                      opts: Optional[ResourceOptions] = None)
func NewAuthorizationRule(ctx *Context, name string, args AuthorizationRuleArgs, opts ...ResourceOption) (*AuthorizationRule, error)
public AuthorizationRule(string name, AuthorizationRuleArgs args, CustomResourceOptions? opts = null)
public AuthorizationRule(String name, AuthorizationRuleArgs args)
public AuthorizationRule(String name, AuthorizationRuleArgs args, CustomResourceOptions options)
type: azure:notificationhub:AuthorizationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

AuthorizationRule 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 AuthorizationRule resource accepts the following input properties:

NamespaceName string

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

NotificationHubName string

The name of the Notification Hub for which the Authorization Rule should be created. 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.

Listen bool

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

Manage bool

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

Name string

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

Send bool

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

NamespaceName string

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

NotificationHubName string

The name of the Notification Hub for which the Authorization Rule should be created. 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.

Listen bool

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

Manage bool

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

Name string

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

Send bool

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

namespaceName String

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

notificationHubName String

The name of the Notification Hub for which the Authorization Rule should be created. 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.

listen Boolean

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

manage Boolean

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

name String

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

send Boolean

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

namespaceName string

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

notificationHubName string

The name of the Notification Hub for which the Authorization Rule should be created. 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.

listen boolean

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

manage boolean

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

name string

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

send boolean

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

namespace_name str

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

notification_hub_name str

The name of the Notification Hub for which the Authorization Rule should be created. 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.

listen bool

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

manage bool

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

name str

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

send bool

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

namespaceName String

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

notificationHubName String

The name of the Notification Hub for which the Authorization Rule should be created. 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.

listen Boolean

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

manage Boolean

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

name String

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

send Boolean

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

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

PrimaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

SecondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

Id string

The provider-assigned unique ID for this managed resource.

PrimaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

SecondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

id String

The provider-assigned unique ID for this managed resource.

primaryAccessKey String

The Primary Access Key associated with this Authorization Rule.

secondaryAccessKey String

The Secondary Access Key associated with this Authorization Rule.

id string

The provider-assigned unique ID for this managed resource.

primaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

secondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

id str

The provider-assigned unique ID for this managed resource.

primary_access_key str

The Primary Access Key associated with this Authorization Rule.

secondary_access_key str

The Secondary Access Key associated with this Authorization Rule.

id String

The provider-assigned unique ID for this managed resource.

primaryAccessKey String

The Primary Access Key associated with this Authorization Rule.

secondaryAccessKey String

The Secondary Access Key associated with this Authorization Rule.

Look up an Existing AuthorizationRule Resource

Get an existing AuthorizationRule 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?: AuthorizationRuleState, opts?: CustomResourceOptions): AuthorizationRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        listen: Optional[bool] = None,
        manage: Optional[bool] = None,
        name: Optional[str] = None,
        namespace_name: Optional[str] = None,
        notification_hub_name: Optional[str] = None,
        primary_access_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        send: Optional[bool] = None) -> AuthorizationRule
func GetAuthorizationRule(ctx *Context, name string, id IDInput, state *AuthorizationRuleState, opts ...ResourceOption) (*AuthorizationRule, error)
public static AuthorizationRule Get(string name, Input<string> id, AuthorizationRuleState? state, CustomResourceOptions? opts = null)
public static AuthorizationRule get(String name, Output<String> id, AuthorizationRuleState 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:
Listen bool

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

Manage bool

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

Name string

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

NamespaceName string

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

NotificationHubName string

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

PrimaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

ResourceGroupName string

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

SecondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

Send bool

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

Listen bool

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

Manage bool

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

Name string

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

NamespaceName string

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

NotificationHubName string

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

PrimaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

ResourceGroupName string

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

SecondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

Send bool

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

listen Boolean

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

manage Boolean

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

name String

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

namespaceName String

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

notificationHubName String

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

primaryAccessKey String

The Primary Access Key associated with this Authorization Rule.

resourceGroupName String

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

secondaryAccessKey String

The Secondary Access Key associated with this Authorization Rule.

send Boolean

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

listen boolean

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

manage boolean

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

name string

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

namespaceName string

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

notificationHubName string

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

primaryAccessKey string

The Primary Access Key associated with this Authorization Rule.

resourceGroupName string

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

secondaryAccessKey string

The Secondary Access Key associated with this Authorization Rule.

send boolean

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

listen bool

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

manage bool

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

name str

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

namespace_name str

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

notification_hub_name str

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

primary_access_key str

The Primary Access Key associated with this Authorization Rule.

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.

secondary_access_key str

The Secondary Access Key associated with this Authorization Rule.

send bool

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

listen Boolean

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

manage Boolean

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

name String

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

namespaceName String

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

notificationHubName String

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

primaryAccessKey String

The Primary Access Key associated with this Authorization Rule.

resourceGroupName String

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

secondaryAccessKey String

The Secondary Access Key associated with this Authorization Rule.

send Boolean

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.