fabric

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

Overview

Name	fabric
Type	Resource
Id	azure.recovery_services_data_replication.fabric

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customProperties	object	Fabric model custom properties. Required.
health	string	Gets or sets the fabric health. Known values are: "Normal", "Warning", and "Critical". (Normal, Warning, Critical)
healthErrors	array	Gets or sets the list of health errors.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the fabric. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceEndpoint	string	Gets or sets the service endpoint.
serviceResourceId	string	Gets or sets the service resource Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customProperties	object	Fabric model custom properties. Required.
health	string	Gets or sets the fabric health. Known values are: "Normal", "Warning", and "Critical". (Normal, Warning, Critical)
healthErrors	array	Gets or sets the list of health errors.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the fabric. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceEndpoint	string	Gets or sets the service endpoint.
serviceResourceId	string	Gets or sets the service resource Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customProperties	object	Fabric model custom properties. Required.
health	string	Gets or sets the fabric health. Known values are: "Normal", "Warning", and "Critical". (Normal, Warning, Critical)
healthErrors	array	Gets or sets the list of health errors.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the fabric. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceEndpoint	string	Gets or sets the service endpoint.
serviceResourceId	string	Gets or sets the service resource Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, fabric_name, subscription_id		Gets the details of the fabric.
list	select	resource_group_name, subscription_id	continuationToken	Gets the list of fabrics in the given subscription and resource group.
list_by_subscription	select	subscription_id		Gets the list of fabrics in the given subscription.
create	insert	resource_group_name, fabric_name, subscription_id, location		Creates the fabric.
update	update	resource_group_name, fabric_name, subscription_id		Performs update on the fabric.
delete	delete	resource_group_name, fabric_name, subscription_id		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
fabric_name	string	The fabric name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
continuationToken	string	Continuation token from the previous call. Default value is None.

SELECT examples

get

Gets the details of the fabric.

SELECT
id,
name,
customProperties,
health,
healthErrors,
location,
provisioningState,
serviceEndpoint,
serviceResourceId,
systemData,
tags,
type
FROM azure.recovery_services_data_replication.fabric
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
customProperties,
health,
healthErrors,
location,
provisioningState,
serviceEndpoint,
serviceResourceId,
systemData,
tags,
type
FROM azure.recovery_services_data_replication.fabric
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

list_by_subscription

Gets the list of fabrics in the given subscription.

SELECT
id,
name,
customProperties,
health,
healthErrors,
location,
provisioningState,
serviceEndpoint,
serviceResourceId,
systemData,
tags,
type
FROM azure.recovery_services_data_replication.fabric
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the fabric.

INSERT INTO azure.recovery_services_data_replication.fabric (
tags,
location,
properties,
resource_group_name,
fabric_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fabric_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fabric
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fabric resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the fabric resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fabric resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      serviceEndpoint: "{{ serviceEndpoint }}"
      serviceResourceId: "{{ serviceResourceId }}"
      health: "{{ health }}"
      healthErrors:
        - affectedResourceType: "{{ affectedResourceType }}"
          affectedResourceCorrelationIds: "{{ affectedResourceCorrelationIds }}"
          childErrors: "{{ childErrors }}"
          code: "{{ code }}"
          healthCategory: "{{ healthCategory }}"
          category: "{{ category }}"
          severity: "{{ severity }}"
          source: "{{ source }}"
          creationTime: "{{ creationTime }}"
          isCustomerResolvable: {{ isCustomerResolvable }}
          summary: "{{ summary }}"
          message: "{{ message }}"
          causes: "{{ causes }}"
          recommendation: "{{ recommendation }}"
      customProperties:
        instanceType: "{{ instanceType }}"

UPDATE examples

update

Performs update on the fabric.

UPDATE azure.recovery_services_data_replication.fabric
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Removes the fabric.

DELETE FROM azure.recovery_services_data_replication.fabric
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;