azure-native.notificationhubs.NotificationHubAuthorizationRule
Explore with Pulumi AI
Response for POST requests that return single SharedAccessAuthorizationRule. Azure REST API version: 2023-01-01-preview. Prior API version in Azure Native 1.x: 2017-04-01.
Other available API versions: 2016-03-01, 2017-04-01, 2023-09-01, 2023-10-01-preview.
Example Usage
NotificationHubs_CreateOrUpdateAuthorizationRule
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var notificationHubAuthorizationRule = new AzureNative.NotificationHubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRule", new()
{
AuthorizationRuleName = "MyManageSharedAccessKey",
NamespaceName = "nh-sdk-ns",
NotificationHubName = "nh-sdk-hub",
Properties = new AzureNative.NotificationHubs.Inputs.SharedAccessAuthorizationRulePropertiesArgs
{
Rights = new[]
{
AzureNative.NotificationHubs.AccessRights.Listen,
AzureNative.NotificationHubs.AccessRights.Send,
},
},
ResourceGroupName = "5ktrial",
});
});
package main
import (
notificationhubs "github.com/pulumi/pulumi-azure-native-sdk/notificationhubs/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notificationhubs.NewNotificationHubAuthorizationRule(ctx, "notificationHubAuthorizationRule", ¬ificationhubs.NotificationHubAuthorizationRuleArgs{
AuthorizationRuleName: pulumi.String("MyManageSharedAccessKey"),
NamespaceName: pulumi.String("nh-sdk-ns"),
NotificationHubName: pulumi.String("nh-sdk-hub"),
Properties: ¬ificationhubs.SharedAccessAuthorizationRulePropertiesArgs{
Rights: pulumi.StringArray{
pulumi.String(notificationhubs.AccessRightsListen),
pulumi.String(notificationhubs.AccessRightsSend),
},
},
ResourceGroupName: pulumi.String("5ktrial"),
})
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.azurenative.notificationhubs.NotificationHubAuthorizationRule;
import com.pulumi.azurenative.notificationhubs.NotificationHubAuthorizationRuleArgs;
import com.pulumi.azurenative.notificationhubs.inputs.SharedAccessAuthorizationRulePropertiesArgs;
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 notificationHubAuthorizationRule = new NotificationHubAuthorizationRule("notificationHubAuthorizationRule", NotificationHubAuthorizationRuleArgs.builder()
.authorizationRuleName("MyManageSharedAccessKey")
.namespaceName("nh-sdk-ns")
.notificationHubName("nh-sdk-hub")
.properties(SharedAccessAuthorizationRulePropertiesArgs.builder()
.rights(
"Listen",
"Send")
.build())
.resourceGroupName("5ktrial")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
notification_hub_authorization_rule = azure_native.notificationhubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRule",
authorization_rule_name="MyManageSharedAccessKey",
namespace_name="nh-sdk-ns",
notification_hub_name="nh-sdk-hub",
properties={
"rights": [
azure_native.notificationhubs.AccessRights.LISTEN,
azure_native.notificationhubs.AccessRights.SEND,
],
},
resource_group_name="5ktrial")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const notificationHubAuthorizationRule = new azure_native.notificationhubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRule", {
authorizationRuleName: "MyManageSharedAccessKey",
namespaceName: "nh-sdk-ns",
notificationHubName: "nh-sdk-hub",
properties: {
rights: [
azure_native.notificationhubs.AccessRights.Listen,
azure_native.notificationhubs.AccessRights.Send,
],
},
resourceGroupName: "5ktrial",
});
resources:
notificationHubAuthorizationRule:
type: azure-native:notificationhubs:NotificationHubAuthorizationRule
properties:
authorizationRuleName: MyManageSharedAccessKey
namespaceName: nh-sdk-ns
notificationHubName: nh-sdk-hub
properties:
rights:
- Listen
- Send
resourceGroupName: 5ktrial
Create NotificationHubAuthorizationRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NotificationHubAuthorizationRule(name: string, args: NotificationHubAuthorizationRuleArgs, opts?: CustomResourceOptions);
@overload
def NotificationHubAuthorizationRule(resource_name: str,
args: NotificationHubAuthorizationRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NotificationHubAuthorizationRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
namespace_name: Optional[str] = None,
notification_hub_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
authorization_rule_name: Optional[str] = None,
location: Optional[str] = None,
properties: Optional[SharedAccessAuthorizationRulePropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewNotificationHubAuthorizationRule(ctx *Context, name string, args NotificationHubAuthorizationRuleArgs, opts ...ResourceOption) (*NotificationHubAuthorizationRule, error)
public NotificationHubAuthorizationRule(string name, NotificationHubAuthorizationRuleArgs args, CustomResourceOptions? opts = null)
public NotificationHubAuthorizationRule(String name, NotificationHubAuthorizationRuleArgs args)
public NotificationHubAuthorizationRule(String name, NotificationHubAuthorizationRuleArgs args, CustomResourceOptions options)
type: azure-native:notificationhubs:NotificationHubAuthorizationRule
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 NotificationHubAuthorizationRuleArgs
- 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 NotificationHubAuthorizationRuleArgs
- 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 NotificationHubAuthorizationRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NotificationHubAuthorizationRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NotificationHubAuthorizationRuleArgs
- 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 notificationHubAuthorizationRuleResource = new AzureNative.NotificationHubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRuleResource", new()
{
NamespaceName = "string",
NotificationHubName = "string",
ResourceGroupName = "string",
AuthorizationRuleName = "string",
Location = "string",
Properties = new AzureNative.NotificationHubs.Inputs.SharedAccessAuthorizationRulePropertiesArgs
{
Rights = new[]
{
"string",
},
PrimaryKey = "string",
SecondaryKey = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := notificationhubs.NewNotificationHubAuthorizationRule(ctx, "notificationHubAuthorizationRuleResource", ¬ificationhubs.NotificationHubAuthorizationRuleArgs{
NamespaceName: pulumi.String("string"),
NotificationHubName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
AuthorizationRuleName: pulumi.String("string"),
Location: pulumi.String("string"),
Properties: ¬ificationhubs.SharedAccessAuthorizationRulePropertiesArgs{
Rights: pulumi.StringArray{
pulumi.String("string"),
},
PrimaryKey: pulumi.String("string"),
SecondaryKey: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var notificationHubAuthorizationRuleResource = new NotificationHubAuthorizationRule("notificationHubAuthorizationRuleResource", NotificationHubAuthorizationRuleArgs.builder()
.namespaceName("string")
.notificationHubName("string")
.resourceGroupName("string")
.authorizationRuleName("string")
.location("string")
.properties(SharedAccessAuthorizationRulePropertiesArgs.builder()
.rights("string")
.primaryKey("string")
.secondaryKey("string")
.build())
.tags(Map.of("string", "string"))
.build());
notification_hub_authorization_rule_resource = azure_native.notificationhubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRuleResource",
namespace_name="string",
notification_hub_name="string",
resource_group_name="string",
authorization_rule_name="string",
location="string",
properties={
"rights": ["string"],
"primaryKey": "string",
"secondaryKey": "string",
},
tags={
"string": "string",
})
const notificationHubAuthorizationRuleResource = new azure_native.notificationhubs.NotificationHubAuthorizationRule("notificationHubAuthorizationRuleResource", {
namespaceName: "string",
notificationHubName: "string",
resourceGroupName: "string",
authorizationRuleName: "string",
location: "string",
properties: {
rights: ["string"],
primaryKey: "string",
secondaryKey: "string",
},
tags: {
string: "string",
},
});
type: azure-native:notificationhubs:NotificationHubAuthorizationRule
properties:
authorizationRuleName: string
location: string
namespaceName: string
notificationHubName: string
properties:
primaryKey: string
rights:
- string
secondaryKey: string
resourceGroupName: string
tags:
string: string
NotificationHubAuthorizationRule 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 NotificationHubAuthorizationRule resource accepts the following input properties:
- Namespace
Name string - Namespace name
- Notification
Hub stringName - Notification Hub name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- string
- Authorization Rule Name
- Location string
- Deprecated - only for compatibility.
- Properties
Pulumi.
Azure Native. Notification Hubs. Inputs. Shared Access Authorization Rule Properties - SharedAccessAuthorizationRule properties.
- Dictionary<string, string>
- Deprecated - only for compatibility.
- Namespace
Name string - Namespace name
- Notification
Hub stringName - Notification Hub name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- string
- Authorization Rule Name
- Location string
- Deprecated - only for compatibility.
- Properties
Shared
Access Authorization Rule Properties Args - SharedAccessAuthorizationRule properties.
- map[string]string
- Deprecated - only for compatibility.
- namespace
Name String - Namespace name
- notification
Hub StringName - Notification Hub name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- String
- Authorization Rule Name
- location String
- Deprecated - only for compatibility.
- properties
Shared
Access Authorization Rule Properties - SharedAccessAuthorizationRule properties.
- Map<String,String>
- Deprecated - only for compatibility.
- namespace
Name string - Namespace name
- notification
Hub stringName - Notification Hub name
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- string
- Authorization Rule Name
- location string
- Deprecated - only for compatibility.
- properties
Shared
Access Authorization Rule Properties - SharedAccessAuthorizationRule properties.
- {[key: string]: string}
- Deprecated - only for compatibility.
- namespace_
name str - Namespace name
- notification_
hub_ strname - Notification Hub name
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- str
- Authorization Rule Name
- location str
- Deprecated - only for compatibility.
- properties
Shared
Access Authorization Rule Properties Args - SharedAccessAuthorizationRule properties.
- Mapping[str, str]
- Deprecated - only for compatibility.
- namespace
Name String - Namespace name
- notification
Hub StringName - Notification Hub name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- String
- Authorization Rule Name
- location String
- Deprecated - only for compatibility.
- properties Property Map
- SharedAccessAuthorizationRule properties.
- Map<String>
- Deprecated - only for compatibility.
Outputs
All input properties are implicitly available as output properties. Additionally, the NotificationHubAuthorizationRule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Notification Hubs. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AccessRights, AccessRightsArgs
- Manage
- Manage
- Send
- Send
- Listen
- Listen
- Access
Rights Manage - Manage
- Access
Rights Send - Send
- Access
Rights Listen - Listen
- Manage
- Manage
- Send
- Send
- Listen
- Listen
- Manage
- Manage
- Send
- Send
- Listen
- Listen
- MANAGE
- Manage
- SEND
- Send
- LISTEN
- Listen
- "Manage"
- Manage
- "Send"
- Send
- "Listen"
- Listen
SharedAccessAuthorizationRuleProperties, SharedAccessAuthorizationRulePropertiesArgs
- Rights
List<Union<string, Pulumi.
Azure Native. Notification Hubs. Access Rights>> - Gets or sets the rights associated with the rule.
- Primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Rights []string
- Gets or sets the rights associated with the rule.
- Primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- rights
List<Either<String,Access
Rights>> - Gets or sets the rights associated with the rule.
- primary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- rights
(string | Access
Rights)[] - Gets or sets the rights associated with the rule.
- primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- rights
Sequence[Union[str, Access
Rights]] - Gets or sets the rights associated with the rule.
- primary_
key str - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary_
key str - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- rights List<String | "Manage" | "Send" | "Listen">
- Gets or sets the rights associated with the rule.
- primary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
SharedAccessAuthorizationRulePropertiesResponse, SharedAccessAuthorizationRulePropertiesResponseArgs
- Claim
Type string - Gets a string that describes the claim type
- Claim
Value string - Gets a string that describes the claim value
- Created
Time string - Gets the created time for this rule
- Key
Name string - Gets a string that describes the authorization rule.
- Modified
Time string - Gets the last modified time for this rule
- Revision int
- Gets the revision number for the rule
- Rights List<string>
- Gets or sets the rights associated with the rule.
- Primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Claim
Type string - Gets a string that describes the claim type
- Claim
Value string - Gets a string that describes the claim value
- Created
Time string - Gets the created time for this rule
- Key
Name string - Gets a string that describes the authorization rule.
- Modified
Time string - Gets the last modified time for this rule
- Revision int
- Gets the revision number for the rule
- Rights []string
- Gets or sets the rights associated with the rule.
- Primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- Secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- claim
Type String - Gets a string that describes the claim type
- claim
Value String - Gets a string that describes the claim value
- created
Time String - Gets the created time for this rule
- key
Name String - Gets a string that describes the authorization rule.
- modified
Time String - Gets the last modified time for this rule
- revision Integer
- Gets the revision number for the rule
- rights List<String>
- Gets or sets the rights associated with the rule.
- primary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- claim
Type string - Gets a string that describes the claim type
- claim
Value string - Gets a string that describes the claim value
- created
Time string - Gets the created time for this rule
- key
Name string - Gets a string that describes the authorization rule.
- modified
Time string - Gets the last modified time for this rule
- revision number
- Gets the revision number for the rule
- rights string[]
- Gets or sets the rights associated with the rule.
- primary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key string - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- claim_
type str - Gets a string that describes the claim type
- claim_
value str - Gets a string that describes the claim value
- created_
time str - Gets the created time for this rule
- key_
name str - Gets a string that describes the authorization rule.
- modified_
time str - Gets the last modified time for this rule
- revision int
- Gets the revision number for the rule
- rights Sequence[str]
- Gets or sets the rights associated with the rule.
- primary_
key str - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary_
key str - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- claim
Type String - Gets a string that describes the claim type
- claim
Value String - Gets a string that describes the claim value
- created
Time String - Gets the created time for this rule
- key
Name String - Gets a string that describes the authorization rule.
- modified
Time String - Gets the last modified time for this rule
- revision Number
- Gets the revision number for the rule
- rights List<String>
- Gets or sets the rights associated with the rule.
- primary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary
Key String - Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:notificationhubs:NotificationHubAuthorizationRule MyManageSharedAccessKey /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0