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

2025/03/26 • 73 new methods

BackupVaults_GetInSubscription (new)
Description :  Returns resource collection belonging to a subscription.
Reference :  Link ¶

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
OperationResult_Get (new)
Description :  Gets the operation result for a resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/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 ,
operationId:
{
Required: True ,
}
string ,
location:
{
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Gets the operation status for a resource.
Reference :  Link ¶

⚼ 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:
{
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Gets the operation status for an operation over a BackupVault's context.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the backup vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
OperationStatusResourceGroupContext_Get (new)
Description :  Gets the operation status for an operation over a ResourceGroup's context.
Reference :  Link ¶

⚼ 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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns resource collection belonging to a resource group.
Reference :  Link ¶

⚼ Request

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

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚼ 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 backup vault. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Creates or updates a BackupVault resource belonging to a resource group.
Reference :  Link ¶

⚼ 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 backup vault. ,
Required: True ,
}
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 ,
]
,
}
,
}
,
x-ms-authorization-auxiliary:
{
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 ,
]
,
}
,
}

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Deletes a BackupVault resource from the resource group.
Reference :  Link ¶

⚼ 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 backup vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
Reference :  Link ¶

⚼ 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 backup vault. ,
Required: True ,
}
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 ,
}
,
x-ms-authorization-auxiliary:
{
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 ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Reference :  Link ¶

⚼ 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 backup vault. ,
Required: True ,
}
string ,
operationId:
{
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 ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  API to check for resource name availability
Reference :  Link ¶

⚼ 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 location in which uniqueness will be verified. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Validates if a feature is supported
Reference :  Link ¶

⚼ 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:
{
Required: True ,
}
string ,
parameters:
{
Description: Feature support request object ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns the list of available operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: Link to the next chunk of Response. ,
Required: False ,
}
string ,
value:
{
Description: List of available operations. ,
Required: False ,
}
[
{
display:
{
Description: Contains the localized display information for this particular operation ,
Required: False ,
}
{
description:
{
Description: Description of the operation having details of what operation is about. ,
Required: False ,
}
string ,
operation:
{
Description: Operations Name itself. ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: ResourceType for which this Operation can be performed. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the Operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
origin:
{
Description: The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX ,
Required: False ,
}
string ,
properties:
{
Description: Properties for the given operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Operation properties. ,
Required: False ,
}
{
logSpecifications:
{
Description: List of log specifications of this operation. ,
Required: False ,
}
[
{
blobDuration:
{
Description: blob duration of shoebox log specification ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name ,
Required: False ,
}
string ,
name:
{
Description: Name for shoebox log specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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_List (new)
Description :  Returns list of backup policies belonging to a backup vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies
{
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: 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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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_Get (new)
Description :  Gets a backup policy belonging to a backup vault
Reference :  Link ¶

⚼ Request

GET:  /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 ,
}

⚐ 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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Creates or Updates a backup policy belonging to a backup vault
Reference :  Link ¶

⚼ 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:
{
Description: Name of the policy ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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_Delete (new)
Description :  Deletes a backup policy belonging to a backup vault
Reference :  Link ¶

⚼ Request

DELETE:  /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 ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Gets a backup instances belonging to a backup vault
Reference :  Link ¶

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Gets a backup instance with name in a backup vault
Reference :  Link ¶

⚼ 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 backup instance. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Create or update a backup instance in a backup vault
Reference :  Link ¶

⚼ 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 backup instance. ,
Required: True ,
}
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 ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Delete a backup instance in a backup vault
Reference :  Link ¶

⚼ 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 backup instance. ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Trigger adhoc backup
Reference :  Link ¶

⚼ 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 backup instance. ,
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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Validate whether adhoc backup will be successful or not
Reference :  Link ¶

⚼ 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 backup vault. ,
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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Validate whether update for backup instance will be successful or not
Reference :  Link ¶

⚼ 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 backup instance. ,
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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupInstances_GetBackupInstanceOperationResult (new)
Description :  Get result of backup instance creation operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the backup instance. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
RecoveryPoints_List (new)
Description :  Returns a list of Recovery Points for a DataSource in a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the backup vault. ,
Required: True ,
}
string ,
backupInstanceName:
{
Description: The name of the backup instance. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
RecoveryPoints_Get (new)
Description :  Gets a Recovery Point using recoveryPointId for a Datasource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}
{
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 backup instance. ,
Required: True ,
}
string ,
recoveryPointId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.
Reference :  Link ¶

⚼ 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 ,
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 ,
}
,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Triggers Cross Region Restore for BackupInstance.
Reference :  Link ¶

⚼ 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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupInstances_ValidateCrossRegionRestore (new)
Description :  Validates whether Cross Region Restore can be triggered for DataSource.
Reference :  Link ¶

⚼ 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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FetchCrossRegionRestoreJob_Get (new)
Description :  Fetches the Cross Region Restore Job
Reference :  Link ¶

⚼ 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 ,
}
string ,
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 ,
}
string ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Fetches list of Cross Region Restore job belonging to the vault
Reference :  Link ¶

⚼ 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 ,
}
string ,
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 ,
}
string ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
BackupInstancesExtensionRouting_List (new)
Description :  Gets a list of backup instances associated with a tracked resource
Reference :  Link ¶

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  rehydrate recovery point for restore for a BackupInstance
Reference :  Link ¶

⚼ 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 ,
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 ,
vaultName:
{
Description: The name of the backup vault. ,
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 ,
}
,
backupInstanceName:
{
Description: The name of the backup instance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Triggers restore for a BackupInstance
Reference :  Link ¶

⚼ 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 backup instance. ,
Required: True ,
}
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 ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  This operation will resume backups for backup instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups
{
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 backup instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  This operation will resume protection for a stopped backup instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection
{
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 backup instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  This operation will stop protection of a backup instance and data will be held forever
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection
{
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 backup instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups
{
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 backup instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync
{
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 backup instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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_ValidateForRestore (new)
Description :  Validates if Restore can be triggered for a DataSource
Reference :  Link ¶

⚼ 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 backup instance. ,
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)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns list of jobs belonging to a backup vault
Reference :  Link ¶

⚼ 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 ,
}
string ,
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 ,
}
string ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Reference :  Link ¶

⚼ 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 backup instance. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Gets a job with id in a backup vault
Reference :  Link ¶

⚼ 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 ,
}
string ,
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 ,
}
string ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Triggers export of jobs and returns an OperationID to track.
Reference :  Link ¶

⚼ 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 backup vault. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
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 ¶

⚼ 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 backup vault. ,
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 ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DeletedBackupInstances_List (new)
Description :  Gets deleted backup instances belonging to a backup vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances
{
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: DeletedBackupInstanceResource properties ,
Required: False ,
}
{
deletionInfo:
{
Description: Deletion info of Backup Instance ,
Required: False ,
}
{
deletionTime:
{
Description: Specifies time of deletion ,
Required: False ,
}
string ,
billingEndDate:
{
Description: Specifies billing end date ,
Required: False ,
}
string ,
scheduledPurgeTime:
{
Description: Specifies purge time ,
Required: False ,
}
string ,
deleteActivityID:
{
Description: Delete activity ID for troubleshooting purpose ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DeletedBackupInstances_Get (new)
Description :  Gets a deleted backup instance with name in a backup vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{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 deleted backup instance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DeletedBackupInstanceResource properties ,
Required: False ,
}
{
deletionInfo:
{
Description: Deletion info of Backup Instance ,
Required: False ,
}
{
deletionTime:
{
Description: Specifies time of deletion ,
Required: False ,
}
string ,
billingEndDate:
{
Description: Specifies billing end date ,
Required: False ,
}
string ,
scheduledPurgeTime:
{
Description: Specifies purge time ,
Required: False ,
}
string ,
deleteActivityID:
{
Description: Delete activity ID for troubleshooting purpose ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DeletedBackupInstances_Undelete (new)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete
{
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 deleted backup instance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns ResourceGuards collection belonging to a subscription.
Reference :  Link ¶

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns ResourceGuards collection belonging to a ResourceGroup.
Reference :  Link ¶

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Creates or updates a ResourceGuard resource belonging to a resource group.
Reference :  Link ¶

⚼ 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 ,
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 ,
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 ,
}
,
}
,
}

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

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

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns a ResourceGuard belonging to a resource group.
Reference :  Link ¶

⚼ 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 ,
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 ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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_Delete (new)
Description :  Deletes a ResourceGuard resource from the resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dpp resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 (new)
Description :  Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
Reference :  Link ¶

⚼ 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 ,
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 ,
resourceGuardsName:
{
Required: True ,
}
string ,
requestName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DppResourceGuardProxy_List (new)
Description :  Returns the list of ResourceGuardProxies associated with the vault
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: False ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DppResourceGuardProxy_Get (new)
Description :  Returns the ResourceGuardProxy object associated with the vault, and that matches the name in the request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Description: name of the resource guard proxy ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: False ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DppResourceGuardProxy_CreateOrUpdate (new)
Description :  Creates or Updates a ResourceGuardProxy
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Description: name of the resource guard proxy ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: False ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: False ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DppResourceGuardProxy_Delete (new)
Description :  Deletes the ResourceGuardProxy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Description: name of the resource guard proxy ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
DppResourceGuardProxy_UnlockDelete (new)
Description :  UnlockDelete call for ResourceGuardProxy, executed before one can delete it
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete
{
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 ,
resourceGuardProxyName:
{
Description: name of the resource guard proxy ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
resourceToBeDeleted:
{
Required: False ,
}
string ,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
unlockDeleteExpiryTime:
{
Description: This is the time when unlock delete privileges will get expired. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}