From 6a4ecaba56b6bc6bda4986730f1ff191d6420640 Mon Sep 17 00:00:00 2001 From: Mayank Aggarwal Date: Tue, 8 Jun 2021 10:53:42 +0530 Subject: [PATCH] Changes in operation ids (#14665) * manual changes for swagger * changes for long-running operations * changes for validate for backup and restore * removing 204 from operationResults * changes for a monitoring * adding format * removing date-time from duration * changing to readonly * changes for listRPs * fixes swagger * reverting readonly for scheduleTimes * fixes for checkgates * prettier fixes * cahnges for friendlyname checks * fixing gates * removing tracking-via * model validation fixes * powershell changes * adding stable version * changes for PatchResourceRequestInput * change for req fields * changes for description * changes * Updated swagger json for item level restore target info objects * Fixed spelling errors * Added missing required properties * removed auth credentials property * prettier fixes * Prettier fix * pr comments fixes * fixing readme * changes for go readme * Removed x-ms-flatten property (#2) * removed flatten prop * removing x-ms-flatten * removing friendlyName from req prop Co-authored-by: Mayank Aggarwal * changes in operation ids (#3) * changes in operation ids * changes * changes Co-authored-by: Mayank Aggarwal * lint and model vaidations * changes for prettier * changing version in example Co-authored-by: Mayank Aggarwal Co-authored-by: FAREAST\zakinkh --- .../2021-02-01-preview/dataprotection.json | 43 +- .../FindRestorableTimeRanges.json | 2 +- .../examples/Operations/List.json | 403 ++++++++++++++++++ .../stable/2021-01-01/dataprotection.json | 43 +- .../FindRestorableTimeRanges.json | 2 +- .../2021-01-01/examples/Operations/List.json | 403 ++++++++++++++++++ 6 files changed, 856 insertions(+), 40 deletions(-) create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json index d262636aea34..9eb6e6b56625 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json @@ -24,7 +24,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a subscription.", - "operationId": "BackupVaults_GetResourcesInSubscription", + "operationId": "BackupVaults_GetInSubscription", "produces": [ "application/json" ], @@ -136,7 +136,7 @@ "OperationStatus" ], "summary": "Gets the operation status for a resource.", - "operationId": "GetOperationStatus", + "operationId": "OperationStatus_Get", "produces": [ "application/json" ], @@ -187,7 +187,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a resource group.", - "operationId": "BackupVaults_GetResourcesInResourceGroup", + "operationId": "BackupVaults_GetInResourceGroup", "produces": [ "application/json" ], @@ -389,7 +389,7 @@ "BackupVaults" ], "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", - "operationId": "BackupVaults_Patch", + "operationId": "BackupVaults_Update", "produces": [ "application/json" ], @@ -446,7 +446,7 @@ "tags": [ "Resources" ], - "operationId": "GetOperationResultPatch", + "operationId": "BackupVaultOperationResults_Get", "produces": [ "application/json" ], @@ -555,7 +555,7 @@ "DppFeatureSupport" ], "summary": "Validates if a feature is supported", - "operationId": "CheckFeatureSupport", + "operationId": "DataProtection_CheckFeatureSupport", "produces": [ "application/json" ], @@ -609,7 +609,7 @@ "Operations" ], "description": "Returns the list of available operations.", - "operationId": "Operations_List", + "operationId": "DataProtectionOperations_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -632,6 +632,11 @@ "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } } } }, @@ -758,6 +763,7 @@ }, { "name": "backupPolicyName", + "description": "Name of the policy", "in": "path", "required": true, "type": "string" @@ -1236,7 +1242,7 @@ "RecoveryPoint" ], "description": "Returns a list of Recovery Points for a DataSource in a vault.", - "operationId": "RecoveryPoints_GetList", + "operationId": "RecoveryPoints_List", "produces": [ "application/json" ], @@ -1306,7 +1312,7 @@ "RecoveryPoint" ], "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", - "operationId": "RecoveryPoint_Get", + "operationId": "RecoveryPoints_Get", "produces": [ "application/json" ], @@ -1870,7 +1876,7 @@ "BackupInstances" ], "description": "Validates if Restore can be triggered for a DataSource", - "operationId": "BackupInstances_ValidateRestore", + "operationId": "BackupInstances_ValidateForRestore", "produces": [ "application/json" ], @@ -1992,12 +1998,12 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstances}/findRestorableTimeRanges": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { "post": { "tags": [ "FindRestorableTimeRanges" ], - "operationId": "FindRestorableTimeRanges_Post", + "operationId": "RestorableTimeRanges_Find", "produces": [ "application/json" ], @@ -2015,7 +2021,8 @@ "$ref": "#/parameters/SubscriptionId" }, { - "name": "backupInstances", + "name": "backupInstanceName", + "description": "The name of the backup instance", "in": "path", "required": true, "type": "string" @@ -2057,7 +2064,7 @@ "AzureBackupJob" ], "description": "Gets a job with id in a backup vault", - "operationId": "Job_Get", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -2367,9 +2374,7 @@ "AzureBackupFindRestorableTimeRangesRequest": { "description": "List Restore Ranges Request", "required": [ - "sourceDataStoreType", - "startTime", - "endTime" + "sourceDataStoreType" ], "type": "object", "properties": { @@ -2387,11 +2392,11 @@ } }, "startTime": { - "description": "Start time for the List Restore Ranges request", + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", "type": "string" }, "endTime": { - "description": "End time for the List Restore Ranges request", + "description": "End time for the List Restore Ranges request. ISO 8601 format.", "type": "string" } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json index 5019b2cf6725..7e1fd818feb3 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "Blob-Backup", "vaultName": "ZBlobBackupVaultBVTD3", - "backupInstances": "zblobbackuptestsa58", + "backupInstanceName": "zblobbackuptestsa58", "api-version": "2021-02-01-preview", "parameters": { "sourceDataStoreType": "OperationalStore", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json new file mode 100644 index 000000000000..c3dfcdf4beb1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json @@ -0,0 +1,403 @@ +{ + "parameters": { + "api-version": "2021-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataProtection/locations/getBackupStatus/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Create a Backup Instance", + "description": "Creates a Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Delete Backup Instance", + "description": "Deletes the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instance Details", + "description": "Returns details of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instances", + "description": "Returns all Backup Instances" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Backup Backup Instance", + "description": "Performs Backup on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Sync Backup Instance", + "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Stop Protection of Backup Instance", + "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Suspend Backups of Backup Instance", + "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Protection of Backup Instance", + "description": "Resume protection of a ProtectionStopped BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Backups of Backup Instance", + "description": "Resume Backups for a BackupsSuspended BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Validate for Restore of Backup Instance", + "description": "Validates for Restore of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Restore Backup Instance", + "description": "Triggers restore on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Create Backup Policy", + "description": "Creates Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Delete Backup Policy", + "description": "Deletes the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policy details", + "description": "Returns details of the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policies", + "description": "Returns all Backup Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Point Details", + "description": "Returns details of the Recovery Point" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Returns all Recovery Points" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Restorable Time Ranges", + "operation": "Find Restorable Time Ranges", + "description": "Finds Restorable Time Ranges" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Operation Result of a Patch Operation for a Backup Vault", + "description": "Gets Operation Result of a Patch Operation for a Backup Vault" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Check if the requested BackupVault Name is Available", + "description": "Checks if the requested BackupVault Name is Available" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Resource Group", + "description": "Gets list of Backup Vaults in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Subscription", + "description": "Gets list of Backup Vaults in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Create ResourceGuard", + "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard", + "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Delete ResourceGuard", + "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Resource Group", + "description": "Gets list of ResourceGuards in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Subscription", + "description": "Gets list of ResourceGuards in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Update ResourceGuard", + "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard operation request info", + "description": "Gets ResourceGuard operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard default operation request info", + "description": "Gets ResourceGuard default operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Validate Backup", + "operation": "Validate for backup of Backup Instance", + "description": "Validates for backup of Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/providers/operations/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "List of Operations", + "description": "Operation returns the list of Operations for a Resource Provider" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json index b07d7b3bc7e2..26a7833efde7 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json @@ -24,7 +24,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a subscription.", - "operationId": "BackupVaults_GetResourcesInSubscription", + "operationId": "BackupVaults_GetInSubscription", "produces": [ "application/json" ], @@ -136,7 +136,7 @@ "OperationStatus" ], "summary": "Gets the operation status for a resource.", - "operationId": "GetOperationStatus", + "operationId": "OperationStatus_Get", "produces": [ "application/json" ], @@ -187,7 +187,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a resource group.", - "operationId": "BackupVaults_GetResourcesInResourceGroup", + "operationId": "BackupVaults_GetInResourceGroup", "produces": [ "application/json" ], @@ -389,7 +389,7 @@ "BackupVaults" ], "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", - "operationId": "BackupVaults_Patch", + "operationId": "BackupVaults_Update", "produces": [ "application/json" ], @@ -446,7 +446,7 @@ "tags": [ "Resources" ], - "operationId": "GetOperationResultPatch", + "operationId": "BackupVaultOperationResults_Get", "produces": [ "application/json" ], @@ -555,7 +555,7 @@ "DppFeatureSupport" ], "summary": "Validates if a feature is supported", - "operationId": "CheckFeatureSupport", + "operationId": "DataProtection_CheckFeatureSupport", "produces": [ "application/json" ], @@ -609,7 +609,7 @@ "Operations" ], "description": "Returns the list of available operations.", - "operationId": "Operations_List", + "operationId": "DataProtectionOperations_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -632,6 +632,11 @@ "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } } } }, @@ -758,6 +763,7 @@ }, { "name": "backupPolicyName", + "description": "Name of the policy", "in": "path", "required": true, "type": "string" @@ -1236,7 +1242,7 @@ "RecoveryPoint" ], "description": "Returns a list of Recovery Points for a DataSource in a vault.", - "operationId": "RecoveryPoints_GetList", + "operationId": "RecoveryPoints_List", "produces": [ "application/json" ], @@ -1306,7 +1312,7 @@ "RecoveryPoint" ], "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", - "operationId": "RecoveryPoint_Get", + "operationId": "RecoveryPoints_Get", "produces": [ "application/json" ], @@ -1526,7 +1532,7 @@ "BackupInstances" ], "description": "Validates if Restore can be triggered for a DataSource", - "operationId": "BackupInstances_ValidateRestore", + "operationId": "BackupInstances_ValidateForRestore", "produces": [ "application/json" ], @@ -1648,12 +1654,12 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstances}/findRestorableTimeRanges": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { "post": { "tags": [ "FindRestorableTimeRanges" ], - "operationId": "FindRestorableTimeRanges_Post", + "operationId": "RestorableTimeRanges_Find", "produces": [ "application/json" ], @@ -1671,7 +1677,8 @@ "$ref": "#/parameters/SubscriptionId" }, { - "name": "backupInstances", + "name": "backupInstanceName", + "description": "The name of the backup instance", "in": "path", "required": true, "type": "string" @@ -1713,7 +1720,7 @@ "AzureBackupJob" ], "description": "Gets a job with id in a backup vault", - "operationId": "Job_Get", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -2023,9 +2030,7 @@ "AzureBackupFindRestorableTimeRangesRequest": { "description": "List Restore Ranges Request", "required": [ - "sourceDataStoreType", - "startTime", - "endTime" + "sourceDataStoreType" ], "type": "object", "properties": { @@ -2043,11 +2048,11 @@ } }, "startTime": { - "description": "Start time for the List Restore Ranges request", + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", "type": "string" }, "endTime": { - "description": "End time for the List Restore Ranges request", + "description": "End time for the List Restore Ranges request. ISO 8601 format.", "type": "string" } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json index e50e8a20f945..4efd81f74b40 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "Blob-Backup", "vaultName": "ZBlobBackupVaultBVTD3", - "backupInstances": "zblobbackuptestsa58", + "backupInstanceName": "zblobbackuptestsa58", "api-version": "2021-01-01", "parameters": { "sourceDataStoreType": "OperationalStore", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json new file mode 100644 index 000000000000..cf150a7e1d56 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json @@ -0,0 +1,403 @@ +{ + "parameters": { + "api-version": "2021-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataProtection/locations/getBackupStatus/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Create a Backup Instance", + "description": "Creates a Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Delete Backup Instance", + "description": "Deletes the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instance Details", + "description": "Returns details of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instances", + "description": "Returns all Backup Instances" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Backup Backup Instance", + "description": "Performs Backup on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Sync Backup Instance", + "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Stop Protection of Backup Instance", + "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Suspend Backups of Backup Instance", + "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Protection of Backup Instance", + "description": "Resume protection of a ProtectionStopped BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Backups of Backup Instance", + "description": "Resume Backups for a BackupsSuspended BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Validate for Restore of Backup Instance", + "description": "Validates for Restore of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Restore Backup Instance", + "description": "Triggers restore on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Create Backup Policy", + "description": "Creates Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Delete Backup Policy", + "description": "Deletes the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policy details", + "description": "Returns details of the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policies", + "description": "Returns all Backup Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Point Details", + "description": "Returns details of the Recovery Point" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Returns all Recovery Points" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Restorable Time Ranges", + "operation": "Find Restorable Time Ranges", + "description": "Finds Restorable Time Ranges" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Operation Result of a Patch Operation for a Backup Vault", + "description": "Gets Operation Result of a Patch Operation for a Backup Vault" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Check if the requested BackupVault Name is Available", + "description": "Checks if the requested BackupVault Name is Available" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Resource Group", + "description": "Gets list of Backup Vaults in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Subscription", + "description": "Gets list of Backup Vaults in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Create ResourceGuard", + "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard", + "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Delete ResourceGuard", + "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Resource Group", + "description": "Gets list of ResourceGuards in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Subscription", + "description": "Gets list of ResourceGuards in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Update ResourceGuard", + "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard operation request info", + "description": "Gets ResourceGuard operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard default operation request info", + "description": "Gets ResourceGuard default operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Validate Backup", + "operation": "Validate for backup of Backup Instance", + "description": "Validates for backup of Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/providers/operations/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "List of Operations", + "description": "Operation returns the list of Operations for a Resource Provider" + }, + "origin": "user" + } + ] + } + } + } +}