dras

Creates, updates, deletes, gets or lists a dras resource.

Overview

Name	dras
Type	Resource
Id	azure.data_replication.dras

Fields

The following fields are returned by SELECT queries:

get

Returns Dra 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	Dra model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

list

Returns Dra 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	Dra 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, fabricName, fabricAgentName		Gets the details of the fabric agent.
list	select	subscriptionId, resourceGroupName, fabricName		Gets the list of fabric agents in the given fabric.
create	insert	subscriptionId, resourceGroupName, fabricName, fabricAgentName, data__properties		Creates the fabric agent.
delete	delete	subscriptionId, resourceGroupName, fabricName, fabricAgentName		Deletes the fabric agent.

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
fabricAgentName	string	The fabric agent (Dra) name.
fabricName	string	The fabric 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.

SELECT examples

get

Gets the details of the fabric agent.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.dras
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND fabricAgentName = '{{ fabricAgentName }}' -- required
;

list

Gets the list of fabric agents in the given fabric.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.dras
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fabricName = '{{ fabricName }}' -- required
;

INSERT examples

create

Creates the fabric agent.

INSERT INTO azure.data_replication.dras (
data__properties,
subscriptionId,
resourceGroupName,
fabricName,
fabricAgentName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fabricName }}',
'{{ fabricAgentName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dras
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dras resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dras resource.
    - name: fabricName
      value: string
      description: Required parameter for the dras resource.
    - name: fabricAgentName
      value: string
      description: Required parameter for the dras resource.
    - name: properties
      value: object
      description: |
        Dra model properties.

DELETE examples

delete

Deletes the fabric agent.

DELETE FROM azure.data_replication.dras
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fabricName = '{{ fabricName }}' --required
AND fabricAgentName = '{{ fabricAgentName }}' --required
;