Workflows interface

Package:

@azure/arm-storagesync

Interface representing a Workflows.

Methods

abort(string, string, string, WorkflowsAbortOptionalParams)	Abort the given workflow.
get(string, string, string, WorkflowsGetOptionalParams)	Get Workflows resource
listByStorageSyncService(string, string, WorkflowsListByStorageSyncServiceOptionalParams)	Get a Workflow List

Method Details

abort(string, string, string, WorkflowsAbortOptionalParams)

Abort the given workflow.

function abort(resourceGroupName: string, storageSyncServiceName: string, workflowId: string, options?: WorkflowsAbortOptionalParams): Promise<WorkflowsAbortHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

workflowId

string

workflow Id

options

WorkflowsAbortOptionalParams

The options parameters.

Returns

Promise<WorkflowsAbortHeaders>

get(string, string, string, WorkflowsGetOptionalParams)

Get Workflows resource

function get(resourceGroupName: string, storageSyncServiceName: string, workflowId: string, options?: WorkflowsGetOptionalParams): Promise<WorkflowsGetResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

workflowId

string

workflow Id

options

WorkflowsGetOptionalParams

The options parameters.

Returns

Promise<WorkflowsGetResponse>

listByStorageSyncService(string, string, WorkflowsListByStorageSyncServiceOptionalParams)

Get a Workflow List

function listByStorageSyncService(resourceGroupName: string, storageSyncServiceName: string, options?: WorkflowsListByStorageSyncServiceOptionalParams): PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

WorkflowsListByStorageSyncServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workflow, Workflow[], PageSettings>