1. Packages
  2. Azure Native v2
  3. API Docs
  4. eventgrid
  5. getEventSubscriptionDeliveryAttributes
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native-v2.eventgrid.getEventSubscriptionDeliveryAttributes

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

Get all delivery attributes for an event subscription. Azure REST API version: 2022-06-15.

Other available API versions: 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview.

Using getEventSubscriptionDeliveryAttributes

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEventSubscriptionDeliveryAttributes(args: GetEventSubscriptionDeliveryAttributesArgs, opts?: InvokeOptions): Promise<GetEventSubscriptionDeliveryAttributesResult>
function getEventSubscriptionDeliveryAttributesOutput(args: GetEventSubscriptionDeliveryAttributesOutputArgs, opts?: InvokeOptions): Output<GetEventSubscriptionDeliveryAttributesResult>
Copy
def get_event_subscription_delivery_attributes(event_subscription_name: Optional[str] = None,
                                               scope: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetEventSubscriptionDeliveryAttributesResult
def get_event_subscription_delivery_attributes_output(event_subscription_name: Optional[pulumi.Input[str]] = None,
                                               scope: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetEventSubscriptionDeliveryAttributesResult]
Copy
func GetEventSubscriptionDeliveryAttributes(ctx *Context, args *GetEventSubscriptionDeliveryAttributesArgs, opts ...InvokeOption) (*GetEventSubscriptionDeliveryAttributesResult, error)
func GetEventSubscriptionDeliveryAttributesOutput(ctx *Context, args *GetEventSubscriptionDeliveryAttributesOutputArgs, opts ...InvokeOption) GetEventSubscriptionDeliveryAttributesResultOutput
Copy

> Note: This function is named GetEventSubscriptionDeliveryAttributes in the Go SDK.

public static class GetEventSubscriptionDeliveryAttributes 
{
    public static Task<GetEventSubscriptionDeliveryAttributesResult> InvokeAsync(GetEventSubscriptionDeliveryAttributesArgs args, InvokeOptions? opts = null)
    public static Output<GetEventSubscriptionDeliveryAttributesResult> Invoke(GetEventSubscriptionDeliveryAttributesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEventSubscriptionDeliveryAttributesResult> getEventSubscriptionDeliveryAttributes(GetEventSubscriptionDeliveryAttributesArgs args, InvokeOptions options)
public static Output<GetEventSubscriptionDeliveryAttributesResult> getEventSubscriptionDeliveryAttributes(GetEventSubscriptionDeliveryAttributesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventgrid:getEventSubscriptionDeliveryAttributes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EventSubscriptionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the event subscription.
Scope
This property is required.
Changes to this property will trigger replacement.
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.
EventSubscriptionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the event subscription.
Scope
This property is required.
Changes to this property will trigger replacement.
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.
eventSubscriptionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the event subscription.
scope
This property is required.
Changes to this property will trigger replacement.
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.
eventSubscriptionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the event subscription.
scope
This property is required.
Changes to this property will trigger replacement.
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.
event_subscription_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the event subscription.
scope
This property is required.
Changes to this property will trigger replacement.
str
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.
eventSubscriptionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the event subscription.
scope
This property is required.
Changes to this property will trigger replacement.
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.

getEventSubscriptionDeliveryAttributes Result

The following output properties are available:

Value List<Union<Pulumi.AzureNative.EventGrid.Outputs.DynamicDeliveryAttributeMappingResponse, Pulumi.AzureNative.EventGrid.Outputs.StaticDeliveryAttributeMappingResponse>>
A collection of DeliveryAttributeMapping
Value []interface{}
A collection of DeliveryAttributeMapping
value List<Either<DynamicDeliveryAttributeMappingResponse,StaticDeliveryAttributeMappingResponse>>
A collection of DeliveryAttributeMapping
value (DynamicDeliveryAttributeMappingResponse | StaticDeliveryAttributeMappingResponse)[]
A collection of DeliveryAttributeMapping
value Sequence[Any]
A collection of DeliveryAttributeMapping
value List<Property Map | Property Map>
A collection of DeliveryAttributeMapping

Supporting Types

DynamicDeliveryAttributeMappingResponse

Name string
Name of the delivery attribute or header.
SourceField string
JSON path in the event which contains attribute value.
Name string
Name of the delivery attribute or header.
SourceField string
JSON path in the event which contains attribute value.
name String
Name of the delivery attribute or header.
sourceField String
JSON path in the event which contains attribute value.
name string
Name of the delivery attribute or header.
sourceField string
JSON path in the event which contains attribute value.
name str
Name of the delivery attribute or header.
source_field str
JSON path in the event which contains attribute value.
name String
Name of the delivery attribute or header.
sourceField String
JSON path in the event which contains attribute value.

StaticDeliveryAttributeMappingResponse

IsSecret bool
Boolean flag to tell if the attribute contains sensitive information .
Name string
Name of the delivery attribute or header.
Value string
Value of the delivery attribute.
IsSecret bool
Boolean flag to tell if the attribute contains sensitive information .
Name string
Name of the delivery attribute or header.
Value string
Value of the delivery attribute.
isSecret Boolean
Boolean flag to tell if the attribute contains sensitive information .
name String
Name of the delivery attribute or header.
value String
Value of the delivery attribute.
isSecret boolean
Boolean flag to tell if the attribute contains sensitive information .
name string
Name of the delivery attribute or header.
value string
Value of the delivery attribute.
is_secret bool
Boolean flag to tell if the attribute contains sensitive information .
name str
Name of the delivery attribute or header.
value str
Value of the delivery attribute.
isSecret Boolean
Boolean flag to tell if the attribute contains sensitive information .
name String
Name of the delivery attribute or header.
value String
Value of the delivery attribute.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi