workflows
Creates, updates, deletes, gets or lists a workflows resource.
Overview
| Name | workflows |
| Type | Resource |
| Id | azure.data_replication.workflows |
Fields
The following fields are returned by SELECT queries:
- get
- list
Returns Workflow Model on success.
| Name | Datatype | Description |
|---|---|---|
id | string | Gets or sets the Id of the resource. |
name | string | Gets or sets the name of the resource. |
properties | object | Workflow model properties. |
systemData | object | System data required to be defined for Azure resources. |
type | string | Gets or sets the type of the resource. |
Returns Workflow Model Collection on success.
| Name | Datatype | Description |
|---|---|---|
id | string | Gets or sets the Id of the resource. |
name | string | Gets or sets the name of the resource. |
properties | object | Workflow model properties. |
systemData | object | System data required to be defined for Azure resources. |
type | string | Gets or sets the type of the resource. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, vaultName, jobName | Gets the details of the job. | |
list | select | subscriptionId, resourceGroupName, vaultName | $filter, continuationToken | Gets the list of jobs in the given vault. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
jobName | string | The job (workflow) name. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
vaultName | string | The vault name. |
$filter | string | Filter string. |
continuationToken | string | Continuation token. |
SELECT examples
- get
- list
Gets the details of the job.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND jobName = '{{ jobName }}' -- required
;
Gets the list of jobs in the given vault.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND $filter = '{{ $filter }}'
AND continuationToken = '{{ continuationToken }}'
;