Microsoft.RecoveryServices vaults/replicationFabrics/replicationRecoveryServicesProviders 2023-08-01

  • Article

Bicep resource definition

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

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

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2023-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authenticationIdentityInput: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      tenantId: 'string'
    }
    biosId: 'string'
    dataPlaneAuthenticationIdentityInput: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      tenantId: 'string'
    }
    machineId: 'string'
    machineName: 'string'
    resourceAccessIdentityInput: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      tenantId: 'string'
    }
  }
}

Property values

vaults/replicationFabrics/replicationRecoveryService...

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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 properties of an add provider request. AddRecoveryServicesProviderInputPropertiesOrRecovery... (required)

AddRecoveryServicesProviderInputPropertiesOrRecovery...

Name Description Value
authenticationIdentityInput The identity provider input for DRA authentication. IdentityProviderInput (required)
biosId The Bios Id of the machine. string
dataPlaneAuthenticationIdentityInput The identity provider input for data plane authentication. IdentityProviderInput
machineId The Id of the machine where the provider is getting added. string
machineName The name of the machine where the provider is getting added. string (required)
resourceAccessIdentityInput The identity provider input for resource access. IdentityProviderInput (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)

ARM template resource definition

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

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

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders",
  "apiVersion": "2023-08-01",
  "name": "string",
  "properties": {
    "authenticationIdentityInput": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "tenantId": "string"
    },
    "biosId": "string",
    "dataPlaneAuthenticationIdentityInput": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "tenantId": "string"
    },
    "machineId": "string",
    "machineName": "string",
    "resourceAccessIdentityInput": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "tenantId": "string"
    }
  }
}

Property values

vaults/replicationFabrics/replicationRecoveryService...

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders'
apiVersion The resource api version '2023-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The properties of an add provider request. AddRecoveryServicesProviderInputPropertiesOrRecovery... (required)

AddRecoveryServicesProviderInputPropertiesOrRecovery...

Name Description Value
authenticationIdentityInput The identity provider input for DRA authentication. IdentityProviderInput (required)
biosId The Bios Id of the machine. string
dataPlaneAuthenticationIdentityInput The identity provider input for data plane authentication. IdentityProviderInput
machineId The Id of the machine where the provider is getting added. string
machineName The name of the machine where the provider is getting added. string (required)
resourceAccessIdentityInput The identity provider input for resource access. IdentityProviderInput (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)

Terraform (AzAPI provider) resource definition

The vaults/replicationFabrics/replicationRecoveryServicesProviders 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.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2023-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authenticationIdentityInput = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        tenantId = "string"
      }
      biosId = "string"
      dataPlaneAuthenticationIdentityInput = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        tenantId = "string"
      }
      machineId = "string"
      machineName = "string"
      resourceAccessIdentityInput = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        tenantId = "string"
      }
    }
  })
}

Property values

vaults/replicationFabrics/replicationRecoveryService...

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2023-08-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: replicationFabrics
properties The properties of an add provider request. AddRecoveryServicesProviderInputPropertiesOrRecovery... (required)

AddRecoveryServicesProviderInputPropertiesOrRecovery...

Name Description Value
authenticationIdentityInput The identity provider input for DRA authentication. IdentityProviderInput (required)
biosId The Bios Id of the machine. string
dataPlaneAuthenticationIdentityInput The identity provider input for data plane authentication. IdentityProviderInput
machineId The Id of the machine where the provider is getting added. string
machineName The name of the machine where the provider is getting added. string (required)
resourceAccessIdentityInput The identity provider input for resource access. IdentityProviderInput (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)