Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

DaprComponent

Dapr Component. API Version: 2022-03-01.

Example Usage

Create or update dapr component

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var daprComponent = new AzureNative.App.DaprComponent("daprComponent", new AzureNative.App.DaprComponentArgs
        {
            ComponentName = "reddog",
            ComponentType = "state.azure.cosmosdb",
            EnvironmentName = "myenvironment",
            IgnoreErrors = false,
            InitTimeout = "50s",
            Metadata = 
            {
                new AzureNative.App.Inputs.DaprMetadataArgs
                {
                    Name = "url",
                    Value = "<COSMOS-URL>",
                },
                new AzureNative.App.Inputs.DaprMetadataArgs
                {
                    Name = "database",
                    Value = "itemsDB",
                },
                new AzureNative.App.Inputs.DaprMetadataArgs
                {
                    Name = "collection",
                    Value = "items",
                },
                new AzureNative.App.Inputs.DaprMetadataArgs
                {
                    Name = "masterkey",
                    SecretRef = "masterkey",
                },
            },
            ResourceGroupName = "examplerg",
            Scopes = 
            {
                "container-app-1",
                "container-app-2",
            },
            Secrets = 
            {
                new AzureNative.App.Inputs.SecretArgs
                {
                    Name = "masterkey",
                    Value = "keyvalue",
                },
            },
            Version = "v1",
        });
    }

}
package main

import (
	app "github.com/pulumi/pulumi-azure-native/sdk/go/azure/app"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewDaprComponent(ctx, "daprComponent", &app.DaprComponentArgs{
			ComponentName:   pulumi.String("reddog"),
			ComponentType:   pulumi.String("state.azure.cosmosdb"),
			EnvironmentName: pulumi.String("myenvironment"),
			IgnoreErrors:    pulumi.Bool(false),
			InitTimeout:     pulumi.String("50s"),
			Metadata: []app.DaprMetadataArgs{
				&app.DaprMetadataArgs{
					Name:  pulumi.String("url"),
					Value: pulumi.String("<COSMOS-URL>"),
				},
				&app.DaprMetadataArgs{
					Name:  pulumi.String("database"),
					Value: pulumi.String("itemsDB"),
				},
				&app.DaprMetadataArgs{
					Name:  pulumi.String("collection"),
					Value: pulumi.String("items"),
				},
				&app.DaprMetadataArgs{
					Name:      pulumi.String("masterkey"),
					SecretRef: pulumi.String("masterkey"),
				},
			},
			ResourceGroupName: pulumi.String("examplerg"),
			Scopes: pulumi.StringArray{
				pulumi.String("container-app-1"),
				pulumi.String("container-app-2"),
			},
			Secrets: []app.SecretArgs{
				&app.SecretArgs{
					Name:  pulumi.String("masterkey"),
					Value: pulumi.String("keyvalue"),
				},
			},
			Version: pulumi.String("v1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var daprComponent = new DaprComponent("daprComponent", DaprComponentArgs.builder()        
            .componentName("reddog")
            .componentType("state.azure.cosmosdb")
            .environmentName("myenvironment")
            .ignoreErrors(false)
            .initTimeout("50s")
            .metadata(            
                Map.ofEntries(
                    Map.entry("name", "url"),
                    Map.entry("value", "<COSMOS-URL>")
                ),
                Map.ofEntries(
                    Map.entry("name", "database"),
                    Map.entry("value", "itemsDB")
                ),
                Map.ofEntries(
                    Map.entry("name", "collection"),
                    Map.entry("value", "items")
                ),
                Map.ofEntries(
                    Map.entry("name", "masterkey"),
                    Map.entry("secretRef", "masterkey")
                ))
            .resourceGroupName("examplerg")
            .scopes(            
                "container-app-1",
                "container-app-2")
            .secrets(Map.ofEntries(
                Map.entry("name", "masterkey"),
                Map.entry("value", "keyvalue")
            ))
            .version("v1")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

dapr_component = azure_native.app.DaprComponent("daprComponent",
    component_name="reddog",
    component_type="state.azure.cosmosdb",
    environment_name="myenvironment",
    ignore_errors=False,
    init_timeout="50s",
    metadata=[
        azure_native.app.DaprMetadataArgs(
            name="url",
            value="<COSMOS-URL>",
        ),
        azure_native.app.DaprMetadataArgs(
            name="database",
            value="itemsDB",
        ),
        azure_native.app.DaprMetadataArgs(
            name="collection",
            value="items",
        ),
        azure_native.app.DaprMetadataArgs(
            name="masterkey",
            secret_ref="masterkey",
        ),
    ],
    resource_group_name="examplerg",
    scopes=[
        "container-app-1",
        "container-app-2",
    ],
    secrets=[azure_native.app.SecretArgs(
        name="masterkey",
        value="keyvalue",
    )],
    version="v1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const daprComponent = new azure_native.app.DaprComponent("daprComponent", {
    componentName: "reddog",
    componentType: "state.azure.cosmosdb",
    environmentName: "myenvironment",
    ignoreErrors: false,
    initTimeout: "50s",
    metadata: [
        {
            name: "url",
            value: "<COSMOS-URL>",
        },
        {
            name: "database",
            value: "itemsDB",
        },
        {
            name: "collection",
            value: "items",
        },
        {
            name: "masterkey",
            secretRef: "masterkey",
        },
    ],
    resourceGroupName: "examplerg",
    scopes: [
        "container-app-1",
        "container-app-2",
    ],
    secrets: [{
        name: "masterkey",
        value: "keyvalue",
    }],
    version: "v1",
});
resources:
  daprComponent:
    type: azure-native:app:DaprComponent
    properties:
      componentName: reddog
      componentType: state.azure.cosmosdb
      environmentName: myenvironment
      ignoreErrors: false
      initTimeout: 50s
      metadata:
        - name: url
          value: <COSMOS-URL>
        - name: database
          value: itemsDB
        - name: collection
          value: items
        - name: masterkey
          secretRef: masterkey
      resourceGroupName: examplerg
      scopes:
        - container-app-1
        - container-app-2
      secrets:
        - name: masterkey
          value: keyvalue
      version: v1

Create a DaprComponent Resource

new DaprComponent(name: string, args: DaprComponentArgs, opts?: CustomResourceOptions);
@overload
def DaprComponent(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  component_name: Optional[str] = None,
                  component_type: Optional[str] = None,
                  environment_name: Optional[str] = None,
                  ignore_errors: Optional[bool] = None,
                  init_timeout: Optional[str] = None,
                  metadata: Optional[Sequence[DaprMetadataArgs]] = None,
                  resource_group_name: Optional[str] = None,
                  scopes: Optional[Sequence[str]] = None,
                  secrets: Optional[Sequence[SecretArgs]] = None,
                  version: Optional[str] = None)
@overload
def DaprComponent(resource_name: str,
                  args: DaprComponentArgs,
                  opts: Optional[ResourceOptions] = None)
func NewDaprComponent(ctx *Context, name string, args DaprComponentArgs, opts ...ResourceOption) (*DaprComponent, error)
public DaprComponent(string name, DaprComponentArgs args, CustomResourceOptions? opts = null)
public DaprComponent(String name, DaprComponentArgs args)
public DaprComponent(String name, DaprComponentArgs args, CustomResourceOptions options)
type: azure-native:app:DaprComponent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DaprComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DaprComponentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DaprComponentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DaprComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DaprComponentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DaprComponent Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DaprComponent resource accepts the following input properties:

EnvironmentName string

Name of the Managed Environment.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ComponentName string

Name of the Dapr Component.

ComponentType string

Component type

IgnoreErrors bool

Boolean describing if the component errors are ignores

InitTimeout string

Initialization timeout

Metadata List<Pulumi.AzureNative.App.Inputs.DaprMetadataArgs>

Component metadata

Scopes List<string>

Names of container apps that can use this Dapr component

Secrets List<Pulumi.AzureNative.App.Inputs.SecretArgs>

Collection of secrets used by a Dapr component

Version string

Component version

EnvironmentName string

Name of the Managed Environment.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ComponentName string

Name of the Dapr Component.

ComponentType string

Component type

IgnoreErrors bool

Boolean describing if the component errors are ignores

InitTimeout string

Initialization timeout

Metadata []DaprMetadataArgs

Component metadata

Scopes []string

Names of container apps that can use this Dapr component

Secrets []SecretArgs

Collection of secrets used by a Dapr component

Version string

Component version

environmentName String

Name of the Managed Environment.

resourceGroupName String

The name of the resource group. The name is case insensitive.

componentName String

Name of the Dapr Component.

componentType String

Component type

ignoreErrors Boolean

Boolean describing if the component errors are ignores

initTimeout String

Initialization timeout

metadata List<DaprMetadataArgs>

Component metadata

scopes List<String>

Names of container apps that can use this Dapr component

secrets List<SecretArgs>

Collection of secrets used by a Dapr component

version String

Component version

environmentName string

Name of the Managed Environment.

resourceGroupName string

The name of the resource group. The name is case insensitive.

componentName string

Name of the Dapr Component.

componentType string

Component type

ignoreErrors boolean

Boolean describing if the component errors are ignores

initTimeout string

Initialization timeout

metadata DaprMetadataArgs[]

Component metadata

scopes string[]

Names of container apps that can use this Dapr component

secrets SecretArgs[]

Collection of secrets used by a Dapr component

version string

Component version

environment_name str

Name of the Managed Environment.

resource_group_name str

The name of the resource group. The name is case insensitive.

component_name str

Name of the Dapr Component.

component_type str

Component type

ignore_errors bool

Boolean describing if the component errors are ignores

init_timeout str

Initialization timeout

metadata Sequence[DaprMetadataArgs]

Component metadata

scopes Sequence[str]

Names of container apps that can use this Dapr component

secrets Sequence[SecretArgs]

Collection of secrets used by a Dapr component

version str

Component version

environmentName String

Name of the Managed Environment.

resourceGroupName String

The name of the resource group. The name is case insensitive.

componentName String

Name of the Dapr Component.

componentType String

Component type

ignoreErrors Boolean

Boolean describing if the component errors are ignores

initTimeout String

Initialization timeout

metadata List<Property Map>

Component metadata

scopes List<String>

Names of container apps that can use this Dapr component

secrets List<Property Map>

Collection of secrets used by a Dapr component

version String

Component version

Outputs

All input properties are implicitly available as output properties. Additionally, the DaprComponent resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

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"

Id string

The provider-assigned unique ID for this managed resource.

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"

id String

The provider-assigned unique ID for this managed resource.

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"

id string

The provider-assigned unique ID for this managed resource.

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"

id str

The provider-assigned unique ID for this managed resource.

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"

id String

The provider-assigned unique ID for this managed resource.

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"

Supporting Types

DaprMetadata

Name string

Metadata property name.

SecretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

Value string

Metadata property value.

Name string

Metadata property name.

SecretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

Value string

Metadata property value.

name String

Metadata property name.

secretRef String

Name of the Dapr Component secret from which to pull the metadata property value.

value String

Metadata property value.

name string

Metadata property name.

secretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

value string

Metadata property value.

name str

Metadata property name.

secret_ref str

Name of the Dapr Component secret from which to pull the metadata property value.

value str

Metadata property value.

name String

Metadata property name.

secretRef String

Name of the Dapr Component secret from which to pull the metadata property value.

value String

Metadata property value.

DaprMetadataResponse

Name string

Metadata property name.

SecretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

Value string

Metadata property value.

Name string

Metadata property name.

SecretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

Value string

Metadata property value.

name String

Metadata property name.

secretRef String

Name of the Dapr Component secret from which to pull the metadata property value.

value String

Metadata property value.

name string

Metadata property name.

secretRef string

Name of the Dapr Component secret from which to pull the metadata property value.

value string

Metadata property value.

name str

Metadata property name.

secret_ref str

Name of the Dapr Component secret from which to pull the metadata property value.

value str

Metadata property value.

name String

Metadata property name.

secretRef String

Name of the Dapr Component secret from which to pull the metadata property value.

value String

Metadata property value.

Secret

Name string

Secret Name.

Value string

Secret Value.

Name string

Secret Name.

Value string

Secret Value.

name String

Secret Name.

value String

Secret Value.

name string

Secret Name.

value string

Secret Value.

name str

Secret Name.

value str

Secret Value.

name String

Secret Name.

value String

Secret Value.

SecretResponse

Name string

Secret Name.

Name string

Secret Name.

name String

Secret Name.

name string

Secret Name.

name str

Secret Name.

name String

Secret Name.

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.

Import

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

$ pulumi import azure-native:app:DaprComponent reddog /subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0