Microsoft.App connectedEnvironments/daprComponents 2024-10-02-preview

• Latest
• 2024-10-02-preview
• 2024-08-02-preview
• 2024-03-01
• 2024-02-02-preview
• 2023-11-02-preview
• 2023-08-01-preview
• 2023-05-02-preview
• 2023-05-01
• 2023-04-01-preview
• 2022-11-01-preview
• 2022-10-01
• 2022-06-01-preview

Bicep resource definition

The connectedEnvironments/daprComponents resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/connectedEnvironments/daprComponents resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/connectedEnvironments/daprComponents@2024-10-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    componentType: 'string'
    ignoreErrors: bool
    initTimeout: 'string'
    metadata: [
      {
        name: 'string'
        secretRef: 'string'
        value: 'string'
      }
    ]
    scopes: [
      'string'
    ]
    secrets: [
      {
        identity: 'string'
        keyVaultUrl: 'string'
        name: 'string'
        value: 'string'
      }
    ]
    secretStoreComponent: 'string'
    serviceComponentBind: [
      {
        metadata: {
          name: 'string'
          value: 'string'
        }
        name: 'string'
        serviceId: 'string'
      }
    ]
    version: 'string'
  }
}

Property values

ConnectedEnvironmentDaprComponentProperties

Name	Description	Value
componentType	Component type	string
ignoreErrors	Boolean describing if the component errors are ignores	bool
initTimeout	Initialization timeout	string
metadata	Component metadata	DaprMetadata[]
scopes	Names of container apps that can use this Dapr component	string[]
secrets	Collection of secrets used by a Dapr component	Secret[]
secretStoreComponent	Name of a Dapr component to retrieve component secrets from	string
serviceComponentBind	List of container app services that are bound to the Dapr component	DaprComponentServiceBinding[]
version	Component version	string

DaprComponentServiceBinding

Name	Description	Value
metadata	Service bind metadata	DaprServiceBindMetadata
name	Name of the service bind	string
serviceId	Resource id of the target service	string

DaprMetadata

Name	Description	Value
name	Metadata property name.	string
secretRef	Name of the Dapr Component secret from which to pull the metadata property value.	string
value	Metadata property value.	string

DaprServiceBindMetadata

Name	Description	Value
name	Service bind metadata property name.	string
value	Service bind metadata property value.	string

Microsoft.App/connectedEnvironments/daprComponents

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: connectedEnvironments
properties	Dapr component properties	ConnectedEnvironmentDaprComponentProperties

Secret

Name	Description	Value
identity	Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.	string
keyVaultUrl	Azure Key Vault URL pointing to the secret referenced by the container app.	string
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.

ARM template resource definition

The connectedEnvironments/daprComponents resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/connectedEnvironments/daprComponents resource, add the following JSON to your template.

{
  "type": "Microsoft.App/connectedEnvironments/daprComponents",
  "apiVersion": "2024-10-02-preview",
  "name": "string",
  "properties": {
    "componentType": "string",
    "ignoreErrors": "bool",
    "initTimeout": "string",
    "metadata": [
      {
        "name": "string",
        "secretRef": "string",
        "value": "string"
      }
    ],
    "scopes": [ "string" ],
    "secrets": [
      {
        "identity": "string",
        "keyVaultUrl": "string",
        "name": "string",
        "value": "string"
      }
    ],
    "secretStoreComponent": "string",
    "serviceComponentBind": [
      {
        "metadata": {
          "name": "string",
          "value": "string"
        },
        "name": "string",
        "serviceId": "string"
      }
    ],
    "version": "string"
  }
}

Property values

ConnectedEnvironmentDaprComponentProperties

Name	Description	Value
componentType	Component type	string
ignoreErrors	Boolean describing if the component errors are ignores	bool
initTimeout	Initialization timeout	string
metadata	Component metadata	DaprMetadata[]
scopes	Names of container apps that can use this Dapr component	string[]
secrets	Collection of secrets used by a Dapr component	Secret[]
secretStoreComponent	Name of a Dapr component to retrieve component secrets from	string
serviceComponentBind	List of container app services that are bound to the Dapr component	DaprComponentServiceBinding[]
version	Component version	string

DaprComponentServiceBinding

Name	Description	Value
metadata	Service bind metadata	DaprServiceBindMetadata
name	Name of the service bind	string
serviceId	Resource id of the target service	string

DaprMetadata

Name	Description	Value
name	Metadata property name.	string
secretRef	Name of the Dapr Component secret from which to pull the metadata property value.	string
value	Metadata property value.	string

DaprServiceBindMetadata

Name	Description	Value
name	Service bind metadata property name.	string
value	Service bind metadata property value.	string

Microsoft.App/connectedEnvironments/daprComponents

Name	Description	Value
apiVersion	The api version	'2024-10-02-preview'
name	The resource name	string (required)
properties	Dapr component properties	ConnectedEnvironmentDaprComponentProperties
type	The resource type	'Microsoft.App/connectedEnvironments/daprComponents'

Secret

Name	Description	Value
identity	Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.	string
keyVaultUrl	Azure Key Vault URL pointing to the secret referenced by the container app.	string
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.

Terraform (AzAPI provider) resource definition

The connectedEnvironments/daprComponents resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/connectedEnvironments/daprComponents resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/connectedEnvironments/daprComponents@2024-10-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      componentType = "string"
      ignoreErrors = bool
      initTimeout = "string"
      metadata = [
        {
          name = "string"
          secretRef = "string"
          value = "string"
        }
      ]
      scopes = [
        "string"
      ]
      secrets = [
        {
          identity = "string"
          keyVaultUrl = "string"
          name = "string"
          value = "string"
        }
      ]
      secretStoreComponent = "string"
      serviceComponentBind = [
        {
          metadata = {
            name = "string"
            value = "string"
          }
          name = "string"
          serviceId = "string"
        }
      ]
      version = "string"
    }
  })
}

Property values

ConnectedEnvironmentDaprComponentProperties

Name	Description	Value
componentType	Component type	string
ignoreErrors	Boolean describing if the component errors are ignores	bool
initTimeout	Initialization timeout	string
metadata	Component metadata	DaprMetadata[]
scopes	Names of container apps that can use this Dapr component	string[]
secrets	Collection of secrets used by a Dapr component	Secret[]
secretStoreComponent	Name of a Dapr component to retrieve component secrets from	string
serviceComponentBind	List of container app services that are bound to the Dapr component	DaprComponentServiceBinding[]
version	Component version	string

DaprComponentServiceBinding

Name	Description	Value
metadata	Service bind metadata	DaprServiceBindMetadata
name	Name of the service bind	string
serviceId	Resource id of the target service	string

DaprMetadata

Name	Description	Value
name	Metadata property name.	string
secretRef	Name of the Dapr Component secret from which to pull the metadata property value.	string
value	Metadata property value.	string

DaprServiceBindMetadata

Name	Description	Value
name	Service bind metadata property name.	string
value	Service bind metadata property value.	string

Microsoft.App/connectedEnvironments/daprComponents

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: connectedEnvironments
properties	Dapr component properties	ConnectedEnvironmentDaprComponentProperties
type	The resource type	"Microsoft.App/connectedEnvironments/daprComponents@2024-10-02-preview"

Secret

Name	Description	Value
identity	Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.	string
keyVaultUrl	Azure Key Vault URL pointing to the secret referenced by the container app.	string
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.