1. Packages
  2. Azure Native
  3. API Docs
  4. app
  5. getDaprSubscription
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.app.getDaprSubscription

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Dapr PubSub Event Subscription. Azure REST API version: 2023-08-01-preview.

    Other available API versions: 2023-11-02-preview, 2024-02-02-preview, 2024-08-02-preview, 2024-10-02-preview.

    Using getDaprSubscription

    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 getDaprSubscription(args: GetDaprSubscriptionArgs, opts?: InvokeOptions): Promise<GetDaprSubscriptionResult>
    function getDaprSubscriptionOutput(args: GetDaprSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetDaprSubscriptionResult>
    def get_dapr_subscription(environment_name: Optional[str] = None,
                              name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDaprSubscriptionResult
    def get_dapr_subscription_output(environment_name: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDaprSubscriptionResult]
    func LookupDaprSubscription(ctx *Context, args *LookupDaprSubscriptionArgs, opts ...InvokeOption) (*LookupDaprSubscriptionResult, error)
    func LookupDaprSubscriptionOutput(ctx *Context, args *LookupDaprSubscriptionOutputArgs, opts ...InvokeOption) LookupDaprSubscriptionResultOutput

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

    public static class GetDaprSubscription 
    {
        public static Task<GetDaprSubscriptionResult> InvokeAsync(GetDaprSubscriptionArgs args, InvokeOptions? opts = null)
        public static Output<GetDaprSubscriptionResult> Invoke(GetDaprSubscriptionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDaprSubscriptionResult> getDaprSubscription(GetDaprSubscriptionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:app:getDaprSubscription
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EnvironmentName string
    Name of the Managed Environment.
    Name string
    Name of the Dapr subscription.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EnvironmentName string
    Name of the Managed Environment.
    Name string
    Name of the Dapr subscription.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    environmentName String
    Name of the Managed Environment.
    name String
    Name of the Dapr subscription.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    environmentName string
    Name of the Managed Environment.
    name string
    Name of the Dapr subscription.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    environment_name str
    Name of the Managed Environment.
    name str
    Name of the Dapr subscription.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    environmentName String
    Name of the Managed Environment.
    name String
    Name of the Dapr subscription.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDaprSubscription Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.App.Outputs.SystemDataResponse
    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"
    BulkSubscribe Pulumi.AzureNative.App.Outputs.DaprSubscriptionBulkSubscribeOptionsResponse
    Bulk subscription options
    DeadLetterTopic string
    Deadletter topic name
    Metadata Dictionary<string, string>
    Subscription metadata
    PubsubName string
    Dapr PubSub component name
    Routes Pulumi.AzureNative.App.Outputs.DaprSubscriptionRoutesResponse
    Subscription routes
    Scopes List<string>
    Application scopes to restrict the subscription to specific apps.
    Topic string
    Topic name
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    SystemData SystemDataResponse
    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"
    BulkSubscribe DaprSubscriptionBulkSubscribeOptionsResponse
    Bulk subscription options
    DeadLetterTopic string
    Deadletter topic name
    Metadata map[string]string
    Subscription metadata
    PubsubName string
    Dapr PubSub component name
    Routes DaprSubscriptionRoutesResponse
    Subscription routes
    Scopes []string
    Application scopes to restrict the subscription to specific apps.
    Topic string
    Topic name
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    systemData SystemDataResponse
    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"
    bulkSubscribe DaprSubscriptionBulkSubscribeOptionsResponse
    Bulk subscription options
    deadLetterTopic String
    Deadletter topic name
    metadata Map<String,String>
    Subscription metadata
    pubsubName String
    Dapr PubSub component name
    routes DaprSubscriptionRoutesResponse
    Subscription routes
    scopes List<String>
    Application scopes to restrict the subscription to specific apps.
    topic String
    Topic name
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    systemData SystemDataResponse
    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"
    bulkSubscribe DaprSubscriptionBulkSubscribeOptionsResponse
    Bulk subscription options
    deadLetterTopic string
    Deadletter topic name
    metadata {[key: string]: string}
    Subscription metadata
    pubsubName string
    Dapr PubSub component name
    routes DaprSubscriptionRoutesResponse
    Subscription routes
    scopes string[]
    Application scopes to restrict the subscription to specific apps.
    topic string
    Topic name
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    system_data SystemDataResponse
    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"
    bulk_subscribe DaprSubscriptionBulkSubscribeOptionsResponse
    Bulk subscription options
    dead_letter_topic str
    Deadletter topic name
    metadata Mapping[str, str]
    Subscription metadata
    pubsub_name str
    Dapr PubSub component name
    routes DaprSubscriptionRoutesResponse
    Subscription routes
    scopes Sequence[str]
    Application scopes to restrict the subscription to specific apps.
    topic str
    Topic name
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    systemData 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"
    bulkSubscribe Property Map
    Bulk subscription options
    deadLetterTopic String
    Deadletter topic name
    metadata Map<String>
    Subscription metadata
    pubsubName String
    Dapr PubSub component name
    routes Property Map
    Subscription routes
    scopes List<String>
    Application scopes to restrict the subscription to specific apps.
    topic String
    Topic name

    Supporting Types

    DaprSubscriptionBulkSubscribeOptionsResponse

    Enabled bool
    Enable bulk subscription
    MaxAwaitDurationMs int
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    MaxMessagesCount int
    Maximum number of messages to deliver in a bulk message.
    Enabled bool
    Enable bulk subscription
    MaxAwaitDurationMs int
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    MaxMessagesCount int
    Maximum number of messages to deliver in a bulk message.
    enabled Boolean
    Enable bulk subscription
    maxAwaitDurationMs Integer
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    maxMessagesCount Integer
    Maximum number of messages to deliver in a bulk message.
    enabled boolean
    Enable bulk subscription
    maxAwaitDurationMs number
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    maxMessagesCount number
    Maximum number of messages to deliver in a bulk message.
    enabled bool
    Enable bulk subscription
    max_await_duration_ms int
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    max_messages_count int
    Maximum number of messages to deliver in a bulk message.
    enabled Boolean
    Enable bulk subscription
    maxAwaitDurationMs Number
    Maximum duration in milliseconds to wait before a bulk message is sent to the app.
    maxMessagesCount Number
    Maximum number of messages to deliver in a bulk message.

    DaprSubscriptionRouteRuleResponse

    Match string
    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.
    Path string
    The path for events that match this rule
    Match string
    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.
    Path string
    The path for events that match this rule
    match String
    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.
    path String
    The path for events that match this rule
    match string
    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.
    path string
    The path for events that match this rule
    match str
    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.
    path str
    The path for events that match this rule
    match String
    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.
    path String
    The path for events that match this rule

    DaprSubscriptionRoutesResponse

    Default string
    The default path to deliver events that do not match any of the rules.
    Rules List<Pulumi.AzureNative.App.Inputs.DaprSubscriptionRouteRuleResponse>
    The list of Dapr PubSub Event Subscription Route Rules.
    Default string
    The default path to deliver events that do not match any of the rules.
    Rules []DaprSubscriptionRouteRuleResponse
    The list of Dapr PubSub Event Subscription Route Rules.
    default_ String
    The default path to deliver events that do not match any of the rules.
    rules List<DaprSubscriptionRouteRuleResponse>
    The list of Dapr PubSub Event Subscription Route Rules.
    default string
    The default path to deliver events that do not match any of the rules.
    rules DaprSubscriptionRouteRuleResponse[]
    The list of Dapr PubSub Event Subscription Route Rules.
    default str
    The default path to deliver events that do not match any of the rules.
    rules Sequence[DaprSubscriptionRouteRuleResponse]
    The list of Dapr PubSub Event Subscription Route Rules.
    default String
    The default path to deliver events that do not match any of the rules.
    rules List<Property Map>
    The list of Dapr PubSub Event Subscription Route Rules.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi