Workflows interface

Package:

@azure/arm-logic

Interface representing a Workflows.

Methods

beginMove(string, string, WorkflowReference, WorkflowsMoveOptionalParams)	Moves an existing workflow.
beginMoveAndWait(string, string, WorkflowReference, WorkflowsMoveOptionalParams)	Moves an existing workflow.
createOrUpdate(string, string, Workflow, WorkflowsCreateOrUpdateOptionalParams)	Creates or updates a workflow.
delete(string, string, WorkflowsDeleteOptionalParams)	Deletes a workflow.
disable(string, string, WorkflowsDisableOptionalParams)	Disables a workflow.
enable(string, string, WorkflowsEnableOptionalParams)	Enables a workflow.
generateUpgradedDefinition(string, string, GenerateUpgradedDefinitionParameters, WorkflowsGenerateUpgradedDefinitionOptionalParams)	Generates the upgraded definition for a workflow.
get(string, string, WorkflowsGetOptionalParams)	Gets a workflow.
listByResourceGroup(string, WorkflowsListByResourceGroupOptionalParams)	Gets a list of workflows by resource group.
listBySubscription(WorkflowsListBySubscriptionOptionalParams)	Gets a list of workflows by subscription.
listCallbackUrl(string, string, GetCallbackUrlParameters, WorkflowsListCallbackUrlOptionalParams)	Get the workflow callback Url.
listSwagger(string, string, WorkflowsListSwaggerOptionalParams)	Gets an OpenAPI definition for the workflow.
regenerateAccessKey(string, string, RegenerateActionParameter, WorkflowsRegenerateAccessKeyOptionalParams)	Regenerates the callback URL access key for request triggers.
update(string, string, WorkflowsUpdateOptionalParams)	Updates a workflow.
validateByLocation(string, string, string, Workflow, WorkflowsValidateByLocationOptionalParams)	Validates the workflow definition.
validateByResourceGroup(string, string, Workflow, WorkflowsValidateByResourceGroupOptionalParams)	Validates the workflow.

Method Details

beginMove(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

Moves an existing workflow.

function beginMove(resourceGroupName: string, workflowName: string, move: WorkflowReference, options?: WorkflowsMoveOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

move

WorkflowReference

The workflow to move.

options

WorkflowsMoveOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginMoveAndWait(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

Moves an existing workflow.

function beginMoveAndWait(resourceGroupName: string, workflowName: string, move: WorkflowReference, options?: WorkflowsMoveOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

move

WorkflowReference

The workflow to move.

options

WorkflowsMoveOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, Workflow, WorkflowsCreateOrUpdateOptionalParams)

Creates or updates a workflow.

function createOrUpdate(resourceGroupName: string, workflowName: string, workflow: Workflow, options?: WorkflowsCreateOrUpdateOptionalParams): Promise<Workflow>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

workflow

Workflow

The workflow.

options

WorkflowsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workflow>

delete(string, string, WorkflowsDeleteOptionalParams)

Deletes a workflow.

function delete(resourceGroupName: string, workflowName: string, options?: WorkflowsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

disable(string, string, WorkflowsDisableOptionalParams)

Disables a workflow.

function disable(resourceGroupName: string, workflowName: string, options?: WorkflowsDisableOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsDisableOptionalParams

The options parameters.

Returns

Promise<void>

enable(string, string, WorkflowsEnableOptionalParams)

Enables a workflow.

function enable(resourceGroupName: string, workflowName: string, options?: WorkflowsEnableOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsEnableOptionalParams

The options parameters.

Returns

Promise<void>

generateUpgradedDefinition(string, string, GenerateUpgradedDefinitionParameters, WorkflowsGenerateUpgradedDefinitionOptionalParams)

Generates the upgraded definition for a workflow.

function generateUpgradedDefinition(resourceGroupName: string, workflowName: string, parameters: GenerateUpgradedDefinitionParameters, options?: WorkflowsGenerateUpgradedDefinitionOptionalParams): Promise<WorkflowsGenerateUpgradedDefinitionResponse>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

parameters

GenerateUpgradedDefinitionParameters

Parameters for generating an upgraded definition.

options

WorkflowsGenerateUpgradedDefinitionOptionalParams

The options parameters.

Returns

Promise<WorkflowsGenerateUpgradedDefinitionResponse>

get(string, string, WorkflowsGetOptionalParams)

Gets a workflow.

function get(resourceGroupName: string, workflowName: string, options?: WorkflowsGetOptionalParams): Promise<Workflow>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsGetOptionalParams

The options parameters.

Returns

Promise<Workflow>

listByResourceGroup(string, WorkflowsListByResourceGroupOptionalParams)

Gets a list of workflows by resource group.

function listByResourceGroup(resourceGroupName: string, options?: WorkflowsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

options

WorkflowsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

listBySubscription(WorkflowsListBySubscriptionOptionalParams)

Gets a list of workflows by subscription.

function listBySubscription(options?: WorkflowsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

Parameters

options

WorkflowsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

listCallbackUrl(string, string, GetCallbackUrlParameters, WorkflowsListCallbackUrlOptionalParams)

Get the workflow callback Url.

function listCallbackUrl(resourceGroupName: string, workflowName: string, listCallbackUrl: GetCallbackUrlParameters, options?: WorkflowsListCallbackUrlOptionalParams): Promise<WorkflowTriggerCallbackUrl>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

listCallbackUrl

GetCallbackUrlParameters

Which callback url to list.

options

WorkflowsListCallbackUrlOptionalParams

The options parameters.

Returns

Promise<WorkflowTriggerCallbackUrl>

listSwagger(string, string, WorkflowsListSwaggerOptionalParams)

Gets an OpenAPI definition for the workflow.

function listSwagger(resourceGroupName: string, workflowName: string, options?: WorkflowsListSwaggerOptionalParams): Promise<WorkflowsListSwaggerResponse>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsListSwaggerOptionalParams

The options parameters.

Returns

Promise<WorkflowsListSwaggerResponse>

regenerateAccessKey(string, string, RegenerateActionParameter, WorkflowsRegenerateAccessKeyOptionalParams)

Regenerates the callback URL access key for request triggers.

function regenerateAccessKey(resourceGroupName: string, workflowName: string, keyType: RegenerateActionParameter, options?: WorkflowsRegenerateAccessKeyOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

keyType

RegenerateActionParameter

The access key type.

options

WorkflowsRegenerateAccessKeyOptionalParams

The options parameters.

Returns

Promise<void>

update(string, string, WorkflowsUpdateOptionalParams)

Updates a workflow.

function update(resourceGroupName: string, workflowName: string, options?: WorkflowsUpdateOptionalParams): Promise<Workflow>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

options

WorkflowsUpdateOptionalParams

The options parameters.

Returns

Promise<Workflow>

validateByLocation(string, string, string, Workflow, WorkflowsValidateByLocationOptionalParams)

Validates the workflow definition.

function validateByLocation(resourceGroupName: string, location: string, workflowName: string, validate: Workflow, options?: WorkflowsValidateByLocationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

location

string

The workflow location.

workflowName

string

The workflow name.

validate

Workflow

The workflow.

options

WorkflowsValidateByLocationOptionalParams

The options parameters.

Returns

Promise<void>

validateByResourceGroup(string, string, Workflow, WorkflowsValidateByResourceGroupOptionalParams)

Validates the workflow.

function validateByResourceGroup(resourceGroupName: string, workflowName: string, validate: Workflow, options?: WorkflowsValidateByResourceGroupOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

workflowName

string

The workflow name.

validate

Workflow

The workflow.

options

WorkflowsValidateByResourceGroupOptionalParams

The options parameters.

Returns

Promise<void>