Microsoft.DataReplication (stable:2024-09-01)

2025/02/21 • 54 new methods

Operations_List (new)
Description :  List the operations for the provider
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Post (new)
Description :  Checks the resource name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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 ,
}
,
]
,
}
,
}
Fabric_ListBySubscription (new)
Description :  Gets the list of fabrics in the given subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The FabricModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Vault_ListBySubscription (new)
Description :  Gets the list of vaults in the given subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VaultModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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_Post (new)
Description :  Performs resource deployment preflight validation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/deployments/{deploymentId}/preflight
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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 ,
properties:
{
Description: Gets or sets the properties of the resource. ,
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 ,
properties:
{
Description: Gets or sets the properties of the resource. ,
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 ,
}
,
]
,
}
,
}
OperationResults_Get (new)
Description :  Gets the operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/operationResults/{operationId}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
operationId:
{
Description: The ID of an ongoing async 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 ,
}
,
]
,
}
,
}
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The FabricModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Fabric_Get (new)
Description :  Gets the details of the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
Fabric_Create (new)
Description :  Creates the fabric.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Fabric properties. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Fabric model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
Fabric_Update (new)
Description :  Performs update on the fabric.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Fabric properties. ,
Required: True ,
}
{
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: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
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:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for FabricModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
FabricAgent_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The FabricAgentModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
correlationId:
{
Description: Gets or sets the fabric agent correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where fabric agent is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where fabric agent is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent 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 fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether the fabric agent is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the fabric agent. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the fabric agent version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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 agent model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for FabricAgentModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
FabricAgent_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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
correlationId:
{
Description: Gets or sets the fabric agent correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where fabric agent is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where fabric agent is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent 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 fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether the fabric agent is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the fabric agent. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the fabric agent version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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 agent model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for FabricAgentModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
FabricAgent_Create (new)
Description :  Creates the fabric agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 name. ,
Required: True ,
}
string ,
body:
{
Description: Fabric agent model. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
correlationId:
{
Description: Gets or sets the fabric agent correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where fabric agent is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where fabric agent is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent 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 fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether the fabric agent is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the fabric agent. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the fabric agent version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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 agent model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for FabricAgentModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
correlationId:
{
Description: Gets or sets the fabric agent correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where fabric agent is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where fabric agent is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent 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 fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether the fabric agent is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the fabric agent. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the fabric agent version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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 agent model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for FabricAgentModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Fabric agent model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
correlationId:
{
Description: Gets or sets the fabric agent correlation Id. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets or sets the machine Id where fabric agent is running. ,
Required: True ,
}
string ,
machineName:
{
Description: Gets or sets the machine name where fabric agent is running. ,
Required: True ,
}
string ,
authenticationIdentity:
{
Description: Identity model. ,
Required: True ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent 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 fabric agent communicates to service. ,
Required: True ,
}
string ,
applicationId:
{
Description: Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
audience:
{
Description: Gets or sets the audience of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: Gets or sets the authority of the SPN with which fabric agent communicates to service. ,
Required: True ,
}
string ,
}
,
isResponsive:
{
Description: Gets or sets a value indicating whether the fabric agent is responsive. ,
Required: False ,
}
boolean ,
lastHeartbeat:
{
Description: Gets or sets the time when last heartbeat was sent by the fabric agent. ,
Format: date-time ,
Required: False ,
}
string ,
versionNumber:
{
Description: Gets or sets the fabric agent version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state of the fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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 agent model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for FabricAgentModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
FabricAgent_Delete (new)
Description :  Deletes fabric agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/fabricAgents/{fabricAgentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The VaultModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Vault_Get (new)
Description :  Gets the details of the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Vault properties. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Vault model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Vault properties. ,
Required: True ,
}
{
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: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Vault identity. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the identityType which can be either SystemAssigned or None. ,
Enum:
{
None: No identity. ,
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Gets or sets the object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets a Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
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:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the vault. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
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: Disaster recovery vault. ,
Migrate: Migrate vault. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The EmailConfigurationModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 ,
provisioningState:
{
Description: Gets or sets the provisioning state of the email configuration. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 ,
provisioningState:
{
Description: Gets or sets the provisioning state of the email configuration. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: EmailConfiguration model. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 ,
provisioningState:
{
Description: Gets or sets the provisioning state of the email configuration. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 ,
provisioningState:
{
Description: Gets or sets the provisioning state of the email configuration. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 ,
provisioningState:
{
Description: Gets or sets the provisioning state of the email configuration. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
odataOptions:
{
Description: OData options. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
pageSize:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EventModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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: Discriminator property for EventModelCustomProperties. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the event. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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: Discriminator property for EventModelCustomProperties. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the event. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Job_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
odataOptions:
{
Description: OData options. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
pageSize:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The JobModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the job state. ,
Enum:
{
Pending: Job has not been started. ,
Started: Job is in progress. ,
Cancelling: Job cancellation is in progress. ,
Succeeded: Job has completed successfully. ,
Failed: Job failed. ,
Cancelled: Job has been cancelled. ,
CompletedWithInformation: Job has completed with information. ,
CompletedWithWarnings: Job has completed with warnings. ,
CompletedWithErrors: Job has completed with errors. ,
}
,
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: AVS disk pool. ,
FabricAgent: Fabric agent level workflow. ,
Fabric: Fabric level job. ,
Policy: Policy level job. ,
ProtectedItem: Protected item level job. ,
RecoveryPlan: Recovery plan level job. ,
ReplicationExtension: Replication extension level job. ,
Vault: Vault level job. ,
}
,
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 job. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the job 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: Task has not been started. ,
Started: Task is in progress. ,
Succeeded: Task has completed successfully. ,
Failed: Task failed. ,
Cancelled: Task has been cancelled. ,
Skipped: Task has been skipped. ,
}
,
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 ,
}
,
childrenJobs:
{
Description: Gets or sets the list of children job 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: Job model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for JobModelCustomProperties. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
{
description:
{
Required: False ,
}
string ,
type:
{
Enum:
{
object: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the job. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Job_Get (new)
Description :  Gets the details of the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Gets or sets the friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the job state. ,
Enum:
{
Pending: Job has not been started. ,
Started: Job is in progress. ,
Cancelling: Job cancellation is in progress. ,
Succeeded: Job has completed successfully. ,
Failed: Job failed. ,
Cancelled: Job has been cancelled. ,
CompletedWithInformation: Job has completed with information. ,
CompletedWithWarnings: Job has completed with warnings. ,
CompletedWithErrors: Job has completed with errors. ,
}
,
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: AVS disk pool. ,
FabricAgent: Fabric agent level workflow. ,
Fabric: Fabric level job. ,
Policy: Policy level job. ,
ProtectedItem: Protected item level job. ,
RecoveryPlan: Recovery plan level job. ,
ReplicationExtension: Replication extension level job. ,
Vault: Vault level job. ,
}
,
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 job. ,
Required: False ,
}
[
string ,
]
,
activityId:
{
Description: Gets or sets the job 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: Task has not been started. ,
Started: Task is in progress. ,
Succeeded: Task has completed successfully. ,
Failed: Task failed. ,
Cancelled: Task has been cancelled. ,
Skipped: Task has been skipped. ,
}
,
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 ,
}
,
childrenJobs:
{
Description: Gets or sets the list of children job 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: Job model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for JobModelCustomProperties. ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: Gets or sets any custom properties of the affected object. ,
Required: False ,
}
{
description:
{
Required: False ,
}
string ,
type:
{
Enum:
{
object: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the job. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionProxies_List (new)
Description :  Gets the all private endpoint connections proxies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnectionProxies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnectionProxy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionProxies_Get (new)
Description :  Gets the private endpoint connection proxy details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionProxyName:
{
Description: The private endpoint connection proxy name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionProxies_Create (new)
Description :  Create a new private endpoint connection proxy which includes both auto and manual approval types. Creating the proxy resource will also create a private endpoint connection resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionProxyName:
{
Description: The private endpoint connection proxy name. ,
Required: True ,
}
string ,
body:
{
Description: Private endpoint connection creation input. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionProxies_Delete (new)
Description :  Returns the operation to track the deletion of private endpoint connection proxy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionProxyName:
{
Description: The private endpoint connection proxy name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionProxies_Validate (new)
Description :  Returns remote private endpoint connection information after validation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyName}/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionProxyName:
{
Description: The private endpoint connection proxy name. ,
Required: True ,
}
string ,
body:
{
Description: The private endpoint connection proxy input. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the private endpoint connection proxy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
remotePrivateEndpoint:
{
Description: Represent remote private endpoint information for the private endpoint connection proxy. ,
Required: False ,
}
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: True ,
}
string ,
privateLinkServiceConnections:
{
Description: Gets or sets the list of Private Link Service Connections and gets populated for Auto approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: Gets or sets the list of Manual Private Link Service Connections and gets populated for Manual approval flow. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets private link service connection name. ,
Required: False ,
}
string ,
groupIds:
{
Description: Gets or sets group ids. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: Gets or sets the request message for the private link service connection. ,
Required: False ,
}
string ,
}
,
]
,
privateLinkServiceProxies:
{
Description: Gets or sets the list of private link service proxies. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets private link service proxy id. ,
Required: False ,
}
string ,
remotePrivateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
remotePrivateEndpointConnection:
{
Description: Represent remote private endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the remote private endpoint connection id. ,
Required: False ,
}
string ,
}
,
groupConnectivityInformation:
{
Description: Gets or sets group connectivity information. ,
Required: False ,
}
[
{
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
customerVisibleFqdns:
{
Description: Gets or sets customer visible FQDNs. ,
Required: False ,
}
[
string ,
]
,
internalFqdn:
{
Description: Gets or sets Internal Fqdn. ,
Required: False ,
}
string ,
redirectMapId:
{
Description: Gets or sets the redirect map id. ,
Required: False ,
}
string ,
privateLinkServiceArmRegion:
{
Description: Gets or sets the private link service arm region. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
connectionDetails:
{
Description: Gets or sets the list of Connection Details. This is the connection details for private endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Gets or sets private IP address. ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: Gets or sets link identifier. ,
Required: False ,
}
string ,
groupId:
{
Description: Gets or sets group id. ,
Required: False ,
}
string ,
memberName:
{
Description: Gets or sets member name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
etag:
{
Description: Gets or sets ETag. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Gets the all private endpoint connections configured on the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represent private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the private endpoint connection details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represent private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Update (new)
Description :  Updated the private endpoint connection status (Approval/Rejected). This gets invoked by resource admin.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
body:
{
Description: Private endpoint connection update input. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represent private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represent private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represent private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Represents Private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Approved: Approved Status. ,
Disconnected: Disconnected Status. ,
Pending: Pending Status. ,
Rejected: Rejected Status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateLinkResources_List (new)
Description :  Gets the list of private link resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupId:
{
Description: Gets or sets the group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Gets or sets the required member. This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Gets or sets the private DNS zone names. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Gets or sets the provisioning state of the private link resource. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets the details of site recovery private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateLinkResources/{privateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateLinkResourceName:
{
Description: The private link name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupId:
{
Description: Gets or sets the group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Gets or sets the required member. This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Gets or sets the private DNS zone names. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Gets or sets the provisioning state of the private link resource. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
odataOptions:
{
Description: OData options. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
pageSize:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProtectedItemModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
ProtectedItem_Create (new)
Description :  Creates the protected item.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Protected item model. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Protected item model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
ProtectedItem_Update (new)
Description :  Performs update on the protected item.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Protected item model. ,
Required: True ,
}
{
properties:
{
Description: Protected item model properties. ,
Required: False ,
}
{
customProperties:
{
Description: Protected item model custom properties update. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator property for ProtectedItemModelCustomPropertiesUpdate. ,
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:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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 fabric agent. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
protectionState:
{
Description: Gets or sets the protection state. ,
Enum:
{
UnprotectedStatesBegin: Begin marker for unprotected states. ,
EnablingProtection: Enable protection is in progress. ,
EnablingFailed: Enable protection failed. ,
DisablingProtection: Disabling protection is in progress. ,
MarkedForDeletion: Disabling protection succeeded. This is a transient state before the protected item is deleted. ,
DisablingFailed: Disable protection failed. ,
UnprotectedStatesEnd: End marker for unprotected states. ,
InitialReplicationStatesBegin: Begin marker for initial replication states. ,
InitialReplicationInProgress: Initial replication is in progress. ,
InitialReplicationCompletedOnPrimary: Initial replication has completed on the primary side. ,
InitialReplicationCompletedOnRecovery: Initial replication has completed on the recovery side. ,
InitialReplicationFailed: Initial replication failed and would need to be started again. ,
InitialReplicationStatesEnd: End marker for initial replication states. ,
ProtectedStatesBegin: Begin marker for protected steady-state states. ,
Protected: Protected item is protected and replication is on-going. Any issues with replication will be surfaced separately via the health property and will not affect the state. ,
ProtectedStatesEnd: End marker for protected steady-state states. ,
PlannedFailoverTransitionStatesBegin: Begin marker for planned failover transition states. ,
PlannedFailoverInitiated: Planned failover has been initiated. ,
PlannedFailoverCompleting: Planned failover preparing protected entities is in progress. ,
PlannedFailoverCompleted: Planned failover has been completed successfully. ,
PlannedFailoverFailed: Planned failover initiation failed. ,
PlannedFailoverCompletionFailed: Planned failover preparing protected entities failed. ,
PlannedFailoverTransitionStatesEnd: End marker for planned failover transition states. ,
UnplannedFailoverTransitionStatesBegin: Begin marker for unplanned failover transition states. ,
UnplannedFailoverInitiated: Unplanned failover has been initiated. ,
UnplannedFailoverCompleting: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverCompleted: Unplanned failover preparing protected entities is in progress. ,
UnplannedFailoverFailed: Unplanned failover initiation failed. ,
UnplannedFailoverCompletionFailed: Unplanned failover preparing protected entities failed. ,
UnplannedFailoverTransitionStatesEnd: End marker for unplanned failover transition states. ,
CommitFailoverStatesBegin: Begin marker for commit failover states. ,
CommitFailoverInProgressOnPrimary: Commit failover is in progress on the primary side. ,
CommitFailoverInProgressOnRecovery: Commit failover is in progress on the recovery side. ,
CommitFailoverCompleted: Commit failover has been completed successfully. ,
CommitFailoverFailedOnPrimary: Commit failover failed on the primary side. ,
CommitFailoverFailedOnRecovery: Commit failover failed on the recovery side. ,
CommitFailoverStatesEnd: End marker for commit failover states. ,
CancelFailoverStatesBegin: Begin marker for cancel failover states. ,
CancelFailoverInProgressOnPrimary: Cancel failover is in progress on the primary side. ,
CancelFailoverInProgressOnRecovery: Cancel failover is in progress on the recovery side. ,
CancelFailoverFailedOnPrimary: Cancel failover failed on the primary side. ,
CancelFailoverFailedOnRecovery: Cancel failover failed on the recovery side. ,
CancelFailoverStatesEnd: End marker for cancel failover states. ,
ChangeRecoveryPointStatesBegin: Begin marker for change recovery point states. ,
ChangeRecoveryPointInitiated: Change recovery point has been initiated.. ,
ChangeRecoveryPointCompleted: Change recovery point has been completed successfully. ,
ChangeRecoveryPointFailed: Change recovery point has failed. ,
ChangeRecoveryPointStatesEnd: End marker for change recovery point states. ,
ReprotectStatesBegin: Begin marker for reprotect states. ,
ReprotectInitiated: Reprotect has been initiated. ,
ReprotectFailed: Reprotect has failed. ,
ReprotectStatesEnd: End marker for reprotect states. ,
}
,
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: Test failover is not active. ,
TestFailoverInitiated: Test failover has been initiated. ,
TestFailoverCompleting: Preparing test protected entities is in progress. ,
TestFailoverCompleted: Test failover has been completed successfully. ,
TestFailoverFailed: Test failover initiation failed.. ,
TestFailoverCompletionFailed: Preparing test protected entities failed. ,
TestFailoverCleanupInitiated: Test failover cleanup has been initiated. ,
TestFailoverCleanupCompleting: Cleaning up test protected entities is in progress. ,
MarkedForDeletion: Test failover cleanup has completed/failed. This is a transient state before the state is moved back to None. ,
}
,
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: Resynchronization is not active. ,
ResynchronizationInitiated: Resynchronization has been initiated. ,
ResynchronizationCompleted: Resynchronization has been completed successfully. ,
ResynchronizationFailed: Resynchronization has failed and would need to be started again. ,
}
,
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 ,
fabricAgentId:
{
Description: Gets or sets the fabric agent Id. ,
Required: False ,
}
string ,
targetFabricAgentId:
{
Description: Gets or sets the target fabric agent 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:
{
Description: Gets or sets the current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
allowedJobs:
{
Description: Gets or sets the allowed scenarios on the protected item. ,
Required: False ,
}
[
string ,
]
,
lastFailedEnableProtectionJob:
{
Description: Gets or sets the last failed enabled protection job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastFailedPlannedFailoverJob:
{
Description: Gets or sets the last failed planned failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastTestFailoverJob:
{
Description: Gets or sets the last test failover job. ,
Required: False ,
}
{
scenarioName:
{
Description: Gets or sets protection scenario name. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets job Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets job name. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the job friendly display name. ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets job state. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
replicationHealth:
{
Description: Gets or sets protected item replication health. ,
Enum:
{
Normal: Healthy Status. ,
Warning: Warning Status. ,
Critical: Critical Status. ,
}
,
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: Discriminator property for ProtectedItemModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
forceDelete:
{
Description: A flag indicating whether to do force delete or not. ,
Required: False ,
}
boolean ,
vaultName:
{
Description: The vault name. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Planned failover model. ,
Required: True ,
}
{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PlannedFailoverModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Planned failover model properties. ,
Required: True ,
}
{
customProperties:
{
Description: Planned failover model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PlannedFailoverModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
RecoveryPoint_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The RecoveryPointModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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: Application consistent recovery point. ,
CrashConsistent: Crash consistent recovery point. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for RecoveryPointModelCustomProperties. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the recovery point item. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
RecoveryPoint_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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
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: Application consistent recovery point. ,
CrashConsistent: Crash consistent recovery point. ,
}
,
Required: True ,
}
enum ,
customProperties:
{
Description: Recovery point model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for RecoveryPointModelCustomProperties. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the recovery point item. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ReplicationExtensionModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for ReplicationExtensionModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for ReplicationExtensionModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Replication extension model. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for ReplicationExtensionModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for ReplicationExtensionModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Replication extension model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the replication extension. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Replication extension model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for ReplicationExtensionModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PolicyModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PolicyModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PolicyModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
Policy_Create (new)
Description :  Creates the policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: Policy model. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PolicyModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PolicyModelCustomProperties. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Policy model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the policy. ,
Enum:
{
Canceled: Resource creation has been canceled ,
Creating: Resource is being created. ,
Deleting: Resource is being deleted. ,
Deleted: Resource has been deleted. ,
Failed: Resource creation failed. ,
Succeeded: Resource creation/update succeeded. ,
Updating: Resource is being updated. ,
}
,
Required: False ,
}
enum ,
customProperties:
{
Description: Policy model custom properties. ,
Required: True ,
}
{
instanceType:
{
Description: Discriminator property for PolicyModelCustomProperties. ,
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 ,
}
,
]
,
}
,
}
Policy_Delete (new)
Description :  Removes the policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/replicationPolicies/{policyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}