Microsoft.DataReplication (preview:2021-02-16)

2025/08/29 • 48 new, 48 deleted methods

Dra_Get (new)
Description :  Gets the details of the fabric agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_Create (new)
Description :  Creates the fabric agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Dra model. ,
Required: False ,
}
{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_Delete (new)
Description :  Deletes the fabric agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_List (new)
Description :  Gets the list of fabric agents in the given fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of Dras. ,
Required: False ,
}
[
{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DraOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the fabric agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_Get (new)
Description :  Gets the details of the alert configuration setting.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings/{emailConfigurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
emailConfigurationName:
{
Description: The email configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_Create (new)
Description :  Creates an alert configuration setting for the given vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings/{emailConfigurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
emailConfigurationName:
{
Description: The email configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: EmailConfiguration model. ,
Required: False ,
}
{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_List (new)
Description :  Gets the list of alert configuration settings for the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of email configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Event_Get (new)
Description :  Gets the details of the event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events/{eventName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
eventName:
{
Description: The event name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Event model properties. ,
Required: True ,
}
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
eventType:
{
Description: Gets or sets the event type. ,
Required: False ,
}
string ,
eventName:
{
Description: Gets or sets the event name. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: Gets or sets the time at which the event occurred at source. ,
Format: date-time ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the event severity. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the event description. ,
Required: False ,
}
string ,
correlationId:
{
Description: Gets or sets the event correlation Id. ,
Required: False ,
}
string ,
healthErrors:
{
Description: Gets or sets the errors associated with this event. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Event model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Event_List (new)
Description :  Gets the list of events in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter string. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of events. ,
Required: False ,
}
[
{
properties:
{
Description: Event model properties. ,
Required: True ,
}
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
eventType:
{
Description: Gets or sets the event type. ,
Required: False ,
}
string ,
eventName:
{
Description: Gets or sets the event name. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: Gets or sets the time at which the event occurred at source. ,
Format: date-time ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the event severity. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the event description. ,
Required: False ,
}
string ,
correlationId:
{
Description: Gets or sets the event correlation Id. ,
Required: False ,
}
string ,
healthErrors:
{
Description: Gets or sets the errors associated with this event. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Event model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Get (new)
Description :  Gets the details of the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Create (new)
Description :  Creates the fabric.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Fabric properties. ,
Required: False ,
}
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Update (new)
Description :  Performs update on the fabric.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Fabric properties. ,
Required: False ,
}
{
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Delete (new)
Description :  Removes the fabric.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_ListBySubscription (new)
Description :  Gets the list of fabrics in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationFabrics
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of fabrics. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_List (new)
Description :  Gets the list of fabrics in the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of fabrics. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FabricOperationsStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Get (new)
Description :  Gets the details of the policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Create (new)
Description :  Creates the policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Policy model. ,
Required: False ,
}
{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Delete (new)
Description :  Removes the policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_List (new)
Description :  Gets the list of policies in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of policies. ,
Required: False ,
}
[
{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Get (new)
Description :  Gets the details of the protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Create (new)
Description :  Creates the protected item.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Protected item model. ,
Required: False ,
}
{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Delete (new)
Description :  Removes the protected item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
forceDelete:
{
Description: A flag indicating whether to do force delete or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_List (new)
Description :  Gets the list of protected items in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of protected items. ,
Required: False ,
}
[
{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_PlannedFailover (new)
Description :  Performs the planned failover on the protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/plannedFailover
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Planned failover model. ,
Required: False ,
}
{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItemOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_Get (new)
Description :  Gets the details of the recovery point of a protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Recovery point model properties. ,
Required: True ,
}
{
recoveryPointTime:
{
Description: Gets or sets the recovery point time. ,
Format: date-time ,
Required: True ,
}
string ,
recoveryPointType:
{
Description: Gets or sets the recovery point type. ,
Enum:
{
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_List (new)
Description :  Gets the list of recovery points of the given protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/recoveryPoints
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of recovery points. ,
Required: False ,
}
[
{
properties:
{
Description: Recovery point model properties. ,
Required: True ,
}
{
recoveryPointTime:
{
Description: Gets or sets the recovery point time. ,
Format: date-time ,
Required: True ,
}
string ,
recoveryPointType:
{
Description: Gets or sets the recovery point type. ,
Enum:
{
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Get (new)
Description :  Gets the details of the replication extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Create (new)
Description :  Creates the replication extension in the given vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Replication extension model. ,
Required: False ,
}
{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Delete (new)
Description :  Deletes the replication extension in the given vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_List (new)
Description :  Gets the list of replication extensions in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of replication extensions. ,
Required: False ,
}
[
{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtensionOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the replication extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailability (new)
Description :  Checks the resource name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Resource details. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Gets or sets a value indicating whether resource name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets or sets the reason for resource name unavailability. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message for resource name unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Gets the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataReplication/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentPreflight (new)
Description :  Performs resource deployment validation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/deployments/{deploymentId}/preflight
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Deployment Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Deployment preflight model. ,
Required: False ,
}
{
resources:
{
Description: Gets or sets the list of resources. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Gets or sets the Api version. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
resources:
{
Description: Gets or sets the list of resources. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Gets or sets the Api version. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Get (new)
Description :  Gets the details of the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Create (new)
Description :  Creates the vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Vault properties. ,
Required: False ,
}
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Update (new)
Description :  Performs update on the vault.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Vault properties. ,
Required: False ,
}
{
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Delete (new)
Description :  Removes the vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_ListBySubscription (new)
Description :  Gets the list of vaults in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationVaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of vaults. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_List (new)
Description :  Gets the list of vaults in the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of vaults. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VaultOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workflow_Get (new)
Description :  Gets the details of the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job (workflow) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workflow model properties. ,
Required: True ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the workflow state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Cancelling: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
CompletedWithInformation: No description available. ,
CompletedWithWarnings: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the affected object Id. ,
Required: False ,
}
string ,
objectName:
{
Description: Gets or sets the affected object name. ,
Required: False ,
}
string ,
objectInternalId:
{
Description: Gets or sets the affected object internal Id. ,
Required: False ,
}
string ,
objectInternalName:
{
Description: Gets or sets the affected object internal name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets or sets the object type. ,
Enum:
{
AvsDiskPool: No description available. ,
Dra: No description available. ,
Fabric: No description available. ,
Policy: No description available. ,
ProtectedItem: No description available. ,
RecoveryPlan: No description available. ,
ReplicationExtension: No description available. ,
Vault: No description available. ,
}
,
Required: False ,
}
enum ,
replicationProviderId:
{
Description: Gets or sets the replication provider. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider. ,
Required: False ,
}
string ,
allowedActions:
{
Description: Gets or sets the list of allowed actions on the workflow. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the workflow activity id. ,
Required: False ,
}
string ,
tasks:
{
Description: Gets or sets the list of tasks. ,
Required: False ,
}
[
{
taskName:
{
Description: Gets or sets the task name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the task state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
customProperties:
{
Description: Task model custom properties. ,
Required: False ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
childrenWorkflows:
{
Description: Gets or sets the list of children workflow models. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errors:
{
Description: Gets or sets the list of errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the error type. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of error. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets the possible causes of error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets the recommended action to resolve error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Workflow model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
object ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workflow_List (new)
Description :  Gets the list of jobs in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter string. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: Workflow model properties. ,
Required: True ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the workflow state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Cancelling: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
CompletedWithInformation: No description available. ,
CompletedWithWarnings: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the affected object Id. ,
Required: False ,
}
string ,
objectName:
{
Description: Gets or sets the affected object name. ,
Required: False ,
}
string ,
objectInternalId:
{
Description: Gets or sets the affected object internal Id. ,
Required: False ,
}
string ,
objectInternalName:
{
Description: Gets or sets the affected object internal name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets or sets the object type. ,
Enum:
{
AvsDiskPool: No description available. ,
Dra: No description available. ,
Fabric: No description available. ,
Policy: No description available. ,
ProtectedItem: No description available. ,
RecoveryPlan: No description available. ,
ReplicationExtension: No description available. ,
Vault: No description available. ,
}
,
Required: False ,
}
enum ,
replicationProviderId:
{
Description: Gets or sets the replication provider. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider. ,
Required: False ,
}
string ,
allowedActions:
{
Description: Gets or sets the list of allowed actions on the workflow. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the workflow activity id. ,
Required: False ,
}
string ,
tasks:
{
Description: Gets or sets the list of tasks. ,
Required: False ,
}
[
{
taskName:
{
Description: Gets or sets the task name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the task state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
customProperties:
{
Description: Task model custom properties. ,
Required: False ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
childrenWorkflows:
{
Description: Gets or sets the list of children workflow models. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errors:
{
Description: Gets or sets the list of errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the error type. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of error. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets the possible causes of error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets the recommended action to resolve error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Workflow model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
object ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkflowOperationStatus_Get (new)
Description :  Tracks the results of an asynchronous operation on the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job (workflow) name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_Get (removed)
Description :  Gets the details of the fabric agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_Create (removed)
Description :  Creates the fabric agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Dra model. ,
Required: False ,
}
{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_Delete (removed)
Description :  Deletes the fabric agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dra_List (removed)
Description :  Gets the list of fabric agents in the given fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of Dras. ,
Required: False ,
}
[
{
properties:
{
Description: Dra model properties. ,
Required: True ,
}
{
correlationId:
{
Description: Gets or sets the Dra correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where Dra is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where Dra is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which Dra communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether Dra is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the Dra. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the Dra version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Dra model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DraOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the fabric agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
fabricAgentName:
{
Description: The fabric agent (Dra) name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_Get (removed)
Description :  Gets the details of the alert configuration setting.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings/{emailConfigurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
emailConfigurationName:
{
Description: The email configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_Create (removed)
Description :  Creates an alert configuration setting for the given vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings/{emailConfigurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
emailConfigurationName:
{
Description: The email configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: EmailConfiguration model. ,
Required: False ,
}
{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailConfiguration_List (removed)
Description :  Gets the list of alert configuration settings for the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/alertSettings
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of email configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Email configuration model properties. ,
Required: True ,
}
{
sendToOwners:
{
Description: Gets or sets a value indicating whether to send email to subscription administrator. ,
Required: True ,
}
boolean ,
customEmailAddresses:
{
Description: Gets or sets the custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: Gets or sets the locale for the email notification. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Event_Get (removed)
Description :  Gets the details of the event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events/{eventName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
eventName:
{
Description: The event name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Event model properties. ,
Required: True ,
}
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
eventType:
{
Description: Gets or sets the event type. ,
Required: False ,
}
string ,
eventName:
{
Description: Gets or sets the event name. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: Gets or sets the time at which the event occurred at source. ,
Format: date-time ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the event severity. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the event description. ,
Required: False ,
}
string ,
correlationId:
{
Description: Gets or sets the event correlation Id. ,
Required: False ,
}
string ,
healthErrors:
{
Description: Gets or sets the errors associated with this event. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Event model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Event_List (removed)
Description :  Gets the list of events in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter string. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of events. ,
Required: False ,
}
[
{
properties:
{
Description: Event model properties. ,
Required: True ,
}
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
eventType:
{
Description: Gets or sets the event type. ,
Required: False ,
}
string ,
eventName:
{
Description: Gets or sets the event name. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: Gets or sets the time at which the event occurred at source. ,
Format: date-time ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the event severity. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the event description. ,
Required: False ,
}
string ,
correlationId:
{
Description: Gets or sets the event correlation Id. ,
Required: False ,
}
string ,
healthErrors:
{
Description: Gets or sets the errors associated with this event. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Event model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Get (removed)
Description :  Gets the details of the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Create (removed)
Description :  Creates the fabric.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Fabric properties. ,
Required: False ,
}
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Update (removed)
Description :  Performs update on the fabric.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Fabric properties. ,
Required: False ,
}
{
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_Delete (removed)
Description :  Removes the fabric.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_ListBySubscription (removed)
Description :  Gets the list of fabrics in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationFabrics
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of fabrics. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fabric_List (removed)
Description :  Gets the list of fabrics in the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of fabrics. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the fabric. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Fabric model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets or sets the service endpoint. ,
Required: False ,
}
string ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
health:
{
Description: Gets or sets the fabric health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Fabric model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FabricOperationsStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Get (removed)
Description :  Gets the details of the policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Create (removed)
Description :  Creates the policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Policy model. ,
Required: False ,
}
{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Delete (removed)
Description :  Removes the policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_List (removed)
Description :  Gets the list of policies in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of policies. ,
Required: False ,
}
[
{
properties:
{
Description: Policy model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Get (removed)
Description :  Gets the details of the protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Create (removed)
Description :  Creates the protected item.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Protected item model. ,
Required: False ,
}
{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_Delete (removed)
Description :  Removes the protected item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
forceDelete:
{
Description: A flag indicating whether to do force delete or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_List (removed)
Description :  Gets the list of protected items in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of protected items. ,
Required: False ,
}
[
{
properties:
{
Description: Protected item model properties. ,
Required: True ,
}
{
policyName:
{
Description: Gets or sets the policy name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: Gets or sets the replication extension name. ,
Required: True ,
}
string ,
correlationId:
{
Description: Gets or sets the protected item correlation Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Dra. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: No description available. ,
EnablingProtection: No description available. ,
EnablingFailed: No description available. ,
DisablingProtection: No description available. ,
MarkedForDeletion: No description available. ,
DisablingFailed: No description available. ,
UnprotectedStatesEnd: No description available. ,
InitialReplicationStatesBegin: No description available. ,
InitialReplicationInProgress: No description available. ,
InitialReplicationCompletedOnPrimary: No description available. ,
InitialReplicationCompletedOnRecovery: No description available. ,
InitialReplicationFailed: No description available. ,
InitialReplicationStatesEnd: No description available. ,
ProtectedStatesBegin: No description available. ,
Protected: No description available. ,
ProtectedStatesEnd: No description available. ,
PlannedFailoverTransitionStatesBegin: No description available. ,
PlannedFailoverInitiated: No description available. ,
PlannedFailoverCompleting: No description available. ,
PlannedFailoverCompleted: No description available. ,
PlannedFailoverFailed: No description available. ,
PlannedFailoverCompletionFailed: No description available. ,
PlannedFailoverTransitionStatesEnd: No description available. ,
UnplannedFailoverTransitionStatesBegin: No description available. ,
UnplannedFailoverInitiated: No description available. ,
UnplannedFailoverCompleting: No description available. ,
UnplannedFailoverCompleted: No description available. ,
UnplannedFailoverFailed: No description available. ,
UnplannedFailoverCompletionFailed: No description available. ,
UnplannedFailoverTransitionStatesEnd: No description available. ,
CommitFailoverStatesBegin: No description available. ,
CommitFailoverInProgressOnPrimary: No description available. ,
CommitFailoverInProgressOnRecovery: No description available. ,
CommitFailoverCompleted: No description available. ,
CommitFailoverFailedOnPrimary: No description available. ,
CommitFailoverFailedOnRecovery: No description available. ,
CommitFailoverStatesEnd: No description available. ,
CancelFailoverStatesBegin: No description available. ,
CancelFailoverInProgressOnPrimary: No description available. ,
CancelFailoverInProgressOnRecovery: No description available. ,
CancelFailoverFailedOnPrimary: No description available. ,
CancelFailoverFailedOnRecovery: No description available. ,
CancelFailoverStatesEnd: No description available. ,
ChangeRecoveryPointStatesBegin: No description available. ,
ChangeRecoveryPointInitiated: No description available. ,
ChangeRecoveryPointCompleted: No description available. ,
ChangeRecoveryPointFailed: No description available. ,
ChangeRecoveryPointStatesEnd: No description available. ,
ReprotectStatesBegin: No description available. ,
ReprotectInitiated: No description available. ,
ReprotectFailed: No description available. ,
ReprotectStatesEnd: No description available. ,
}
,
Required: False ,
}
enum ,
protectionStateDescription:
{
Description: Gets or sets the protection state description. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: Gets or sets the test failover state. ,
Enum:
{
None: No description available. ,
TestFailoverInitiated: No description available. ,
TestFailoverCompleting: No description available. ,
TestFailoverCompleted: No description available. ,
TestFailoverFailed: No description available. ,
TestFailoverCompletionFailed: No description available. ,
TestFailoverCleanupInitiated: No description available. ,
TestFailoverCleanupCompleting: No description available. ,
MarkedForDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
testFailoverStateDescription:
{
Description: Gets or sets the Test failover state description. ,
Required: False ,
}
string ,
resynchronizationState:
{
Description: Gets or sets the resynchronization state. ,
Enum:
{
None: No description available. ,
ResynchronizationInitiated: No description available. ,
ResynchronizationCompleted: No description available. ,
ResynchronizationFailed: No description available. ,
}
,
Required: False ,
}
enum ,
fabricObjectId:
{
Description: Gets or sets the fabric object Id. ,
Required: False ,
}
string ,
fabricObjectName:
{
Description: Gets or sets the fabric object name. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider Id. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets or sets the fabric Id. ,
Required: False ,
}
string ,
targetFabricId:
{
Description: Gets or sets the target fabric Id. ,
Required: False ,
}
string ,
draId:
{
Description: Gets or sets the DRA Id. ,
Required: False ,
}
string ,
targetDraId:
{
Description: Gets or sets the target DRA Id. ,
Required: False ,
}
string ,
resyncRequired:
{
Description: Gets or sets a value indicating whether resynchronization is required or not. ,
Required: False ,
}
boolean ,
lastSuccessfulPlannedFailoverTime:
{
Description: Gets or sets the Last successful planned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulUnplannedFailoverTime:
{
Description: Gets or sets the Last successful unplanned failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: Gets or sets the Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentJob:
{
Required: False ,
}
string ,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Required: False ,
}
string ,
lastFailedPlannedFailoverJob:
{
Required: False ,
}
string ,
lastTestFailoverJob:
{
Required: False ,
}
string ,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: Gets or sets the list of health errors. ,
Required: False ,
}
[
{
affectedResourceType:
{
Description: Gets or sets the type of affected resource type. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
childErrors:
{
Description: Gets or sets a list of child health errors associated with this error. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
healthCategory:
{
Description: Gets or sets the health category. ,
Required: False ,
}
string ,
category:
{
Description: Gets or sets the error category. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
source:
{
Description: Gets or sets the error source. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the error creation time. ,
Format: date-time ,
Required: False ,
}
string ,
isCustomerResolvable:
{
Description: Gets or sets a value indicating whether the error is customer resolvable. ,
Required: False ,
}
boolean ,
summary:
{
Description: Gets or sets the error summary. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets possible causes of the error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Protected item model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItem_PlannedFailover (removed)
Description :  Performs the planned failover on the protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/plannedFailover
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Planned failover model. ,
Required: False ,
}
{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItemOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_Get (removed)
Description :  Gets the details of the recovery point of a protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Recovery point model properties. ,
Required: True ,
}
{
recoveryPointTime:
{
Description: Gets or sets the recovery point time. ,
Format: date-time ,
Required: True ,
}
string ,
recoveryPointType:
{
Description: Gets or sets the recovery point type. ,
Enum:
{
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_List (removed)
Description :  Gets the list of recovery points of the given protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/recoveryPoints
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of recovery points. ,
Required: False ,
}
[
{
properties:
{
Description: Recovery point model properties. ,
Required: True ,
}
{
recoveryPointTime:
{
Description: Gets or sets the recovery point time. ,
Format: date-time ,
Required: True ,
}
string ,
recoveryPointType:
{
Description: Gets or sets the recovery point type. ,
Enum:
{
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Get (removed)
Description :  Gets the details of the replication extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Create (removed)
Description :  Creates the replication extension in the given vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Replication extension model. ,
Required: False ,
}
{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_Delete (removed)
Description :  Deletes the replication extension in the given vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtension_List (removed)
Description :  Gets the list of replication extensions in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of replication extensions. ,
Required: False ,
}
[
{
properties:
{
Description: Replication extension model properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationExtensionOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the replication extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationExtensions/{replicationExtensionName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
replicationExtensionName:
{
Description: The replication extension name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailability (removed)
Description :  Checks the resource name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Resource details. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Gets or sets a value indicating whether resource name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets or sets the reason for resource name unavailability. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message for resource name unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Gets the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataReplication/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentPreflight (removed)
Description :  Performs resource deployment validation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/deployments/{deploymentId}/preflight
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Deployment Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Deployment preflight model. ,
Required: False ,
}
{
resources:
{
Description: Gets or sets the list of resources. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Gets or sets the Api version. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
resources:
{
Description: Gets or sets the list of resources. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Gets or sets the Api version. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Get (removed)
Description :  Gets the details of the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Create (removed)
Description :  Creates the vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Vault properties. ,
Required: False ,
}
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Update (removed)
Description :  Performs update on the vault.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Vault properties. ,
Required: False ,
}
{
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_Delete (removed)
Description :  Removes the vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Tracking URL for long running operation. ,
}
string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_ListBySubscription (removed)
Description :  Gets the list of vaults in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationVaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of vaults. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vault_List (removed)
Description :  Gets the list of vaults in the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token from the previous call. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of vaults. ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets the location of the vault. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Vault properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
serviceResourceId:
{
Description: Gets or sets the service resource Id. ,
Required: False ,
}
string ,
vaultType:
{
Description: Gets or sets the type of vault. ,
Enum:
{
DisasterRecovery: No description available. ,
Migrate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VaultOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workflow_Get (removed)
Description :  Gets the details of the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job (workflow) name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workflow model properties. ,
Required: True ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the workflow state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Cancelling: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
CompletedWithInformation: No description available. ,
CompletedWithWarnings: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the affected object Id. ,
Required: False ,
}
string ,
objectName:
{
Description: Gets or sets the affected object name. ,
Required: False ,
}
string ,
objectInternalId:
{
Description: Gets or sets the affected object internal Id. ,
Required: False ,
}
string ,
objectInternalName:
{
Description: Gets or sets the affected object internal name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets or sets the object type. ,
Enum:
{
AvsDiskPool: No description available. ,
Dra: No description available. ,
Fabric: No description available. ,
Policy: No description available. ,
ProtectedItem: No description available. ,
RecoveryPlan: No description available. ,
ReplicationExtension: No description available. ,
Vault: No description available. ,
}
,
Required: False ,
}
enum ,
replicationProviderId:
{
Description: Gets or sets the replication provider. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider. ,
Required: False ,
}
string ,
allowedActions:
{
Description: Gets or sets the list of allowed actions on the workflow. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the workflow activity id. ,
Required: False ,
}
string ,
tasks:
{
Description: Gets or sets the list of tasks. ,
Required: False ,
}
[
{
taskName:
{
Description: Gets or sets the task name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the task state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
customProperties:
{
Description: Task model custom properties. ,
Required: False ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
childrenWorkflows:
{
Description: Gets or sets the list of children workflow models. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errors:
{
Description: Gets or sets the list of errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the error type. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of error. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets the possible causes of error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets the recommended action to resolve error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Workflow model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
object ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workflow_List (removed)
Description :  Gets the list of jobs in the given vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter string. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: Workflow model properties. ,
Required: True ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the workflow state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Cancelling: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
CompletedWithInformation: No description available. ,
CompletedWithWarnings: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the affected object Id. ,
Required: False ,
}
string ,
objectName:
{
Description: Gets or sets the affected object name. ,
Required: False ,
}
string ,
objectInternalId:
{
Description: Gets or sets the affected object internal Id. ,
Required: False ,
}
string ,
objectInternalName:
{
Description: Gets or sets the affected object internal name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets or sets the object type. ,
Enum:
{
AvsDiskPool: No description available. ,
Dra: No description available. ,
Fabric: No description available. ,
Policy: No description available. ,
ProtectedItem: No description available. ,
RecoveryPlan: No description available. ,
ReplicationExtension: No description available. ,
Vault: No description available. ,
}
,
Required: False ,
}
enum ,
replicationProviderId:
{
Description: Gets or sets the replication provider. ,
Required: False ,
}
string ,
sourceFabricProviderId:
{
Description: Gets or sets the source fabric provider. ,
Required: False ,
}
string ,
targetFabricProviderId:
{
Description: Gets or sets the target fabric provider. ,
Required: False ,
}
string ,
allowedActions:
{
Description: Gets or sets the list of allowed actions on the workflow. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the workflow activity id. ,
Required: False ,
}
string ,
tasks:
{
Description: Gets or sets the list of tasks. ,
Required: False ,
}
[
{
taskName:
{
Description: Gets or sets the task name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the task state. ,
Enum:
{
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Gets or sets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
customProperties:
{
Description: Task model custom properties. ,
Required: False ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
}
,
childrenWorkflows:
{
Description: Gets or sets the list of children workflow models. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errors:
{
Description: Gets or sets the list of errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the error type. ,
Required: False ,
}
string ,
severity:
{
Description: Gets or sets the error severity. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of error. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
causes:
{
Description: Gets or sets the possible causes of error. ,
Required: False ,
}
string ,
recommendation:
{
Description: Gets or sets the recommended action to resolve error. ,
Required: False ,
}
string ,
}
,
]
,
customProperties:
{
Description: Workflow model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Gets or sets the instance type. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
object ,
}
,
}
,
id:
{
Description: Gets or sets the Id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkflowOperationStatus_Get (removed)
Description :  Tracks the results of an asynchronous operation on the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job (workflow) name. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}