fabric_agent

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

Overview

Name	fabric_agent
Type	Resource
Id	azure.recovery_services_data_replication.fabric_agent

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.
authenticationIdentity	object	Identity model. Required.
correlationId	string	Gets or sets the fabric agent correlation Id.
customProperties	object	Fabric agent model custom properties. Required.
healthErrors	array	Gets or sets the list of health errors.
isResponsive	boolean	Gets or sets a value indicating whether the fabric agent is responsive.
lastHeartbeat	string (date-time)	Gets or sets the time when last heartbeat was sent by the fabric agent.
machineId	string	Gets or sets the machine Id where fabric agent is running. Required.
machineName	string	Gets or sets the machine name where fabric agent is running. Required.
provisioningState	string	Gets or sets the provisioning state of the fabric agent. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
resourceAccessIdentity	object	Identity model. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionNumber	string	Gets or sets the fabric agent version.

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.
authenticationIdentity	object	Identity model. Required.
correlationId	string	Gets or sets the fabric agent correlation Id.
customProperties	object	Fabric agent model custom properties. Required.
healthErrors	array	Gets or sets the list of health errors.
isResponsive	boolean	Gets or sets a value indicating whether the fabric agent is responsive.
lastHeartbeat	string (date-time)	Gets or sets the time when last heartbeat was sent by the fabric agent.
machineId	string	Gets or sets the machine Id where fabric agent is running. Required.
machineName	string	Gets or sets the machine name where fabric agent is running. Required.
provisioningState	string	Gets or sets the provisioning state of the fabric agent. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
resourceAccessIdentity	object	Identity model. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionNumber	string	Gets or sets the fabric agent version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, fabric_name, fabric_agent_name, subscription_id		Gets the details of the fabric agent.
list	select	resource_group_name, fabric_name, subscription_id		Gets the list of fabric agents in the given fabric.
create	insert	resource_group_name, fabric_name, fabric_agent_name, subscription_id		Creates the fabric agent.
delete	delete	resource_group_name, fabric_name, fabric_agent_name, subscription_id		Deletes 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
fabric_agent_name	string	The fabric agent name. Required.
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

SELECT examples

get

Gets the details of the fabric agent.

SELECT
id,
name,
authenticationIdentity,
correlationId,
customProperties,
healthErrors,
isResponsive,
lastHeartbeat,
machineId,
machineName,
provisioningState,
resourceAccessIdentity,
systemData,
type,
versionNumber
FROM azure.recovery_services_data_replication.fabric_agent
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND fabric_agent_name = '{{ fabric_agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of fabric agents in the given fabric.

SELECT
id,
name,
authenticationIdentity,
correlationId,
customProperties,
healthErrors,
isResponsive,
lastHeartbeat,
machineId,
machineName,
provisioningState,
resourceAccessIdentity,
systemData,
type,
versionNumber
FROM azure.recovery_services_data_replication.fabric_agent
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the fabric agent.

INSERT INTO azure.recovery_services_data_replication.fabric_agent (
properties,
resource_group_name,
fabric_name,
fabric_agent_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fabric_name }}',
'{{ fabric_agent_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: fabric_agent
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fabric_agent resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the fabric_agent resource.
  - name: fabric_agent_name
    value: "{{ fabric_agent_name }}"
    description: Required parameter for the fabric_agent resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fabric_agent resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      correlationId: "{{ correlationId }}"
      machineId: "{{ machineId }}"
      machineName: "{{ machineName }}"
      authenticationIdentity:
        tenantId: "{{ tenantId }}"
        applicationId: "{{ applicationId }}"
        objectId: "{{ objectId }}"
        audience: "{{ audience }}"
        aadAuthority: "{{ aadAuthority }}"
      resourceAccessIdentity:
        tenantId: "{{ tenantId }}"
        applicationId: "{{ applicationId }}"
        objectId: "{{ objectId }}"
        audience: "{{ audience }}"
        aadAuthority: "{{ aadAuthority }}"
      isResponsive: {{ isResponsive }}
      lastHeartbeat: "{{ lastHeartbeat }}"
      versionNumber: "{{ versionNumber }}"
      provisioningState: "{{ provisioningState }}"
      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 }}"

DELETE examples

delete

Deletes fabric agent.

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