你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Event Subscriptions - Get Delivery Attributes

Service:

Event Grid

API Version:

2025-02-15

Get delivery attributes for an event subscription.
Get all delivery attributes for an event subscription.

POST https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes?api-version=2025-02-15

URI Parameters

Name	In	Required	Type	Description
eventSubscriptionName	path	True	string	Name of the event subscription.
scope	path	True	string	The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
api-version	query	True	string	Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	DeliveryAttributeListResult	OK
Other Status Codes		*** Error Responses: *** 400 Bad Request. 500 Internal Server Error.

Examples

EventSubscriptions_GetDeliveryAttributes

Sample request

HTTP

POST https://management.azure.com/aaaaaaaaaaaaaaaaaaaaaaaaa/providers/Microsoft.EventGrid/eventSubscriptions/aaaaaaaaaaaaaaaaaa/getDeliveryAttributes?api-version=2025-02-15

Sample response

Status code:

200

{
  "value": [
    {
      "name": "header1",
      "type": "Static"
    },
    {
      "name": "header2",
      "type": "Dynamic"
    },
    {
      "name": "header3",
      "type": "Static"
    }
  ]
}

Definitions

Name	Description
DeliveryAttributeListResult	Result of the Get delivery attributes operation.
DynamicDeliveryAttributeMapping	Dynamic delivery attribute mapping details.
StaticDeliveryAttributeMapping	Static delivery attribute mapping details.

DeliveryAttributeListResult

Result of the Get delivery attributes operation.

Name	Type	Description
value	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	A collection of DeliveryAttributeMapping

DynamicDeliveryAttributeMapping

Dynamic delivery attribute mapping details.

Name	Type	Description
name	string	Name of the delivery attribute or header.
properties.sourceField	string	JSON path in the event which contains attribute value.
type	string: Dynamic	Type of the delivery attribute or header name.

StaticDeliveryAttributeMapping

Static delivery attribute mapping details.

Name	Type	Default value	Description
name	string		Name of the delivery attribute or header.
properties.isSecret	boolean	False	Boolean flag to tell if the attribute contains sensitive information .
properties.value	string		Value of the delivery attribute.
type	string: Static		Type of the delivery attribute or header name.