Microsoft.DataProtection (stable:2025-07-01)

2025/09/09 • 58 updated methods

BackupInstancesExtensionRouting_List (updated)
Description :  Gets a list of backup instances associated with a tracked resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstancesExtensionRouting_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "identityDetails",
                "Description": {
                  "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                  "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
                }
              }
            ],
            "@added_b709a1184b894203b2f4d9b67bc1eccd": {
              "#name": "tags",
              "Description": "Proxy Resource tags.",
              "Required": false,
              "Type": "object"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /{resourceId}/providers/Microsoft.DataProtection/backupInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceId:
{
Description: ARM path of the resource to be protected using Microsoft.DataProtection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
DataProtectionOperations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "DataProtectionOperations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Returns the list of available operations."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "Operations List response which contains list of available APIs."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of operations supported by the resource provider",
            "old": "List of available operations."
          },
          "$items": {
            "Description": {
              "new": "Details of a REST API operation, returned from the Resource Provider Operations API",
              "old": "Available operation details."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
                  "old": "Name of the Operation."
                }
              },
              {
                "#name": "isDataAction",
                "Description": {
                  "new": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
                  "old": "Indicates whether the operation is a data action"
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "Localized display information for this particular operation.",
                  "old": "Contains the localized display information for this particular operation"
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "Name of the provider for display purposes"
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "ResourceType for which this Operation can be performed."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "Operations Name itself."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "Description of the operation having details of what operation is about."
                    }
                  }
                ]
              },
              {
                "#name": "origin",
                "Description": {
                  "new": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"",
                  "old": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX"
                },
                "Enum": {
                  "new": [
                    [
                      "user",
                      ""
                    ],
                    [
                      "system",
                      ""
                    ],
                    [
                      "user,system",
                      ""
                    ]
                  ],
                  "old": []
                }
              },
              {
                "@added_6249f6b8fcb1451286e63296e936ef3f": {
                  "#name": "actionType",
                  "Description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.",
                  "Enum": [
                    [
                      "Internal",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_a92fa86d09474fc3be340c61505839c9": {
                  "#name": "properties",
                  "Description": "Properties for the given operation.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "serviceSpecification",
                      "Description": "Operation properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "logSpecifications",
                          "Description": "List of log specifications of this operation.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Class to represent shoebox log specification in json client discovery.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "blobDuration",
                                "Description": "blob duration of shoebox log specification",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "displayName",
                                "Description": "Localized display name",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "name",
                                "Description": "Name for shoebox log specification.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "URL to get the next set of operation list results (if there are any).",
            "old": "Link to the next chunk of Response."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from Azure Backup."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The resource management error response."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.DataProtection/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 ,
}
,
]
,
}
,
}
BackupVaults_GetInSubscription (updated)
Description :  Returns resource collection belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_GetInSubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_dc131a163f3d449d998da4628228a9a7": {
              "#name": "identity",
              "Description": "Input Managed Identity Details",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "principalId",
                  "Description": "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,
                  "Type": "string"
                },
                {
                  "#name": "tenantId",
                  "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "type",
                  "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "userAssignedIdentities",
                  "Description": "Gets or sets the user assigned identities.",
                  "Required": false,
                  "Type": "object"
                }
              ]
            },
            "@added_588d9384947a4b9982b3931d53fd8c82": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults
{
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: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
DataProtection_CheckFeatureSupport (updated)
Description :  Validates if a feature is supported
Reference :  Link ¶

⚶ Changes

{
  "#id": "DataProtection_CheckFeatureSupport",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "Feature support request object"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport
{
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 ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
OperationStatus_Get (updated)
Description :  Gets the operation status for a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperationStatus_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section.",
            "old": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. The full set of optional properties (e.g. inner errors / details) can be found in the "Error Response" section. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
id:
{
Description: It should match what is used to GET the operation result ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the "id" field, and will typically be a GUID / system generated value ,
Required: False ,
}
string ,
properties:
{
Description: End time of the operation ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetResourcesInSubscription (updated)
Description :  Returns ResourceGuards collection belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetResourcesInSubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_9dd5bba9c322470ebf20b0e759c79121": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards
{
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: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_GetInResourceGroup (updated)
Description :  Returns resource collection belonging to a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_GetInResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_8450bfcd05b54d5a846d408d28d86eb2": {
              "#name": "identity",
              "Description": "Input Managed Identity Details",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "principalId",
                  "Description": "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,
                  "Type": "string"
                },
                {
                  "#name": "tenantId",
                  "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "type",
                  "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "userAssignedIdentities",
                  "Description": "Gets or sets the user assigned identities.",
                  "Required": false,
                  "Type": "object"
                }
              ]
            },
            "@added_892032e34e614f6dadd68f8bdafde884": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_Get (updated)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_Get",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_3e6a1e7cff4f4522b8946d1af09bcd6b": {
          "#name": "identity",
          "Description": "Input Managed Identity Details",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "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,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "Gets or sets the user assigned identities.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_538e3d752c864392a2c664aef6b84c36": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{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 name of the BackupVaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_CreateOrUpdate (updated)
Description :  Creates or updates a BackupVault resource belonging to a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_722090619b974dbdbe7dc246e9c00a5e": {
            "#name": "identity",
            "Description": "Input Managed Identity Details",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "principalId",
                "Description": "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,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "type",
                "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "userAssignedIdentities",
                "Description": "Gets or sets the user assigned identities.",
                "Required": false,
                "Type": "object"
              }
            ]
          },
          "@added_9a70116454d14ddc96a51e1d0663de20": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_c01e9e19f1814f60b490ff43f9819707": {
          "#name": "identity",
          "Description": "Input Managed Identity Details",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "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,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "Gets or sets the user assigned identities.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_e92aaf4aa8b64251b0d73687faf8fc36": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_250539dfecf2409eac84a5f8704e4033": {
          "#name": "identity",
          "Description": "Input Managed Identity Details",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "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,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "Gets or sets the user assigned identities.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_96d09595473c4e27a821f7718dbde8b4": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{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 name of the BackupVaultResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
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 ,
}
,
$schema:
{
Description: Backup Vault Resource ,
}
{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_Update (updated)
Description :  Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_Update",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_6c9ff7ba8345454981544d18e2b649ae": {
          "#name": "identity",
          "Description": "Input Managed Identity Details",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "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,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "Gets or sets the user assigned identities.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_7608db057b684fb4b3a53dc1fd6a6ba8": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{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 name of the BackupVaultResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
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 resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_Delete (updated)
Description :  Deletes a BackupVault resource from the resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_Delete",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{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 name of the BackupVaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_List (updated)
Description :  Gets a backup instances belonging to a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "identityDetails",
                "Description": {
                  "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                  "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
                }
              }
            ],
            "@added_1f40b8dc3d5b4db39f7f222fde77d403": {
              "#name": "tags",
              "Description": "Proxy Resource tags.",
              "Required": false,
              "Type": "object"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances
{
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 name of the backup vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_Get (updated)
Description :  Gets a backup instance with name in a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_Get",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ],
        "@added_b1dd5d2e11a342499b8a66b53053ad93": {
          "#name": "tags",
          "Description": "Proxy Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_CreateOrUpdate (updated)
Description :  Create or update a backup instance in a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "#name": "identityDetails",
              "Description": {
                "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
              }
            }
          ],
          "@added_d8a517038a9b4446ba4cb171d2658e56": {
            "#name": "tags",
            "Description": "Proxy Resource tags.",
            "Required": false,
            "Type": "object"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ],
        "@added_f41a4d171ebd4f06a8693014a89d21d8": {
          "#name": "tags",
          "Description": "Proxy Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ],
        "@added_c2809dc8440d445084117c5b28374d82": {
          "#name": "tags",
          "Description": "Proxy Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
$headers:
{
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 ,
}
,
$schema:
{
Description: BackupInstance Resource ,
}
{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_Delete (updated)
Description :  Delete a backup instance in a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_Delete",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_ea4b570921764475b38d3834a06fec38": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_AdhocBackup (updated)
Description :  Trigger adhoc backup
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_AdhocBackup",
  "Description": {
    "new": "Trigger adhoc backup",
    "old": "Trigger adhoc backup "
  },
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_5b71f7d94e8a4dc5bf35f25b58021840": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
backupRuleOptions:
{
Description: Name for the Rule of the Policy which needs to be applied for this backup ,
Required: True ,
}
{
ruleName:
{
Required: True ,
}
string ,
triggerOption:
{
Description: Adhoc backup trigger option ,
Required: True ,
}
{
retentionTagOverride:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
RestorableTimeRanges_Find (updated)
Reference :  Link ¶

⚶ Changes

{
  "#id": "RestorableTimeRanges_Find",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
sourceDataStoreType:
{
Description: Gets or sets the type of the source data store. ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for the List Restore Ranges request. ISO 8601 format. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for the List Restore Ranges request. ISO 8601 format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: AzureBackupFindRestorableTimeRangesResponseResource properties ,
Required: False ,
}
{
restorableTimeRanges:
{
Description: Returns the Restore Ranges available on the Backup Instance. ,
Required: False ,
}
[
{
startTime:
{
Description: Start time for the available restore range ,
Required: True ,
}
string ,
endTime:
{
Description: End time for the available restore range ,
Required: True ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
objectType:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_GetBackupInstanceOperationResult (updated)
Description :  Get result of backup instance creation operation
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_GetBackupInstanceOperationResult",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    },
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ],
        "@added_3628d816487e43cdb37c3e212fd6bee5": {
          "#name": "tags",
          "Description": "Proxy Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{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 ,
vaultName:
{
Description: The name of the BackupVaultResource ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupInstanceResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
tags:
{
Description: Proxy Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_TriggerRehydrate (updated)
Description :  rehydrate recovery point for restore for a BackupInstance
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_TriggerRehydrate",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_03d587eb7b1045969c18e2d413f2859b": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
recoveryPointId:
{
Description: Id of the recovery point to be recovered ,
Required: True ,
}
string ,
rehydrationPriority:
{
Description: Priority to be used for rehydration. Values High or Standard ,
Enum:
{
Invalid: No description available. ,
High: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
rehydrationRetentionDuration:
{
Description: Retention duration in ISO 8601 format i.e P10D . ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_TriggerRestore (updated)
Description :  Triggers restore for a BackupInstance
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_TriggerRestore",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "parameters": {
        "$properties": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_a9d21c6a8e3743e18612e5890ddf0e84": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
objectType:
{
Required: True ,
}
string ,
restoreTargetInfo:
{
Description: Gets or sets the restore target information. ,
Required: True ,
}
{
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: True ,
}
string ,
recoveryOption:
{
Description: Recovery Option ,
Enum:
{
FailIfExists: No description available. ,
}
,
Required: True ,
}
enum ,
restoreLocation:
{
Description: Target Restore region ,
Required: False ,
}
string ,
}
,
sourceDataStoreType:
{
Description: Gets or sets the type of the source data store. ,
Enum:
{
ArchiveStore: No description available. ,
SnapshotStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: True ,
}
enum ,
sourceResourceId:
{
Description: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. ,
Required: False ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_ResumeBackups (updated)
Description :  This operation will resume backups for backup instance
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ResumeBackups",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_b1e1a3364f204399b015d2ef10e3ec22": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_ResumeProtection (updated)
Description :  This operation will resume protection for a stopped backup instance
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ResumeProtection",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_e3fb019471f64d15ae9642fb15fa02e9": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_StopProtection (updated)
Description :  This operation will stop protection of a backup instance and data will be held forever
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_StopProtection",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "The content of the action request",
        "old": "Request body for operation"
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_a5c2a26936dd42f8898aa62937ab42d8": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: The content of the action request ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_SuspendBackups (updated)
Description :  This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_SuspendBackups",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "The content of the action request",
        "old": "Request body for operation"
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_29dd4cb571c74bebb9383f8f12b54310": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: The content of the action request ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_SyncBackupInstance (updated)
Description :  Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_SyncBackupInstance",
  "Description": {
    "new": "Sync backup instance again in case of failure\nThis action will retry last failed operation and will bring backup instance to valid state",
    "old": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state"
  },
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_ff946696be5546a5bca19daca15a1a6c": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
syncType:
{
Description: Field indicating sync type e.g. to sync only in case of failure or in all cases ,
Enum:
{
Default: No description available. ,
ForceResync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_ValidateForModifyBackup (updated)
Description :  Validate whether update for backup instance will be successful or not
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ValidateForModifyBackup",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "parameters": {
        "$properties": {
          "backupInstance": [
            {
              "#name": "identityDetails",
              "Description": {
                "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_10808ddb38bb4a08a6379bb50f90c096": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
backupInstance:
{
Description: Backup Instance ,
Required: True ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
BackupInstances_ValidateForRestore (updated)
Description :  Validates if Restore can be triggered for a DataSource
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ValidateForRestore",
  "$parameters": [
    {
      "#name": "backupInstanceName",
      "Description": {
        "new": "The name of the BackupInstanceResource",
        "old": "The name of the backup instance."
      }
    },
    {
      "parameters": {
        "$properties": {
          "restoreRequestObject": [
            {
              "#name": "identityDetails",
              "Description": {
                "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_1f92e1531d5c4b32b6fdaab6c5dcdca5": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the BackupInstanceResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
restoreRequestObject:
{
Description: Gets or sets the restore request object. ,
Required: True ,
}
{
objectType:
{
Required: True ,
}
string ,
restoreTargetInfo:
{
Description: Gets or sets the restore target information. ,
Required: True ,
}
{
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: True ,
}
string ,
recoveryOption:
{
Description: Recovery Option ,
Enum:
{
FailIfExists: No description available. ,
}
,
Required: True ,
}
enum ,
restoreLocation:
{
Description: Target Restore region ,
Required: False ,
}
string ,
}
,
sourceDataStoreType:
{
Description: Gets or sets the type of the source data store. ,
Enum:
{
ArchiveStore: No description available. ,
SnapshotStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: True ,
}
enum ,
sourceResourceId:
{
Description: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. ,
Required: False ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
Jobs_List (updated)
Description :  Returns list of jobs belonging to a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "extendedInfo": [
                  {
                    "#name": "additionalDetails",
                    "Type": {
                      "new": "object",
                      "old": "string"
                    }
                  },
                  {
                    "subTasks": {
                      "$properties": [
                        {
                          "#name": "additionalDetails",
                          "Type": {
                            "new": "object",
                            "old": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs
{
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 name of the backup vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBackupJobResource properties ,
Required: False ,
}
{
activityID:
{
Description: Job Activity Id ,
Required: True ,
}
string ,
backupInstanceFriendlyName:
{
Description: Name of the Backup Instance ,
Required: True ,
}
string ,
backupInstanceId:
{
Description: ARM ID of the Backup Instance ,
Required: False ,
}
string ,
dataSourceId:
{
Description: ARM ID of the DataSource ,
Required: True ,
}
string ,
dataSourceLocation:
{
Description: Location of the DataSource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: User Friendly Name of the DataSource ,
Required: True ,
}
string ,
dataSourceSetName:
{
Description: Data Source Set Name of the DataSource ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of DataSource ,
Required: True ,
}
string ,
duration:
{
Description: Total run time of the job. ISO 8601 format. ,
Required: False ,
}
string ,
endTime:
{
Description: EndTime of the job(in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: A List, detailing the errors related to the job ,
Required: False ,
}
[
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
]
,
extendedInfo:
{
Description: Extended Information about the job ,
Required: False ,
}
{
additionalDetails:
{
Description: Job's Additional Details ,
Required: False ,
}
object ,
backupInstanceState:
{
Description: State of the Backup Instance ,
Required: False ,
}
string ,
dataTransferredInBytes:
{
Description: Number of bytes transferred ,
Format: double ,
Required: False ,
}
number ,
recoveryDestination:
{
Description: Destination where restore is done ,
Required: False ,
}
string ,
sourceRecoverPoint:
{
Description: Details of the Source Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
subTasks:
{
Description: List of Sub Tasks of the job ,
Required: False ,
}
[
{
additionalDetails:
{
Description: Additional details of Sub Tasks ,
Required: False ,
}
object ,
taskId:
{
Description: Task Id of the Sub Task ,
Format: int32 ,
Required: True ,
}
integer ,
taskName:
{
Description: Name of the Sub Task ,
Required: True ,
}
string ,
taskProgress:
{
Description: Progress of the Sub Task ,
Required: False ,
}
string ,
taskStatus:
{
Description: Status of the Sub Task ,
Required: True ,
}
string ,
}
,
]
,
targetRecoverPoint:
{
Description: Details of the Target Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
warningDetails:
{
Description: A List, detailing the warnings related to the job ,
Required: False ,
}
[
{
resourceName:
{
Description: Name of resource for which warning is raised. ,
Required: False ,
}
string ,
warning:
{
Description: Error details for the warning. ,
Required: True ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
isUserTriggered:
{
Description: Indicated that whether the job is adhoc(true) or scheduled(false) ,
Required: True ,
}
boolean ,
operation:
{
Description: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure ,
Required: True ,
}
string ,
operationCategory:
{
Description: It indicates the type of Job i.e. Backup/Restore/Tiering/Management ,
Required: True ,
}
string ,
policyId:
{
Description: ARM ID of the policy ,
Required: False ,
}
string ,
policyName:
{
Description: Name of the policy ,
Required: False ,
}
string ,
progressEnabled:
{
Description: Indicated whether progress is enabled for the job ,
Required: True ,
}
boolean ,
progressUrl:
{
Description: Url which contains job's progress ,
Required: False ,
}
string ,
rehydrationPriority:
{
Description: Priority to be used for rehydration ,
Required: False ,
}
string ,
restoreType:
{
Description: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR ,
Required: False ,
}
string ,
sourceResourceGroup:
{
Description: Resource Group Name of the Datasource ,
Required: True ,
}
string ,
sourceSubscriptionID:
{
Description: SubscriptionId corresponding to the DataSource ,
Required: True ,
}
string ,
startTime:
{
Description: StartTime of the job(in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the corresponding backup vault ,
Required: True ,
}
string ,
supportedActions:
{
Description: List of supported actions ,
Required: True ,
}
[
string ,
]
,
vaultName:
{
Description: Name of the vault ,
Required: True ,
}
string ,
etag:
{
Required: False ,
}
string ,
sourceDataStoreName:
{
Required: False ,
}
string ,
destinationDataStoreName:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
Jobs_Get (updated)
Description :  Gets a job with id in a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "extendedInfo": [
              {
                "#name": "additionalDetails",
                "Type": {
                  "new": "object",
                  "old": "string"
                }
              },
              {
                "subTasks": {
                  "$properties": [
                    {
                      "#name": "additionalDetails",
                      "Type": {
                        "new": "object",
                        "old": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}
{
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 name of the backup vault. ,
Required: True ,
}
string ,
jobId:
{
Description: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AzureBackupJobResource properties ,
Required: False ,
}
{
activityID:
{
Description: Job Activity Id ,
Required: True ,
}
string ,
backupInstanceFriendlyName:
{
Description: Name of the Backup Instance ,
Required: True ,
}
string ,
backupInstanceId:
{
Description: ARM ID of the Backup Instance ,
Required: False ,
}
string ,
dataSourceId:
{
Description: ARM ID of the DataSource ,
Required: True ,
}
string ,
dataSourceLocation:
{
Description: Location of the DataSource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: User Friendly Name of the DataSource ,
Required: True ,
}
string ,
dataSourceSetName:
{
Description: Data Source Set Name of the DataSource ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of DataSource ,
Required: True ,
}
string ,
duration:
{
Description: Total run time of the job. ISO 8601 format. ,
Required: False ,
}
string ,
endTime:
{
Description: EndTime of the job(in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: A List, detailing the errors related to the job ,
Required: False ,
}
[
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
]
,
extendedInfo:
{
Description: Extended Information about the job ,
Required: False ,
}
{
additionalDetails:
{
Description: Job's Additional Details ,
Required: False ,
}
object ,
backupInstanceState:
{
Description: State of the Backup Instance ,
Required: False ,
}
string ,
dataTransferredInBytes:
{
Description: Number of bytes transferred ,
Format: double ,
Required: False ,
}
number ,
recoveryDestination:
{
Description: Destination where restore is done ,
Required: False ,
}
string ,
sourceRecoverPoint:
{
Description: Details of the Source Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
subTasks:
{
Description: List of Sub Tasks of the job ,
Required: False ,
}
[
{
additionalDetails:
{
Description: Additional details of Sub Tasks ,
Required: False ,
}
object ,
taskId:
{
Description: Task Id of the Sub Task ,
Format: int32 ,
Required: True ,
}
integer ,
taskName:
{
Description: Name of the Sub Task ,
Required: True ,
}
string ,
taskProgress:
{
Description: Progress of the Sub Task ,
Required: False ,
}
string ,
taskStatus:
{
Description: Status of the Sub Task ,
Required: True ,
}
string ,
}
,
]
,
targetRecoverPoint:
{
Description: Details of the Target Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
warningDetails:
{
Description: A List, detailing the warnings related to the job ,
Required: False ,
}
[
{
resourceName:
{
Description: Name of resource for which warning is raised. ,
Required: False ,
}
string ,
warning:
{
Description: Error details for the warning. ,
Required: True ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
isUserTriggered:
{
Description: Indicated that whether the job is adhoc(true) or scheduled(false) ,
Required: True ,
}
boolean ,
operation:
{
Description: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure ,
Required: True ,
}
string ,
operationCategory:
{
Description: It indicates the type of Job i.e. Backup/Restore/Tiering/Management ,
Required: True ,
}
string ,
policyId:
{
Description: ARM ID of the policy ,
Required: False ,
}
string ,
policyName:
{
Description: Name of the policy ,
Required: False ,
}
string ,
progressEnabled:
{
Description: Indicated whether progress is enabled for the job ,
Required: True ,
}
boolean ,
progressUrl:
{
Description: Url which contains job's progress ,
Required: False ,
}
string ,
rehydrationPriority:
{
Description: Priority to be used for rehydration ,
Required: False ,
}
string ,
restoreType:
{
Description: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR ,
Required: False ,
}
string ,
sourceResourceGroup:
{
Description: Resource Group Name of the Datasource ,
Required: True ,
}
string ,
sourceSubscriptionID:
{
Description: SubscriptionId corresponding to the DataSource ,
Required: True ,
}
string ,
startTime:
{
Description: StartTime of the job(in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the corresponding backup vault ,
Required: True ,
}
string ,
supportedActions:
{
Description: List of supported actions ,
Required: True ,
}
[
string ,
]
,
vaultName:
{
Description: Name of the vault ,
Required: True ,
}
string ,
etag:
{
Required: False ,
}
string ,
sourceDataStoreName:
{
Required: False ,
}
string ,
destinationDataStoreName:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ExportJobsOperationResult_Get (updated)
Description :  Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ExportJobsOperationResult_Get",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{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 ,
vaultName:
{
Description: The name of the BackupVaultResource ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the export job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
blobUrl:
{
Description: URL of the blob into which the serialized string of list of jobs is exported. ,
Required: False ,
}
string ,
blobSasKey:
{
Description: SAS key to access the blob. ,
Required: False ,
}
string ,
excelFileBlobUrl:
{
Description: URL of the blob into which the ExcelFile is uploaded. ,
Required: False ,
}
string ,
excelFileBlobSasKey:
{
Description: SAS key to access the ExcelFile blob. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupPolicies_CreateOrUpdate (updated)
Description :  Creates or Updates a backup policy belonging to a backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "backupPolicyName",
      "Description": {
        "new": "",
        "old": "Name of the policy"
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}
{
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 name of the backup vault. ,
Required: True ,
}
string ,
backupPolicyName:
{
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: BaseBackupPolicyResource properties ,
Required: False ,
}
{
datasourceTypes:
{
Description: Type of datasource for the backup management ,
Required: True ,
}
[
string ,
]
,
objectType:
{
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BaseBackupPolicyResource properties ,
Required: False ,
}
{
datasourceTypes:
{
Description: Type of datasource for the backup management ,
Required: True ,
}
[
string ,
]
,
objectType:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ExportJobs_Trigger (updated)
Description :  Triggers export of jobs and returns an OperationID to track.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ExportJobs_Trigger",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_0c01e7eff6264b43b9e5a50c40a720aa": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs
{
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 name of the BackupVaultResource ,
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 ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaultOperationResults_Get (updated)
Description :  Get a BackupVaultResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaultOperationResults_Get",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_edc49d238e0b4307a6b8ba9f76d8e382": {
          "#name": "identity",
          "Description": "Input Managed Identity Details",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "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,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "Gets or sets the user assigned identities.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_dda9c52c6d6e49d3945c00d60fb4d0bc": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{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 ,
vaultName:
{
Description: The name of the BackupVaultResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the BackupVaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupVaultResource properties ,
Required: True ,
}
{
monitoringSettings:
{
Description: Monitoring Settings ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveState:
{
Description: Resource move state for backup vault ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
Failed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
MoveSucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
resourceMoveDetails:
{
Description: Resource move details for backup vault ,
Required: False ,
}
{
operationId:
{
Description: CorrelationId of latest ResourceMove operation attempted ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. ,
Required: False ,
}
string ,
sourceResourcePath:
{
Description: ARM resource path of source resource ,
Required: False ,
}
string ,
targetResourcePath:
{
Description: ARM resource path of target resource used in latest ResourceMove operation ,
Required: False ,
}
string ,
}
,
securitySettings:
{
Description: Security Settings ,
Required: False ,
}
{
softDeleteSettings:
{
Description: Soft delete related settings ,
Required: False ,
}
{
state:
{
Description: State of soft delete ,
Enum:
{
Off: Soft Delete is turned off for the BackupVault ,
On: Soft Delete is enabled for the BackupVault but can be turned off ,
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed ,
}
,
Required: False ,
}
enum ,
retentionDurationInDays:
{
Description: Soft delete retention duration ,
Format: double ,
Required: False ,
}
number ,
}
,
immutabilitySettings:
{
Description: Immutability Settings at vault level ,
Required: False ,
}
{
state:
{
Description: Immutability state ,
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
encryptionSettings:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
state:
{
Description: Encryption state of the Backup Vault. ,
Enum:
{
Enabled: CMK encryption is enabled on the Backup Vault ,
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'. ,
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the managed identity used for CMK ,
Required: False ,
}
{
identityType:
{
Description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
identityId:
{
Description: The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
storageSettings:
{
Description: Storage Settings ,
Required: True ,
}
[
{
datastoreType:
{
Description: Gets or sets the type of the datastore. ,
Enum:
{
ArchiveStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Gets or sets the type. ,
Enum:
{
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
isVaultProtectedByResourceGuard:
{
Description: Is vault protected by resource guard ,
Required: False ,
}
boolean ,
featureSettings:
{
Description: Feature Settings ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: CrossSubscriptionRestore Settings ,
Required: False ,
}
{
state:
{
Description: CrossSubscriptionRestore state ,
Enum:
{
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
crossRegionRestoreSettings:
{
Required: False ,
}
{
state:
{
Description: CrossRegionRestore state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
secureScore:
{
Description: Secure Score of Backup Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security Level of Backup Vault ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
replicatedRegions:
{
Description: List of replicated regions for Backup Vault ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Input Managed Identity Details ,
Required: False ,
}
{
principalId:
{
Description: 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: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. ,
Required: False ,
}
string ,
type:
{
Description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: Gets or sets the user assigned identities. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
OperationStatusBackupVaultContext_Get (updated)
Description :  Gets the operation status for an operation over a BackupVault's context.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperationStatusBackupVaultContext_Get",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section.",
            "old": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{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 ,
vaultName:
{
Description: The name of the BackupVaultResource ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. The full set of optional properties (e.g. inner errors / details) can be found in the "Error Response" section. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
id:
{
Description: It should match what is used to GET the operation result ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the "id" field, and will typically be a GUID / system generated value ,
Required: False ,
}
string ,
properties:
{
Description: End time of the operation ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_ValidateForBackup (updated)
Description :  Validate whether adhoc backup will be successful or not
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ValidateForBackup",
  "$parameters": [
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the BackupVaultResource",
        "old": "The name of the backup vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "backupInstance": [
            {
              "#name": "identityDetails",
              "Description": {
                "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
                "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_1820bd87c25a4152b79eaed9a7bc81b9": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup
{
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 name of the BackupVaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
backupInstance:
{
Description: Backup Instance ,
Required: True ,
}
{
friendlyName:
{
Description: Gets or sets the Backup Instance friendly name. ,
Required: False ,
}
string ,
dataSourceInfo:
{
Description: Gets or sets the data source information. ,
Required: True ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
dataSourceSetInfo:
{
Description: Gets or sets the data source set information. ,
Required: False ,
}
{
datasourceType:
{
Description: DatasourceType of the resource. ,
Required: False ,
}
string ,
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: False ,
}
string ,
resourceID:
{
Description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. ,
Required: True ,
}
string ,
resourceLocation:
{
Description: Location of datasource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Unique identifier of the resource in the context of parent. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type of Datasource. ,
Required: False ,
}
string ,
resourceUri:
{
Description: Uri of the resource. ,
Required: False ,
}
string ,
resourceProperties:
{
Description: Properties specific to data source set ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Enum:
{
DefaultResourceProperties: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
policyInfo:
{
Description: Gets or sets the policy information. ,
Required: True ,
}
{
policyId:
{
Required: True ,
}
string ,
policyVersion:
{
Required: False ,
}
string ,
policyParameters:
{
Description: Policy parameters for the backup instance ,
Required: False ,
}
{
dataStoreParametersList:
{
Description: Gets or sets the DataStore Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
dataStoreType:
{
Description: type of datastore; Operational/Vault/Archive ,
Enum:
{
OperationalStore: No description available. ,
VaultStore: No description available. ,
ArchiveStore: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
backupDatasourceParametersList:
{
Description: Gets or sets the Backup Data Source Parameters ,
Required: False ,
}
[
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
protectionStatus:
{
Description: Specifies the protection status of the resource ,
Required: False ,
}
{
errorDetails:
{
Description: Specifies the protection status error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specifies the protection status of the resource ,
Enum:
{
ConfiguringProtection: No description available. ,
ConfiguringProtectionFailed: No description available. ,
ProtectionConfigured: No description available. ,
ProtectionStopped: No description available. ,
SoftDeleted: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
currentProtectionState:
{
Description: Specifies the current protection state of the resource ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
ConfiguringProtection: No description available. ,
ProtectionConfigured: No description available. ,
BackupSchedulesSuspended: No description available. ,
RetentionSchedulesSuspended: No description available. ,
ProtectionStopped: No description available. ,
ProtectionError: No description available. ,
ConfiguringProtectionFailed: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
UpdatingProtection: No description available. ,
}
,
Required: False ,
}
enum ,
protectionErrorDetails:
{
Description: Specifies the protection error of the resource ,
Required: False ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed ,
Required: False ,
}
string ,
datasourceAuthCredentials:
{
Description: Credentials to use to authenticate with data source provider. ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
validationType:
{
Description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. ,
Enum:
{
ShallowValidation: No description available. ,
DeepValidation: No description available. ,
}
,
Required: False ,
}
enum ,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
objectType:
{
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupVaults_CheckNameAvailability (updated)
Description :  API to check for resource name availability
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "The location in which uniqueness will be verified."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
parameters:
{
Description: Check name availability request ,
Required: True ,
}
{
name:
{
Description: Resource name for which availability needs to be checked ,
Required: False ,
}
string ,
type:
{
Description: Describes the Resource type: Microsoft.DataProtection/BackupVaults ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Gets or sets a value indicating whether [name available]. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets or sets the reason. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_TriggerCrossRegionRestore (updated)
Description :  Triggers Cross Region Restore for BackupInstance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_TriggerCrossRegionRestore",
  "$parameters": {
    "parameters": {
      "$properties": {
        "restoreRequestObject": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_9895d5635b7d4b74ba5518378e8f0b89": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore
{
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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for trigger CRR operation ,
Required: True ,
}
{
restoreRequestObject:
{
Description: Gets or sets the restore request object. ,
Required: True ,
}
{
objectType:
{
Required: True ,
}
string ,
restoreTargetInfo:
{
Description: Gets or sets the restore target information. ,
Required: True ,
}
{
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: True ,
}
string ,
recoveryOption:
{
Description: Recovery Option ,
Enum:
{
FailIfExists: No description available. ,
}
,
Required: True ,
}
enum ,
restoreLocation:
{
Description: Target Restore region ,
Required: False ,
}
string ,
}
,
sourceDataStoreType:
{
Description: Gets or sets the type of the source data store. ,
Enum:
{
ArchiveStore: No description available. ,
SnapshotStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: True ,
}
enum ,
sourceResourceId:
{
Description: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. ,
Required: False ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
}
,
crossRegionRestoreDetails:
{
Description: Cross region restore details. ,
Required: True ,
}
{
sourceRegion:
{
Required: True ,
}
string ,
sourceBackupInstanceId:
{
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
FetchCrossRegionRestoreJob_Get (updated)
Description :  Fetches the Cross Region Restore Job
Reference :  Link ¶

⚶ Changes

{
  "#id": "FetchCrossRegionRestoreJob_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "extendedInfo": [
              {
                "#name": "additionalDetails",
                "Type": {
                  "new": "object",
                  "old": "string"
                }
              },
              {
                "subTasks": {
                  "$properties": [
                    {
                      "#name": "additionalDetails",
                      "Type": {
                        "new": "object",
                        "old": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJob
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
sourceRegion:
{
Required: True ,
}
string ,
sourceBackupVaultId:
{
Required: True ,
}
string ,
jobId:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: AzureBackupJobResource properties ,
Required: False ,
}
{
activityID:
{
Description: Job Activity Id ,
Required: True ,
}
string ,
backupInstanceFriendlyName:
{
Description: Name of the Backup Instance ,
Required: True ,
}
string ,
backupInstanceId:
{
Description: ARM ID of the Backup Instance ,
Required: False ,
}
string ,
dataSourceId:
{
Description: ARM ID of the DataSource ,
Required: True ,
}
string ,
dataSourceLocation:
{
Description: Location of the DataSource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: User Friendly Name of the DataSource ,
Required: True ,
}
string ,
dataSourceSetName:
{
Description: Data Source Set Name of the DataSource ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of DataSource ,
Required: True ,
}
string ,
duration:
{
Description: Total run time of the job. ISO 8601 format. ,
Required: False ,
}
string ,
endTime:
{
Description: EndTime of the job(in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: A List, detailing the errors related to the job ,
Required: False ,
}
[
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
]
,
extendedInfo:
{
Description: Extended Information about the job ,
Required: False ,
}
{
additionalDetails:
{
Description: Job's Additional Details ,
Required: False ,
}
object ,
backupInstanceState:
{
Description: State of the Backup Instance ,
Required: False ,
}
string ,
dataTransferredInBytes:
{
Description: Number of bytes transferred ,
Format: double ,
Required: False ,
}
number ,
recoveryDestination:
{
Description: Destination where restore is done ,
Required: False ,
}
string ,
sourceRecoverPoint:
{
Description: Details of the Source Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
subTasks:
{
Description: List of Sub Tasks of the job ,
Required: False ,
}
[
{
additionalDetails:
{
Description: Additional details of Sub Tasks ,
Required: False ,
}
object ,
taskId:
{
Description: Task Id of the Sub Task ,
Format: int32 ,
Required: True ,
}
integer ,
taskName:
{
Description: Name of the Sub Task ,
Required: True ,
}
string ,
taskProgress:
{
Description: Progress of the Sub Task ,
Required: False ,
}
string ,
taskStatus:
{
Description: Status of the Sub Task ,
Required: True ,
}
string ,
}
,
]
,
targetRecoverPoint:
{
Description: Details of the Target Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
warningDetails:
{
Description: A List, detailing the warnings related to the job ,
Required: False ,
}
[
{
resourceName:
{
Description: Name of resource for which warning is raised. ,
Required: False ,
}
string ,
warning:
{
Description: Error details for the warning. ,
Required: True ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
isUserTriggered:
{
Description: Indicated that whether the job is adhoc(true) or scheduled(false) ,
Required: True ,
}
boolean ,
operation:
{
Description: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure ,
Required: True ,
}
string ,
operationCategory:
{
Description: It indicates the type of Job i.e. Backup/Restore/Tiering/Management ,
Required: True ,
}
string ,
policyId:
{
Description: ARM ID of the policy ,
Required: False ,
}
string ,
policyName:
{
Description: Name of the policy ,
Required: False ,
}
string ,
progressEnabled:
{
Description: Indicated whether progress is enabled for the job ,
Required: True ,
}
boolean ,
progressUrl:
{
Description: Url which contains job's progress ,
Required: False ,
}
string ,
rehydrationPriority:
{
Description: Priority to be used for rehydration ,
Required: False ,
}
string ,
restoreType:
{
Description: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR ,
Required: False ,
}
string ,
sourceResourceGroup:
{
Description: Resource Group Name of the Datasource ,
Required: True ,
}
string ,
sourceSubscriptionID:
{
Description: SubscriptionId corresponding to the DataSource ,
Required: True ,
}
string ,
startTime:
{
Description: StartTime of the job(in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the corresponding backup vault ,
Required: True ,
}
string ,
supportedActions:
{
Description: List of supported actions ,
Required: True ,
}
[
string ,
]
,
vaultName:
{
Description: Name of the vault ,
Required: True ,
}
string ,
etag:
{
Required: False ,
}
string ,
sourceDataStoreName:
{
Required: False ,
}
string ,
destinationDataStoreName:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
FetchCrossRegionRestoreJobs_List (updated)
Description :  Fetches list of Cross Region Restore job belonging to the vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "FetchCrossRegionRestoreJobs_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "extendedInfo": [
                  {
                    "#name": "additionalDetails",
                    "Type": {
                      "new": "object",
                      "old": "string"
                    }
                  },
                  {
                    "subTasks": {
                      "$properties": [
                        {
                          "#name": "additionalDetails",
                          "Type": {
                            "new": "object",
                            "old": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
sourceRegion:
{
Required: True ,
}
string ,
sourceBackupVaultId:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBackupJobResource properties ,
Required: False ,
}
{
activityID:
{
Description: Job Activity Id ,
Required: True ,
}
string ,
backupInstanceFriendlyName:
{
Description: Name of the Backup Instance ,
Required: True ,
}
string ,
backupInstanceId:
{
Description: ARM ID of the Backup Instance ,
Required: False ,
}
string ,
dataSourceId:
{
Description: ARM ID of the DataSource ,
Required: True ,
}
string ,
dataSourceLocation:
{
Description: Location of the DataSource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: User Friendly Name of the DataSource ,
Required: True ,
}
string ,
dataSourceSetName:
{
Description: Data Source Set Name of the DataSource ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of DataSource ,
Required: True ,
}
string ,
duration:
{
Description: Total run time of the job. ISO 8601 format. ,
Required: False ,
}
string ,
endTime:
{
Description: EndTime of the job(in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: A List, detailing the errors related to the job ,
Required: False ,
}
[
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
]
,
extendedInfo:
{
Description: Extended Information about the job ,
Required: False ,
}
{
additionalDetails:
{
Description: Job's Additional Details ,
Required: False ,
}
object ,
backupInstanceState:
{
Description: State of the Backup Instance ,
Required: False ,
}
string ,
dataTransferredInBytes:
{
Description: Number of bytes transferred ,
Format: double ,
Required: False ,
}
number ,
recoveryDestination:
{
Description: Destination where restore is done ,
Required: False ,
}
string ,
sourceRecoverPoint:
{
Description: Details of the Source Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
subTasks:
{
Description: List of Sub Tasks of the job ,
Required: False ,
}
[
{
additionalDetails:
{
Description: Additional details of Sub Tasks ,
Required: False ,
}
object ,
taskId:
{
Description: Task Id of the Sub Task ,
Format: int32 ,
Required: True ,
}
integer ,
taskName:
{
Description: Name of the Sub Task ,
Required: True ,
}
string ,
taskProgress:
{
Description: Progress of the Sub Task ,
Required: False ,
}
string ,
taskStatus:
{
Description: Status of the Sub Task ,
Required: True ,
}
string ,
}
,
]
,
targetRecoverPoint:
{
Description: Details of the Target Recovery Point ,
Required: False ,
}
{
recoveryPointID:
{
Required: False ,
}
string ,
recoveryPointTime:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
warningDetails:
{
Description: A List, detailing the warnings related to the job ,
Required: False ,
}
[
{
resourceName:
{
Description: Name of resource for which warning is raised. ,
Required: False ,
}
string ,
warning:
{
Description: Error details for the warning. ,
Required: True ,
}
{
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
details:
{
Description: Additional related Errors ,
Required: False ,
}
[
string ,
]
,
innerError:
{
Description: Inner Error ,
Required: False ,
}
{
additionalInfo:
{
Description: Any Key value pairs that can be provided to the client for additional verbose information. ,
Required: False ,
}
object ,
code:
{
Description: Unique code for this error ,
Required: False ,
}
string ,
embeddedInnerError:
{
Required: False ,
}
string ,
}
,
isRetryable:
{
Description: Whether the operation will be retryable or not ,
Required: False ,
}
boolean ,
isUserError:
{
Description: Whether the operation is due to a user error or service error ,
Required: False ,
}
boolean ,
properties:
{
Description: Any key value pairs that can be injected inside error object ,
Required: False ,
}
object ,
message:
{
Required: False ,
}
string ,
recommendedAction:
{
Description: RecommendedAction � localized. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
isUserTriggered:
{
Description: Indicated that whether the job is adhoc(true) or scheduled(false) ,
Required: True ,
}
boolean ,
operation:
{
Description: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure ,
Required: True ,
}
string ,
operationCategory:
{
Description: It indicates the type of Job i.e. Backup/Restore/Tiering/Management ,
Required: True ,
}
string ,
policyId:
{
Description: ARM ID of the policy ,
Required: False ,
}
string ,
policyName:
{
Description: Name of the policy ,
Required: False ,
}
string ,
progressEnabled:
{
Description: Indicated whether progress is enabled for the job ,
Required: True ,
}
boolean ,
progressUrl:
{
Description: Url which contains job's progress ,
Required: False ,
}
string ,
rehydrationPriority:
{
Description: Priority to be used for rehydration ,
Required: False ,
}
string ,
restoreType:
{
Description: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR ,
Required: False ,
}
string ,
sourceResourceGroup:
{
Description: Resource Group Name of the Datasource ,
Required: True ,
}
string ,
sourceSubscriptionID:
{
Description: SubscriptionId corresponding to the DataSource ,
Required: True ,
}
string ,
startTime:
{
Description: StartTime of the job(in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the corresponding backup vault ,
Required: True ,
}
string ,
supportedActions:
{
Description: List of supported actions ,
Required: True ,
}
[
string ,
]
,
vaultName:
{
Description: Name of the vault ,
Required: True ,
}
string ,
etag:
{
Required: False ,
}
string ,
sourceDataStoreName:
{
Required: False ,
}
string ,
destinationDataStoreName:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
FetchSecondaryRecoveryPoints_List (updated)
Description :  Returns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FetchSecondaryRecoveryPoints_List",
  "$parameters": {
    "parameters": {
      "Description": {
        "new": "Information about BI whose secondary RecoveryPoints are requested\nSource region and\nBI ARM path",
        "old": "Information about BI whose secondary RecoveryPoints are requested\r\nSource region and\r\nBI ARM path"
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchSecondaryRecoveryPoints
{
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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
sourceRegion:
{
Description: Source region in which BackupInstance is located ,
Required: False ,
}
string ,
sourceBackupInstanceId:
{
Description: ARM Path of BackupInstance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBackupRecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
BackupInstances_ValidateCrossRegionRestore (updated)
Description :  Validates whether Cross Region Restore can be triggered for DataSource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupInstances_ValidateCrossRegionRestore",
  "$parameters": {
    "parameters": {
      "$properties": {
        "restoreRequestObject": [
          {
            "#name": "identityDetails",
            "Description": {
              "new": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned.",
              "old": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "@removed_98152a1979014bb983717be389112a40": {
          "#name": "retry-after",
          "Description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore
{
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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
restoreRequestObject:
{
Description: Gets or sets the restore request object. ,
Required: True ,
}
{
objectType:
{
Required: True ,
}
string ,
restoreTargetInfo:
{
Description: Gets or sets the restore target information. ,
Required: True ,
}
{
objectType:
{
Description: Type of Datasource object, used to initialize the right inherited type ,
Required: True ,
}
string ,
recoveryOption:
{
Description: Recovery Option ,
Enum:
{
FailIfExists: No description available. ,
}
,
Required: True ,
}
enum ,
restoreLocation:
{
Description: Target Restore region ,
Required: False ,
}
string ,
}
,
sourceDataStoreType:
{
Description: Gets or sets the type of the source data store. ,
Enum:
{
ArchiveStore: No description available. ,
SnapshotStore: No description available. ,
OperationalStore: No description available. ,
VaultStore: No description available. ,
}
,
Required: True ,
}
enum ,
sourceResourceId:
{
Description: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. ,
Required: False ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
identityDetails:
{
Description: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Specifies if the BI is protected by System Identity. ,
Required: False ,
}
boolean ,
userAssignedIdentityArmUrl:
{
Description: ARM URL for User Assigned Identity. ,
Required: False ,
}
string ,
}
,
}
,
crossRegionRestoreDetails:
{
Description: Cross region restore details. ,
Required: True ,
}
{
sourceRegion:
{
Required: True ,
}
string ,
sourceBackupInstanceId:
{
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: Name or Arm Id of the job created for this operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
OperationStatusResourceGroupContext_Get (updated)
Description :  Gets the operation status for an operation over a ResourceGroup's context.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperationStatusResourceGroupContext_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section.",
            "old": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. The full set of optional properties (e.g. inner errors / details) can be found in the "Error Response" section. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
id:
{
Description: It should match what is used to GET the operation result ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the "id" field, and will typically be a GUID / system generated value ,
Required: False ,
}
string ,
properties:
{
Description: End time of the operation ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetResourcesInResourceGroup (updated)
Description :  Returns ResourceGuards collection belonging to a ResourceGroup.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetResourcesInResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_63e869011e6c49ceac0072655762e2d2": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_Get (updated)
Description :  Returns a ResourceGuard belonging to a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_d68e3403c638466abcf2c3f3a42f66f8": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}
{
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 ,
resourceGuardsName:
{
Description: The name of ResourceGuard ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_Put (updated)
Description :  Creates or updates a ResourceGuard resource belonging to a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_Put",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@added_de7e4d56b16949d997e1bb4236fb9225": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_40f7e41e548a4dc1800f42294b51e0db": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_f0275854009e44c2a8f41e10a3d50e47": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}
{
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 ,
resourceGuardsName:
{
Description: The name of ResourceGuard ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_Patch (updated)
Description :  Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_Patch",
  "$responses": {
    "200": {
      "$properties": {
        "@added_83bd87a1745f46b9afa9ba95d2051dba": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}
{
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 ,
resourceGuardsName:
{
Description: The name of ResourceGuard ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
tags:
{
Description: Resource Guard tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the BackupVault resource ,
Enum:
{
Failed: No description available. ,
Provisioning: No description available. ,
Succeeded: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
allowAutoApprovals:
{
Description: This flag indicates whether auto approval is allowed or not. ,
Required: False ,
}
boolean ,
resourceGuardOperations:
{
Description: {readonly} List of operation details those are protected by the ResourceGuard resource ,
Required: False ,
}
[
{
vaultCriticalOperation:
{
Description: Name of the critical operation. ,
Required: False ,
}
string ,
requestResourceType:
{
Description: Type of resource request. ,
Required: False ,
}
string ,
}
,
]
,
vaultCriticalOperationExclusionList:
{
Description: List of critical operations which are not protected by this resourceGuard ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description about the pre-req steps to perform all the critical operations. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDeleteProtectedItemRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDeleteProtectedItemRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDisableSoftDeleteRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDisableSoftDeleteRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetBackupSecurityPINRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetBackupSecurityPINRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultBackupSecurityPINRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetUpdateProtectedItemRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetUpdateProtectedItemRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetUpdateProtectionPolicyRequestsObjects (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DppBaseResource items on this page",
            "old": "List of Dpp resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DppBaseResource items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject (updated)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject",
  "$parameters": [
    {
      "#name": "resourceGuardsName",
      "Description": {
        "new": "The name of the ResourceGuardResource",
        "old": ""
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}
{
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 ,
resourceGuardsName:
{
Description: The name of the ResourceGuardResource ,
Required: True ,
}
string ,
requestName:
{
Description: The name of the DppBaseResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Base resource under Microsoft.DataProtection provider namespace ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
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 ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}