pulumi-azure-native-kotlin/com.pulumi.azurenative.app.kotlin/DaprSubscription

DaprSubscription

class DaprSubscription : KotlinCustomResource

Dapr PubSub Event Subscription. Uses Azure REST API version 2024-10-02-preview. In version 2.x of the Azure Native provider, it used API version 2023-08-01-preview. Other available API versions: 2023-08-01-preview, 2023-11-02-preview, 2024-02-02-preview, 2024-08-02-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native app [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create or update dapr subscription with bulk subscribe configuration and scopes

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var daprSubscription = new AzureNative.App.DaprSubscription("daprSubscription", new()
    {
        BulkSubscribe = new AzureNative.App.Inputs.DaprSubscriptionBulkSubscribeOptionsArgs
        {
            Enabled = true,
            MaxAwaitDurationMs = 500,
            MaxMessagesCount = 123,
        },
        EnvironmentName = "myenvironment",
        Name = "mysubscription",
        PubsubName = "mypubsubcomponent",
        ResourceGroupName = "examplerg",
        Routes = new AzureNative.App.Inputs.DaprSubscriptionRoutesArgs
        {
            Default = "/products",
        },
        Scopes = new[]
        {
            "warehouseapp",
            "customersupportapp",
        },
        Topic = "inventory",
    });
});
Content copied to clipboard
package main
import (
	app "github.com/pulumi/pulumi-azure-native-sdk/app/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewDaprSubscription(ctx, "daprSubscription", &app.DaprSubscriptionArgs{
			BulkSubscribe: &app.DaprSubscriptionBulkSubscribeOptionsArgs{
				Enabled:            pulumi.Bool(true),
				MaxAwaitDurationMs: pulumi.Int(500),
				MaxMessagesCount:   pulumi.Int(123),
			},
			EnvironmentName:   pulumi.String("myenvironment"),
			Name:              pulumi.String("mysubscription"),
			PubsubName:        pulumi.String("mypubsubcomponent"),
			ResourceGroupName: pulumi.String("examplerg"),
			Routes: &app.DaprSubscriptionRoutesArgs{
				Default: pulumi.String("/products"),
			},
			Scopes: pulumi.StringArray{
				pulumi.String("warehouseapp"),
				pulumi.String("customersupportapp"),
			},
			Topic: pulumi.String("inventory"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.app.DaprSubscription;
import com.pulumi.azurenative.app.DaprSubscriptionArgs;
import com.pulumi.azurenative.app.inputs.DaprSubscriptionBulkSubscribeOptionsArgs;
import com.pulumi.azurenative.app.inputs.DaprSubscriptionRoutesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var daprSubscription = new DaprSubscription("daprSubscription", DaprSubscriptionArgs.builder()
            .bulkSubscribe(DaprSubscriptionBulkSubscribeOptionsArgs.builder()
                .enabled(true)
                .maxAwaitDurationMs(500)
                .maxMessagesCount(123)
                .build())
            .environmentName("myenvironment")
            .name("mysubscription")
            .pubsubName("mypubsubcomponent")
            .resourceGroupName("examplerg")
            .routes(DaprSubscriptionRoutesArgs.builder()
                .default_("/products")
                .build())
            .scopes(
                "warehouseapp",
                "customersupportapp")
            .topic("inventory")
            .build());
    }
}
Content copied to clipboard

Create or update dapr subscription with default route only

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var daprSubscription = new AzureNative.App.DaprSubscription("daprSubscription", new()
    {
        EnvironmentName = "myenvironment",
        Name = "mysubscription",
        PubsubName = "mypubsubcomponent",
        ResourceGroupName = "examplerg",
        Routes = new AzureNative.App.Inputs.DaprSubscriptionRoutesArgs
        {
            Default = "/products",
        },
        Topic = "inventory",
    });
});
Content copied to clipboard
package main
import (
	app "github.com/pulumi/pulumi-azure-native-sdk/app/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewDaprSubscription(ctx, "daprSubscription", &app.DaprSubscriptionArgs{
			EnvironmentName:   pulumi.String("myenvironment"),
			Name:              pulumi.String("mysubscription"),
			PubsubName:        pulumi.String("mypubsubcomponent"),
			ResourceGroupName: pulumi.String("examplerg"),
			Routes: &app.DaprSubscriptionRoutesArgs{
				Default: pulumi.String("/products"),
			},
			Topic: pulumi.String("inventory"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.app.DaprSubscription;
import com.pulumi.azurenative.app.DaprSubscriptionArgs;
import com.pulumi.azurenative.app.inputs.DaprSubscriptionRoutesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var daprSubscription = new DaprSubscription("daprSubscription", DaprSubscriptionArgs.builder()
            .environmentName("myenvironment")
            .name("mysubscription")
            .pubsubName("mypubsubcomponent")
            .resourceGroupName("examplerg")
            .routes(DaprSubscriptionRoutesArgs.builder()
                .default_("/products")
                .build())
            .topic("inventory")
            .build());
    }
}
Content copied to clipboard

Create or update dapr subscription with route rules and metadata

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var daprSubscription = new AzureNative.App.DaprSubscription("daprSubscription", new()
    {
        EnvironmentName = "myenvironment",
        Metadata =
        {
            { "foo", "bar" },
            { "hello", "world" },
        },
        Name = "mysubscription",
        PubsubName = "mypubsubcomponent",
        ResourceGroupName = "examplerg",
        Routes = new AzureNative.App.Inputs.DaprSubscriptionRoutesArgs
        {
            Default = "/products",
            Rules = new[]
            {
                new AzureNative.App.Inputs.DaprSubscriptionRouteRuleArgs
                {
                    Match = "event.type == 'widget'",
                    Path = "/widgets",
                },
                new AzureNative.App.Inputs.DaprSubscriptionRouteRuleArgs
                {
                    Match = "event.type == 'gadget'",
                    Path = "/gadgets",
                },
            },
        },
        Topic = "inventory",
    });
});
Content copied to clipboard
package main
import (
	app "github.com/pulumi/pulumi-azure-native-sdk/app/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewDaprSubscription(ctx, "daprSubscription", &app.DaprSubscriptionArgs{
			EnvironmentName: pulumi.String("myenvironment"),
			Metadata: pulumi.StringMap{
				"foo":   pulumi.String("bar"),
				"hello": pulumi.String("world"),
			},
			Name:              pulumi.String("mysubscription"),
			PubsubName:        pulumi.String("mypubsubcomponent"),
			ResourceGroupName: pulumi.String("examplerg"),
			Routes: &app.DaprSubscriptionRoutesArgs{
				Default: pulumi.String("/products"),
				Rules: app.DaprSubscriptionRouteRuleArray{
					&app.DaprSubscriptionRouteRuleArgs{
						Match: pulumi.String("event.type == 'widget'"),
						Path:  pulumi.String("/widgets"),
					},
					&app.DaprSubscriptionRouteRuleArgs{
						Match: pulumi.String("event.type == 'gadget'"),
						Path:  pulumi.String("/gadgets"),
					},
				},
			},
			Topic: pulumi.String("inventory"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.app.DaprSubscription;
import com.pulumi.azurenative.app.DaprSubscriptionArgs;
import com.pulumi.azurenative.app.inputs.DaprSubscriptionRoutesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var daprSubscription = new DaprSubscription("daprSubscription", DaprSubscriptionArgs.builder()
            .environmentName("myenvironment")
            .metadata(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("hello", "world")
            ))
            .name("mysubscription")
            .pubsubName("mypubsubcomponent")
            .resourceGroupName("examplerg")
            .routes(DaprSubscriptionRoutesArgs.builder()
                .default_("/products")
                .rules(
                    DaprSubscriptionRouteRuleArgs.builder()
                        .match("event.type == 'widget'")
                        .path("/widgets")
                        .build(),
                    DaprSubscriptionRouteRuleArgs.builder()
                        .match("event.type == 'gadget'")
                        .path("/gadgets")
                        .build())
                .build())
            .topic("inventory")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:app:DaprSubscription mysubscription /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprSubscriptions/{name}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val bulkSubscribe: Output<DaprSubscriptionBulkSubscribeOptionsResponse>?

Bulk subscription options

Link copied to clipboard
val deadLetterTopic: Output<String>?

Deadletter topic name

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val metadata: Output<Map<String, String>>?

Subscription metadata

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val pubsubName: Output<String>?

Dapr PubSub component name

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val routes: Output<DaprSubscriptionRoutesResponse>?

Subscription routes

Link copied to clipboard
val scopes: Output<List<String>>?

Application scopes to restrict the subscription to specific apps.

Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val topic: Output<String>?

Topic name

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>