Microsoft.App managedEnvironments/daprSubscriptions 2024-08-02-preview

• Latest
• 2024-10-02-preview
• 2024-08-02-preview
• 2024-02-02-preview
• 2023-11-02-preview
• 2023-08-01-preview

Bicep resource definition

The managedEnvironments/daprSubscriptions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.App/managedEnvironments/daprSubscriptions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/managedEnvironments/daprSubscriptions@2024-08-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    bulkSubscribe: {
      enabled: bool
      maxAwaitDurationMs: int
      maxMessagesCount: int
    }
    deadLetterTopic: 'string'
    metadata: {
      {customized property}: 'string'
    }
    pubsubName: 'string'
    routes: {
      default: 'string'
      rules: [
        {
          match: 'string'
          path: 'string'
        }
      ]
    }
    scopes: [
      'string'
    ]
    topic: 'string'
  }
}

Property values

DaprSubscriptionBulkSubscribeOptions

Name	Description	Value
enabled	Enable bulk subscription	bool
maxAwaitDurationMs	Maximum duration in milliseconds to wait before a bulk message is sent to the app.	int
maxMessagesCount	Maximum number of messages to deliver in a bulk message.	int

DaprSubscriptionProperties

Name	Description	Value
bulkSubscribe	Bulk subscription options	DaprSubscriptionBulkSubscribeOptions
deadLetterTopic	Deadletter topic name	string
metadata	Subscription metadata	DaprSubscriptionPropertiesMetadata
pubsubName	Dapr PubSub component name	string
routes	Subscription routes	DaprSubscriptionRoutes
scopes	Application scopes to restrict the subscription to specific apps.	string[]
topic	Topic name	string

DaprSubscriptionPropertiesMetadata

Name	Description	Value

DaprSubscriptionRouteRule

Name	Description	Value
match	The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list.	string
path	The path for events that match this rule	string

DaprSubscriptionRoutes

Name	Description	Value
default	The default path to deliver events that do not match any of the rules.	string
rules	The list of Dapr PubSub Event Subscription Route Rules.	DaprSubscriptionRouteRule[]

Microsoft.App/managedEnvironments/daprSubscriptions

Name	Description	Value
name	The resource name	string (required)
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: managedEnvironments
properties	Dapr PubSub Event Subscription resource specific properties	DaprSubscriptionProperties

ARM template resource definition

The managedEnvironments/daprSubscriptions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.App/managedEnvironments/daprSubscriptions resource, add the following JSON to your template.

{
  "type": "Microsoft.App/managedEnvironments/daprSubscriptions",
  "apiVersion": "2024-08-02-preview",
  "name": "string",
  "properties": {
    "bulkSubscribe": {
      "enabled": "bool",
      "maxAwaitDurationMs": "int",
      "maxMessagesCount": "int"
    },
    "deadLetterTopic": "string",
    "metadata": {
      "{customized property}": "string"
    },
    "pubsubName": "string",
    "routes": {
      "default": "string",
      "rules": [
        {
          "match": "string",
          "path": "string"
        }
      ]
    },
    "scopes": [ "string" ],
    "topic": "string"
  }
}

Property values

DaprSubscriptionBulkSubscribeOptions

Name	Description	Value
enabled	Enable bulk subscription	bool
maxAwaitDurationMs	Maximum duration in milliseconds to wait before a bulk message is sent to the app.	int
maxMessagesCount	Maximum number of messages to deliver in a bulk message.	int

DaprSubscriptionProperties

Name	Description	Value
bulkSubscribe	Bulk subscription options	DaprSubscriptionBulkSubscribeOptions
deadLetterTopic	Deadletter topic name	string
metadata	Subscription metadata	DaprSubscriptionPropertiesMetadata
pubsubName	Dapr PubSub component name	string
routes	Subscription routes	DaprSubscriptionRoutes
scopes	Application scopes to restrict the subscription to specific apps.	string[]
topic	Topic name	string

DaprSubscriptionPropertiesMetadata

Name	Description	Value

DaprSubscriptionRouteRule

Name	Description	Value
match	The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list.	string
path	The path for events that match this rule	string

DaprSubscriptionRoutes

Name	Description	Value
default	The default path to deliver events that do not match any of the rules.	string
rules	The list of Dapr PubSub Event Subscription Route Rules.	DaprSubscriptionRouteRule[]

Microsoft.App/managedEnvironments/daprSubscriptions

Name	Description	Value
apiVersion	The api version	'2024-08-02-preview'
name	The resource name	string (required)
properties	Dapr PubSub Event Subscription resource specific properties	DaprSubscriptionProperties
type	The resource type	'Microsoft.App/managedEnvironments/daprSubscriptions'

Terraform (AzAPI provider) resource definition

The managedEnvironments/daprSubscriptions 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.App/managedEnvironments/daprSubscriptions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/managedEnvironments/daprSubscriptions@2024-08-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      bulkSubscribe = {
        enabled = bool
        maxAwaitDurationMs = int
        maxMessagesCount = int
      }
      deadLetterTopic = "string"
      metadata = {
        {customized property} = "string"
      }
      pubsubName = "string"
      routes = {
        default = "string"
        rules = [
          {
            match = "string"
            path = "string"
          }
        ]
      }
      scopes = [
        "string"
      ]
      topic = "string"
    }
  })
}

Property values

DaprSubscriptionBulkSubscribeOptions

Name	Description	Value
enabled	Enable bulk subscription	bool
maxAwaitDurationMs	Maximum duration in milliseconds to wait before a bulk message is sent to the app.	int
maxMessagesCount	Maximum number of messages to deliver in a bulk message.	int

DaprSubscriptionProperties

Name	Description	Value
bulkSubscribe	Bulk subscription options	DaprSubscriptionBulkSubscribeOptions
deadLetterTopic	Deadletter topic name	string
metadata	Subscription metadata	DaprSubscriptionPropertiesMetadata
pubsubName	Dapr PubSub component name	string
routes	Subscription routes	DaprSubscriptionRoutes
scopes	Application scopes to restrict the subscription to specific apps.	string[]
topic	Topic name	string

DaprSubscriptionPropertiesMetadata

Name	Description	Value

DaprSubscriptionRouteRule

Name	Description	Value
match	The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list.	string
path	The path for events that match this rule	string

DaprSubscriptionRoutes

Name	Description	Value
default	The default path to deliver events that do not match any of the rules.	string
rules	The list of Dapr PubSub Event Subscription Route Rules.	DaprSubscriptionRouteRule[]

Microsoft.App/managedEnvironments/daprSubscriptions

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: managedEnvironments
properties	Dapr PubSub Event Subscription resource specific properties	DaprSubscriptionProperties
type	The resource type	"Microsoft.App/managedEnvironments/daprSubscriptions@2024-08-02-preview"