dapr_components

Creates, updates, deletes, gets or lists a dapr_components resource.

Overview

Name	dapr_components
Type	Resource
Id	azure.app_containers.dapr_components

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
componentType	string	Component type.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
ignoreErrors	boolean	Boolean describing if the component errors are ignores.
initTimeout	string	Initialization timeout.
metadata	array	Component metadata.
provisioningState	string	Provisioning state of the Connected Environment Dapr Component. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
scopes	array	Names of container apps that can use this Dapr component.
secretStoreComponent	string	Name of a Dapr component to retrieve component secrets from.
secrets	array	Collection of secrets used by a Dapr component.
systemData	object	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".
version	string	Component version.

list

Name	Datatype	Description
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.
componentType	string	Component type.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
ignoreErrors	boolean	Boolean describing if the component errors are ignores.
initTimeout	string	Initialization timeout.
metadata	array	Component metadata.
provisioningState	string	Provisioning state of the Connected Environment Dapr Component. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
scopes	array	Names of container apps that can use this Dapr component.
secretStoreComponent	string	Name of a Dapr component to retrieve component secrets from.
secrets	array	Collection of secrets used by a Dapr component.
systemData	object	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".
version	string	Component version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, component_name, subscription_id		Get a dapr component. Get a dapr component.
list	select	resource_group_name, environment_name, subscription_id		Get the Dapr Components for a managed environment. Get the Dapr Components for a managed environment.
create_or_update	insert	resource_group_name, environment_name, component_name, subscription_id		Creates or updates a Dapr Component. Creates or updates a Dapr Component in a Managed Environment.
create_or_update	replace	resource_group_name, environment_name, component_name, subscription_id		Creates or updates a Dapr Component. Creates or updates a Dapr Component in a Managed Environment.
delete	delete	resource_group_name, environment_name, component_name, subscription_id		Delete a Dapr Component. Delete a Dapr Component from a Managed Environment.
list_secrets	exec	resource_group_name, environment_name, component_name, subscription_id		List secrets for a dapr component. List secrets for a dapr component.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
component_name	string	Name of the Dapr Component. Required.
environment_name	string	Name of the Managed Environment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a dapr component. Get a dapr component.

SELECT
id,
name,
componentType,
deploymentErrors,
ignoreErrors,
initTimeout,
metadata,
provisioningState,
scopes,
secretStoreComponent,
secrets,
systemData,
type,
version
FROM azure.app_containers.dapr_components
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND component_name = '{{ component_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get the Dapr Components for a managed environment. Get the Dapr Components for a managed environment.

SELECT
id,
name,
componentType,
deploymentErrors,
ignoreErrors,
initTimeout,
metadata,
provisioningState,
scopes,
secretStoreComponent,
secrets,
systemData,
type,
version
FROM azure.app_containers.dapr_components
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Dapr Component. Creates or updates a Dapr Component in a Managed Environment.

INSERT INTO azure.app_containers.dapr_components (
properties,
resource_group_name,
environment_name,
component_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ component_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dapr_components
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dapr_components resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the dapr_components resource.
  - name: component_name
    value: "{{ component_name }}"
    description: Required parameter for the dapr_components resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dapr_components resource.
  - name: properties
    description: |
      Dapr Component resource specific properties.
    value:
      componentType: "{{ componentType }}"
      version: "{{ version }}"
      ignoreErrors: {{ ignoreErrors }}
      initTimeout: "{{ initTimeout }}"
      secrets:
        - name: "{{ name }}"
          value: "{{ value }}"
          identity: "{{ identity }}"
          keyVaultUrl: "{{ keyVaultUrl }}"
      secretStoreComponent: "{{ secretStoreComponent }}"
      metadata:
        - name: "{{ name }}"
          value: "{{ value }}"
          secretRef: "{{ secretRef }}"
      scopes:
        - "{{ scopes }}"
      provisioningState: "{{ provisioningState }}"
      deploymentErrors: "{{ deploymentErrors }}"

REPLACE examples

create_or_update

Creates or updates a Dapr Component. Creates or updates a Dapr Component in a Managed Environment.

REPLACE azure.app_containers.dapr_components
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND component_name = '{{ component_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Dapr Component. Delete a Dapr Component from a Managed Environment.

DELETE FROM azure.app_containers.dapr_components
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND component_name = '{{ component_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_secrets

List secrets for a dapr component. List secrets for a dapr component.

EXEC azure.app_containers.dapr_components.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@component_name='{{ component_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;