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

• Latest
• 2024-10-01
• 2024-04-01
• 2024-02-01
• 2024-01-01
• 2023-08-01
• 2023-06-01
• 2023-04-01
• 2023-02-01
• 2023-01-01
• 2022-10-01
• 2022-09-10
• 2022-08-01
• 2022-05-01
• 2022-04-01
• 2022-03-01
• 2022-02-01
• 2022-01-01
• 2021-12-01
• 2021-11-01
• 2021-10-01
• 2021-08-01
• 2021-07-01
• 2021-06-01
• 2021-04-01
• 2021-03-01
• 2021-02-10
• 2018-07-10
• 2018-01-10
• 2016-08-10

Bicep resource definition

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2023-02-01' = {
  parent: resourceSymbolicName
  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

AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties

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)

Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders

Name	Description	Value
name	The resource name	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: vaults/replicationFabrics
properties	The properties of an add provider request.	AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties (required)

ARM template resource definition

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

{
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders",
  "apiVersion": "2023-02-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

AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties

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)

Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders

Name	Description	Value
apiVersion	The api version	'2023-02-01'
name	The resource name	string (required)
properties	The properties of an add provider request.	AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties (required)
type	The resource type	'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders'

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-02-01"
  name = "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

AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties

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)

Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders

Name	Description	Value
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: vaults/replicationFabrics
properties	The properties of an add provider request.	AddRecoveryServicesProviderInputPropertiesOrRecoveryServicesProviderProperties (required)
type	The resource type	"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2023-02-01"