你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Workflows interface

表示工作流的接口。

方法

beginMove(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

移动现有工作流。

beginMoveAndWait(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

移动现有工作流。

createOrUpdate(string, string, Workflow, WorkflowsCreateOrUpdateOptionalParams)

创建或更新工作流。

delete(string, string, WorkflowsDeleteOptionalParams)

删除工作流。

disable(string, string, WorkflowsDisableOptionalParams)

禁用工作流。

enable(string, string, WorkflowsEnableOptionalParams)

启用工作流。

generateUpgradedDefinition(string, string, GenerateUpgradedDefinitionParameters, WorkflowsGenerateUpgradedDefinitionOptionalParams)

生成工作流的升级定义。

get(string, string, WorkflowsGetOptionalParams)

获取工作流。

listByResourceGroup(string, WorkflowsListByResourceGroupOptionalParams)

按资源组获取工作流列表。

listBySubscription(WorkflowsListBySubscriptionOptionalParams)

按订阅获取工作流列表。

listCallbackUrl(string, string, GetCallbackUrlParameters, WorkflowsListCallbackUrlOptionalParams)

获取工作流回调 URL。

listSwagger(string, string, WorkflowsListSwaggerOptionalParams)

获取工作流的 OpenAPI 定义。

regenerateAccessKey(string, string, RegenerateActionParameter, WorkflowsRegenerateAccessKeyOptionalParams)

重新生成请求触发器的回调 URL 访问密钥。

update(string, string, WorkflowsUpdateOptionalParams)

更新工作流。

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

验证工作流定义。

validateByResourceGroup(string, string, Workflow, WorkflowsValidateByResourceGroupOptionalParams)

验证工作流。

方法详细信息

beginMove(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

移动现有工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

move
WorkflowReference

要移动的工作流。

options
WorkflowsMoveOptionalParams

选项参数。

返回

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

beginMoveAndWait(string, string, WorkflowReference, WorkflowsMoveOptionalParams)

移动现有工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

move
WorkflowReference

要移动的工作流。

options
WorkflowsMoveOptionalParams

选项参数。

返回

Promise<void>

createOrUpdate(string, string, Workflow, WorkflowsCreateOrUpdateOptionalParams)

创建或更新工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

workflow
Workflow

工作流。

options
WorkflowsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<Workflow>

delete(string, string, WorkflowsDeleteOptionalParams)

删除工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsDeleteOptionalParams

选项参数。

返回

Promise<void>

disable(string, string, WorkflowsDisableOptionalParams)

禁用工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsDisableOptionalParams

选项参数。

返回

Promise<void>

enable(string, string, WorkflowsEnableOptionalParams)

启用工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsEnableOptionalParams

选项参数。

返回

Promise<void>

generateUpgradedDefinition(string, string, GenerateUpgradedDefinitionParameters, WorkflowsGenerateUpgradedDefinitionOptionalParams)

生成工作流的升级定义。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

parameters
GenerateUpgradedDefinitionParameters

用于生成升级定义的参数。

返回

get(string, string, WorkflowsGetOptionalParams)

获取工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsGetOptionalParams

选项参数。

返回

Promise<Workflow>

listByResourceGroup(string, WorkflowsListByResourceGroupOptionalParams)

按资源组获取工作流列表。

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

参数

resourceGroupName

string

资源组名称。

返回

listBySubscription(WorkflowsListBySubscriptionOptionalParams)

按订阅获取工作流列表。

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

参数

返回

listCallbackUrl(string, string, GetCallbackUrlParameters, WorkflowsListCallbackUrlOptionalParams)

获取工作流回调 URL。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

listCallbackUrl
GetCallbackUrlParameters

要列出的回调 URL。

options
WorkflowsListCallbackUrlOptionalParams

选项参数。

返回

listSwagger(string, string, WorkflowsListSwaggerOptionalParams)

获取工作流的 OpenAPI 定义。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsListSwaggerOptionalParams

选项参数。

返回

regenerateAccessKey(string, string, RegenerateActionParameter, WorkflowsRegenerateAccessKeyOptionalParams)

重新生成请求触发器的回调 URL 访问密钥。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

keyType
RegenerateActionParameter

访问密钥类型。

返回

Promise<void>

update(string, string, WorkflowsUpdateOptionalParams)

更新工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

options
WorkflowsUpdateOptionalParams

选项参数。

返回

Promise<Workflow>

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

验证工作流定义。

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

参数

resourceGroupName

string

资源组名称。

location

string

工作流位置。

workflowName

string

工作流名称。

validate
Workflow

工作流。

返回

Promise<void>

validateByResourceGroup(string, string, Workflow, WorkflowsValidateByResourceGroupOptionalParams)

验证工作流。

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

参数

resourceGroupName

string

资源组名称。

workflowName

string

工作流名称。

validate
Workflow

工作流。

返回

Promise<void>