Microsoft.NotificationHubs namespaces/notificationHubs/authorizationRules 2023-10-01-preview

  • Article

Bicep resource definition

The namespaces/notificationHubs/authorizationRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules@2023-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    primaryKey: 'string'
    rights: [
      'string'
    ]
    secondaryKey: 'string'
  }
}

Property values

namespaces/notificationHubs/authorizationRules

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-256

Valid characters:
Alphanumerics, periods, hyphens, and underscores.

Start alphanumeric.
location Deprecated - only for compatibility. string
tags Deprecated - only for compatibility. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: notificationHubs
properties SharedAccessAuthorizationRule properties. SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRuleProperties

Name Description Value
primaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
rights Gets or sets the rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send' (required)
secondaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
 string

Constraints:
Sensitive value. Pass in as a secure parameter.

ARM template resource definition

The namespaces/notificationHubs/authorizationRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules resource, add the following JSON to your template.

{
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "primaryKey": "string",
    "rights": [ "string" ],
    "secondaryKey": "string"
  }
}

Property values

namespaces/notificationHubs/authorizationRules

Name Description Value
type The resource type 'Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules'
apiVersion The resource api version '2023-10-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 1-256

Valid characters:
Alphanumerics, periods, hyphens, and underscores.

Start alphanumeric.
location Deprecated - only for compatibility. string
tags Deprecated - only for compatibility. Dictionary of tag names and values. See Tags in templates
properties SharedAccessAuthorizationRule properties. SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRuleProperties

Name Description Value
primaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
rights Gets or sets the rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send' (required)
secondaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
 string

Constraints:
Sensitive value. Pass in as a secure parameter.

Terraform (AzAPI provider) resource definition

The namespaces/notificationHubs/authorizationRules resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules@2023-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      primaryKey = "string"
      rights = [
        "string"
      ]
      secondaryKey = "string"
    }
  })
}

Property values

namespaces/notificationHubs/authorizationRules

Name Description Value
type The resource type "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules@2023-10-01-preview"
name The resource name string (required)

Character limit: 1-256

Valid characters:
Alphanumerics, periods, hyphens, and underscores.

Start alphanumeric.
location Deprecated - only for compatibility. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: notificationHubs
tags Deprecated - only for compatibility. Dictionary of tag names and values.
properties SharedAccessAuthorizationRule properties. SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRuleProperties

Name Description Value
primaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
rights Gets or sets the rights associated with the rule. String array containing any of:
"Listen"
"Manage"
"Send" (required)
secondaryKey Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
 string

Constraints:
Sensitive value. Pass in as a secure parameter.