Breaking Changes

Breaking changes cause REST API v7 to function differently and could affect the client code.

Schema Changes Causing Compatibility Issues

The following changes in the REST API schemas were made:

  • HTTP POST /api/v7/jobSessions/export request:
  • Added the JobSessionExportOptions request body schema.
  • HTTP POST /api/v7/policies/virtualMachines/export request:
  • Added the VirtualMachinePoliciesExportOptions request body schema.
  • HTTP POST /api/v7/policies/fileShares/export request:
  • Added the FileSharePoliciesExportOptions request body schema.
  • HTTP POST /api/v7/policies/sql/export request:
  • Added the SqlPoliciesExportOptions request body schema.
  • HTTP POST /api/v7/protectedItem/sql/export request:
  • Added the ProtectedSqlDatabaseExportOptions request body schema.
  • HTTP POST /api/v7/protectedItem/fileShares/export request:
  • Added the ProtectedFileShareExportOptions request body schema.
  • HTTP POST /api/v7/protectedItem/virtualMachines/export request:
  • Added the ProtectedVirtualMachineExportOptions request body schema.
  • HTTP POST /api/v7/protectedItem/vnet/export request:
  • Added the ProtectedVnetExportOptions request body schema.
  • HTTP POST /api/v7/protectedItem/vnet/delete request:
  • Added the deletionType required property to the ProtectedVnetToDelete request body schema.

New Query Parameters

The following new query parameters were added to the HTTP requests:

  • Added the editAccountId query parameter to the following operation:
  • HTTP POST /api/v7/accounts/azure/service/exportPermissionsByApp — Export Permissions by Application.
  • Added the accountIds query parameter to the following operation:
  • HTTP POST /api/v7/accounts/azure/service/export — Export Collection of Service Accounts.
  • Added the BackupDestinations query parameter to the following operations:
  • HTTP GET /api/v7/restorePoints/vnets — Get Virtual Network Configuration Restore Points.
  • HTTP GET /api/v7/protectedItem/vnet — Get Collection of Protected Azure Virtual Networks.
  • Added the AccountIds query parameter to the following operation:
  • HTTP POST /api/v7/accounts/azure/service/export — Export Collection of SMTP and Database Accounts.
  • Added the databaseIds query parameter to the following operation:
  • HTTP POST /api/v7/databases/export — Export Collection of SQL Databases.
  • Added the fileShareIds query parameter to the following operation:
  • HTTP POST /api/v7/fileShares/export — Export Collection of File Shares.
  • Added the LicensedResourceIds query parameter to the following operation:
  • HTTP POST /api/v7/license/export — Export License Usage Report.
  • Added the UserIds query parameter to the following operation:
  • HTTP POST /api/v7/users/export — Export Collection of Users.
  • Added the virtualMachineIds query parameter to the following operation:
  • HTTP POST /api/v7/virtualMachines/export — Export Collection of Azure VMs.
  • Added the vmNames query parameter to the following operation:
  • HTTP POST /api/v7/workers/export — Export Collection of Worker Instances.
  • Added the RegionIds query parameter to the following operation:
  • HTTP POST /api/v7/workers/networkConfiguration/export — Export Worker Configurations.
  • Added the subscriptionId query parameter to the following operation:
  • HTTP GET /api/v7/workers/networkConfiguration/{regionId} — Get Worker Configuration Data.
  • HTTP DELETE /api/v7/workers/networkConfiguration/{regionId} — Remove Worker Configuration.