Microsoft.DataReplication replicationFabrics/fabricAgents

Bicep resource definition

The replicationFabrics/fabricAgents resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataReplication/replicationFabrics/fabricAgents resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataReplication/replicationFabrics/fabricAgents@2026-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authenticationIdentity: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      tenantId: 'string'
    }
    customProperties: {
      instanceType: 'string'
      // For remaining properties, see FabricAgentModelCustomProperties objects
    }
    machineId: 'string'
    machineName: 'string'
    resourceAccessIdentity: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      tenantId: 'string'
    }
  }
}

FabricAgentModelCustomProperties objects

Set the instanceType property to specify the type of object.

For VMware, use:

{
  biosId: 'string'
  instanceType: 'VMware'
  marsAuthenticationIdentity: {
    aadAuthority: 'string'
    applicationId: 'string'
    audience: 'string'
    objectId: 'string'
    tenantId: 'string'
  }
}

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

Name	Description	Value
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: replicationFabrics
properties	The resource-specific properties for this resource.	FabricAgentModelProperties

FabricAgentModelCustomProperties

Name	Description	Value
instanceType	Set to 'VMware' for type VMwareFabricAgentModelCustomProperties.	'VMware' (required)

FabricAgentModelProperties

Name	Description	Value
authenticationIdentity	Identity model.	IdentityModel (required)
customProperties	Fabric agent model custom properties.	FabricAgentModelCustomProperties (required)
machineId	Gets or sets the machine Id where fabric agent is running.	string Constraints: Min length = 1 (required)
machineName	Gets or sets the machine name where fabric agent is running.	string Constraints: Min length = 1 (required)
resourceAccessIdentity	Identity model.	IdentityModel (required)

IdentityModel

Name	Description	Value
aadAuthority	Gets or sets the authority of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
applicationId	Gets or sets the client/application Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
audience	Gets or sets the audience of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
objectId	Gets or sets the object Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
tenantId	Gets or sets the tenant Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)

VMwareFabricAgentModelCustomProperties

Name	Description	Value
biosId	Gets or sets the BIOS Id of the fabric agent machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for FabricAgentModelCustomProperties.	'VMware' (required)
marsAuthenticationIdentity	Identity model.	IdentityModel (required)

ARM template resource definition

The replicationFabrics/fabricAgents resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Resource format

To create a Microsoft.DataReplication/replicationFabrics/fabricAgents resource, add the following JSON to your template.

{
  "type": "Microsoft.DataReplication/replicationFabrics/fabricAgents",
  "apiVersion": "2026-05-01",
  "name": "string",
  "properties": {
    "authenticationIdentity": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "tenantId": "string"
    },
    "customProperties": {
      "instanceType": "string"
      // For remaining properties, see FabricAgentModelCustomProperties objects
    },
    "machineId": "string",
    "machineName": "string",
    "resourceAccessIdentity": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "tenantId": "string"
    }
  }
}

FabricAgentModelCustomProperties objects

Set the instanceType property to specify the type of object.

For VMware, use:

{
  "biosId": "string",
  "instanceType": "VMware",
  "marsAuthenticationIdentity": {
    "aadAuthority": "string",
    "applicationId": "string",
    "audience": "string",
    "objectId": "string",
    "tenantId": "string"
  }
}

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

Name	Description	Value
apiVersion	The api version	'2026-05-01'
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
properties	The resource-specific properties for this resource.	FabricAgentModelProperties
type	The resource type	'Microsoft.DataReplication/replicationFabrics/fabricAgents'

FabricAgentModelCustomProperties

Name	Description	Value
instanceType	Set to 'VMware' for type VMwareFabricAgentModelCustomProperties.	'VMware' (required)

FabricAgentModelProperties

Name	Description	Value
authenticationIdentity	Identity model.	IdentityModel (required)
customProperties	Fabric agent model custom properties.	FabricAgentModelCustomProperties (required)
machineId	Gets or sets the machine Id where fabric agent is running.	string Constraints: Min length = 1 (required)
machineName	Gets or sets the machine name where fabric agent is running.	string Constraints: Min length = 1 (required)
resourceAccessIdentity	Identity model.	IdentityModel (required)

IdentityModel

Name	Description	Value
aadAuthority	Gets or sets the authority of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
applicationId	Gets or sets the client/application Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
audience	Gets or sets the audience of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
objectId	Gets or sets the object Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
tenantId	Gets or sets the tenant Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)

VMwareFabricAgentModelCustomProperties

Name	Description	Value
biosId	Gets or sets the BIOS Id of the fabric agent machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for FabricAgentModelCustomProperties.	'VMware' (required)
marsAuthenticationIdentity	Identity model.	IdentityModel (required)

Terraform (AzAPI provider) resource definition

The replicationFabrics/fabricAgents resource type can be deployed with operations that target:

Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataReplication/replicationFabrics/fabricAgents resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataReplication/replicationFabrics/fabricAgents@2026-05-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      authenticationIdentity = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        tenantId = "string"
      }
      customProperties = {
        instanceType = "string"
        // For remaining properties, see FabricAgentModelCustomProperties objects
      }
      machineId = "string"
      machineName = "string"
      resourceAccessIdentity = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        tenantId = "string"
      }
    }
  }
}

FabricAgentModelCustomProperties objects

Set the instanceType property to specify the type of object.

For VMware, use:

{
  biosId = "string"
  instanceType = "VMware"
  marsAuthenticationIdentity = {
    aadAuthority = "string"
    applicationId = "string"
    audience = "string"
    objectId = "string"
    tenantId = "string"
  }
}

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

Name	Description	Value
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: replicationFabrics
properties	The resource-specific properties for this resource.	FabricAgentModelProperties
type	The resource type	"Microsoft.DataReplication/replicationFabrics/fabricAgents@2026-05-01"

FabricAgentModelCustomProperties

Name	Description	Value
instanceType	Set to 'VMware' for type VMwareFabricAgentModelCustomProperties.	'VMware' (required)

FabricAgentModelProperties

Name	Description	Value
authenticationIdentity	Identity model.	IdentityModel (required)
customProperties	Fabric agent model custom properties.	FabricAgentModelCustomProperties (required)
machineId	Gets or sets the machine Id where fabric agent is running.	string Constraints: Min length = 1 (required)
machineName	Gets or sets the machine name where fabric agent is running.	string Constraints: Min length = 1 (required)
resourceAccessIdentity	Identity model.	IdentityModel (required)

IdentityModel

Name	Description	Value
aadAuthority	Gets or sets the authority of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
applicationId	Gets or sets the client/application Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
audience	Gets or sets the audience of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
objectId	Gets or sets the object Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)
tenantId	Gets or sets the tenant Id of the SPN with which fabric agent communicates to service.	string Constraints: Min length = 1 (required)

VMwareFabricAgentModelCustomProperties

Name	Description	Value
biosId	Gets or sets the BIOS Id of the fabric agent machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for FabricAgentModelCustomProperties.	'VMware' (required)
marsAuthenticationIdentity	Identity model.	IdentityModel (required)

Feedback

Was this page helpful?

Last updated on 2026-01-20

Microsoft.DataReplication replicationFabrics/fabricAgents

Bicep resource definition

Resource format

FabricAgentModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

FabricAgentModelCustomProperties

FabricAgentModelProperties

IdentityModel

VMwareFabricAgentModelCustomProperties

ARM template resource definition

Usage Examples

Resource format

FabricAgentModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

FabricAgentModelCustomProperties

FabricAgentModelProperties

IdentityModel

VMwareFabricAgentModelCustomProperties

Terraform (AzAPI provider) resource definition

Resource format

FabricAgentModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationFabrics/fabricAgents

FabricAgentModelCustomProperties

FabricAgentModelProperties

IdentityModel

VMwareFabricAgentModelCustomProperties

Feedback

Additional resources