fabrics

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

Overview

Name	fabrics
Type	Resource
Id	azure.data_replication.fabrics

Fields

The following fields are returned by SELECT queries:

get

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

list

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

list_by_subscription

Returns Fabric 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.
location	string	Gets or sets the location of the fabric.
properties	object	Fabric model properties.
systemData	object	System data required to be defined for Azure resources.
tags	object	Gets or sets the resource tags.
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		Gets the details of the fabric.
list	select	subscriptionId, resourceGroupName	continuationToken	Gets the list of fabrics in the given subscription and resource group.
list_by_subscription	select	subscriptionId	continuationToken	Gets the list of fabrics in the given subscription.
create	insert	subscriptionId, resourceGroupName, fabricName, data__location, data__properties		Creates the fabric.
update	update	subscriptionId, resourceGroupName, fabricName		Performs update on the fabric.
delete	delete	subscriptionId, resourceGroupName, fabricName		Removes the fabric.

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
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.
continuationToken	string	Continuation token from the previous call.

SELECT examples

get

Gets the details of the fabric.

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

list

Gets the list of fabrics in the given subscription and resource group.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.fabrics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

list_by_subscription

Gets the list of fabrics in the given subscription.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.fabrics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

INSERT examples

create

Creates the fabric.

INSERT INTO azure.data_replication.fabrics (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
fabricName
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fabricName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fabrics
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the fabrics resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the fabrics resource.
    - name: fabricName
      value: string
      description: Required parameter for the fabrics resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the fabric.
    - name: tags
      value: object
      description: |
        Gets or sets the resource tags.
    - name: properties
      value: object
      description: |
        Fabric model properties.

UPDATE examples

update

Performs update on the fabric.

UPDATE azure.data_replication.fabrics
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fabricName = '{{ fabricName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Removes the fabric.

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