WorkflowOperations interface

  • Reference
Package:
@azure/arm-devhub

Interface representing a WorkflowOperations.

Methods

createOrUpdate(string, string, Workflow, WorkflowCreateOrUpdateOptionalParams)

Creates or updates a workflow
delete(string, string, WorkflowDeleteOptionalParams)

Deletes a workflow
get(string, string, WorkflowGetOptionalParams)

Gets a workflow.
list(WorkflowListOptionalParams)

Gets a list of workflows associated with the specified subscription.
listByResourceGroup(string, WorkflowListByResourceGroupOptionalParams)

Gets a list of workflows within a resource group.
updateTags(string, string, TagsObject, WorkflowUpdateTagsOptionalParams)

Updates tags on a workflow.

Method Details

createOrUpdate(string, string, Workflow, WorkflowCreateOrUpdateOptionalParams)

Creates or updates a workflow

function createOrUpdate(resourceGroupName: string, workflowName: string, parameters: Workflow, options?: WorkflowCreateOrUpdateOptionalParams): Promise<Workflow>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workflowName

string

The name of the workflow resource.

parameters
Workflow

Resource representation of a workflow

options
WorkflowCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workflow>

delete(string, string, WorkflowDeleteOptionalParams)

Deletes a workflow

function delete(resourceGroupName: string, workflowName: string, options?: WorkflowDeleteOptionalParams): Promise<DeleteWorkflowResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workflowName

string

The name of the workflow resource.

options
WorkflowDeleteOptionalParams

The options parameters.

Returns

Promise<DeleteWorkflowResponse>

get(string, string, WorkflowGetOptionalParams)

Gets a workflow.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workflowName

string

The name of the workflow resource.

options
WorkflowGetOptionalParams

The options parameters.

Returns

Promise<Workflow>

list(WorkflowListOptionalParams)

Gets a list of workflows associated with the specified subscription.

function list(options?: WorkflowListOptionalParams): PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

Parameters

options
WorkflowListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

listByResourceGroup(string, WorkflowListByResourceGroupOptionalParams)

Gets a list of workflows within a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
WorkflowListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

updateTags(string, string, TagsObject, WorkflowUpdateTagsOptionalParams)

Updates tags on a workflow.

function updateTags(resourceGroupName: string, workflowName: string, parameters: TagsObject, options?: WorkflowUpdateTagsOptionalParams): Promise<Workflow>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workflowName

string

The name of the workflow resource.

parameters
TagsObject

Parameters supplied to the Update Workflow Tags operation.

options
WorkflowUpdateTagsOptionalParams

The options parameters.

Returns

Promise<Workflow>