Package version:

Interface DaprComponents

Interface representing a DaprComponents.

interface DaprComponents {
    createOrUpdate(resourceGroupName: string, environmentName: string, componentName: string, daprComponentEnvelope: DaprComponent, options?: DaprComponentsCreateOrUpdateOptionalParams): Promise<DaprComponent>;
    delete(resourceGroupName: string, environmentName: string, componentName: string, options?: DaprComponentsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, environmentName: string, componentName: string, options?: DaprComponentsGetOptionalParams): Promise<DaprComponent>;
    list(resourceGroupName: string, environmentName: string, options?: DaprComponentsListOptionalParams): PagedAsyncIterableIterator<DaprComponent>;
    listSecrets(resourceGroupName: string, environmentName: string, componentName: string, options?: DaprComponentsListSecretsOptionalParams): Promise<DaprSecretsCollection>;
}

Methods

createOrUpdate(resourceGroupName, environmentName, componentName, daprComponentEnvelope, options?): Promise<DaprComponent>
Creates or updates a Dapr Component in a Managed Environment.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- componentName: string
  Name of the Dapr Component.
- daprComponentEnvelope: DaprComponent
  Configuration details of the Dapr Component.
- Optionaloptions: DaprComponentsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<DaprComponent>
- Defined in operationsInterfaces/daprComponents.ts:57

delete(resourceGroupName, environmentName, componentName, options?): Promise<void>
Delete a Dapr Component from a Managed Environment.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- componentName: string
  Name of the Dapr Component.
- Optionaloptions: DaprComponentsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/daprComponents.ts:71

get(resourceGroupName, environmentName, componentName, options?): Promise<DaprComponent>
Get a dapr component.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- componentName: string
  Name of the Dapr Component.
- Optionaloptions: DaprComponentsGetOptionalParams
  The options parameters.
Returns Promise<DaprComponent>
- Defined in operationsInterfaces/daprComponents.ts:43

list(resourceGroupName, environmentName, options?): PagedAsyncIterableIterator<DaprComponent>
Get the Dapr Components for a managed environment.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- Optionaloptions: DaprComponentsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DaprComponent>
- Defined in operationsInterfaces/daprComponents.ts:31

listSecrets(resourceGroupName, environmentName, componentName, options?): Promise<DaprSecretsCollection>
List secrets for a dapr component
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- componentName: string
  Name of the Dapr Component.
- Optionaloptions: DaprComponentsListSecretsOptionalParams
  The options parameters.
Returns Promise<DaprSecretsCollection>
- Defined in operationsInterfaces/daprComponents.ts:84