-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams <[email protected]> * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart <[email protected]> * full backup restore yaml changes (#8685) * Adding the required swagger file changes for full HSM backup Signed-off-by: vasanthrajams <[email protected]> * Resolved a few semantic errors in pipeline Signed-off-by: vasanthrajams <[email protected]> * Fixed incremental github pipeline model validation erors Signed-off-by: vasanthrajams <[email protected]> * Fixed review comments & ci pipeline * spell check fix * pretty fix * Adding required headers as per azure async operations guidelines Signed-off-by: vasanthrajams <[email protected]> * Fixed minor typos Signed-off-by: vasanthrajams <[email protected]> Co-authored-by: vasanthrajams <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: vasanthrajams <[email protected]>
- Loading branch information
3 people
authored
Mar 20, 2020
1 parent
b11bc83
commit 001730d
Showing
99 changed files
with
10,049 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
306 changes: 306 additions & 0 deletions
306
specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,306 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "KeyVaultClient", | ||
| "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", | ||
| "version": "7.2-preview" | ||
| }, | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/backup": { | ||
| "post": { | ||
| "tags": [ | ||
| "FullBackup" | ||
| ], | ||
| "operationId": "FullBackup", | ||
| "description": "Creates a full backup using a user-provided SAS token to an Azure blob storage container.", | ||
| "parameters": [ | ||
| { | ||
| "in": "body", | ||
| "name": "azureStorageBlobContainerUri", | ||
| "schema": { | ||
| "$ref": "#/definitions/SASTokenParameter" | ||
| }, | ||
| "description": "Azure blob shared access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "202": { | ||
| "description": "Started full backup", | ||
| "headers": { | ||
| "Retry-After": { | ||
| "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", | ||
| "type": "integer" | ||
| }, | ||
| "Azure-AsyncOperation": { | ||
| "description": "The URI to poll for completion status.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "schema": { | ||
| "$ref": "#/definitions/FullBackupOperation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Create full backup": { | ||
| "$ref": "./examples/FullBackup-example.json" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/backup/{jobId}/pending": { | ||
| "get": { | ||
| "tags": [ | ||
| "FullBackup" | ||
| ], | ||
| "operationId": "FullBackupStatus", | ||
| "description": "Returns the status of full backup operation", | ||
| "parameters": [ | ||
| { | ||
| "name": "jobId", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The id returned as part of the backup request" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK - Returns the full backup status", | ||
| "schema": { | ||
| "$ref": "#/definitions/FullBackupOperation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Full backup status": { | ||
| "$ref": "./examples/FullBackup-pending-example.json" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/restore": { | ||
| "put": { | ||
| "tags": [ | ||
| "FullRestore" | ||
| ], | ||
| "operationId": "FullRestoreOperation", | ||
| "description": "Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder", | ||
| "parameters": [ | ||
| { | ||
| "name": "restoreBlobDetails", | ||
| "in": "body", | ||
| "schema": { | ||
| "$ref": "#/definitions/RestoreOperationParameters" | ||
| }, | ||
| "description": "The Azure blob SAS token pointing to a folder where the previous successful full backup was stored" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "202": { | ||
| "description": "Started restore operation from the previously stored backup", | ||
| "headers": { | ||
| "Retry-After": { | ||
| "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", | ||
| "type": "integer" | ||
| }, | ||
| "Azure-AsyncOperation": { | ||
| "description": "The URI to poll for completion status.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "schema": { | ||
| "$ref": "#/definitions/FullRestoreOperation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Create full restore from backup": { | ||
| "$ref": "./examples/FullRestore-example.json" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/restore/{jobId}/pending": { | ||
| "get": { | ||
| "tags": [ | ||
| "FullRestore" | ||
| ], | ||
| "operationId": "FullRestoreStatus", | ||
| "description": "Returns the status of full restore operation", | ||
| "parameters": [ | ||
| { | ||
| "name": "jobId", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The Job Id returned part of the full restore operation" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK - Returns the full restore status", | ||
| "schema": { | ||
| "$ref": "#/definitions/FullRestoreOperation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Full restore status": { | ||
| "$ref": "./examples/FullRestore-pending-example.json" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "RestoreOperationParameters": { | ||
| "properties": { | ||
| "sasTokenParameters": { | ||
| "$ref": "#/definitions/SASTokenParameter" | ||
| }, | ||
| "folderToRestore": { | ||
| "type": "string", | ||
| "description": "The Folder name of the blob where the previous successful full backup was stored" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "folderToRestore", | ||
| "sasTokenParameters" | ||
| ] | ||
| }, | ||
| "SASTokenParameter": { | ||
| "properties": { | ||
| "storageResourceUri": { | ||
| "type": "string", | ||
| "description": "Azure Blob storage container Uri" | ||
| }, | ||
| "token": { | ||
| "type": "string", | ||
| "description": "The SAS token pointing to an Azure Blob storage container" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "storageResourceUri", | ||
| "token" | ||
| ] | ||
| }, | ||
| "FullBackupOperation": { | ||
| "properties": { | ||
| "status": { | ||
| "type": "string", | ||
| "description": "Status of the backup operation." | ||
| }, | ||
| "statusDetails": { | ||
| "type": "string", | ||
| "description": "The status details of backup operation." | ||
| }, | ||
| "error": { | ||
| "$ref": "common.json#/definitions/Error", | ||
| "description": "Error encountered, if any, during the full backup operation." | ||
| }, | ||
| "startTime": { | ||
| "type": "integer", | ||
| "format": "unixtime", | ||
| "description": "The start time of the backup operation in UTC" | ||
| }, | ||
| "endTime": { | ||
| "type": "integer", | ||
| "format": "unixtime", | ||
| "description": "The end time of the backup operation in UTC" | ||
| }, | ||
| "jobId": { | ||
| "type": "string", | ||
| "description": "Identifier for the full backup operation." | ||
| }, | ||
| "azureStorageBlobContainerUri": { | ||
| "type": "string", | ||
| "description": "The Azure blob storage container Uri which contains the full backup" | ||
| } | ||
| }, | ||
| "description": "Full backup operation" | ||
| }, | ||
| "FullRestoreOperation": { | ||
| "properties": { | ||
| "status": { | ||
| "type": "string", | ||
| "description": "Status of the restore operation." | ||
| }, | ||
| "statusDetails": { | ||
| "type": "string", | ||
| "description": "The status details of restore operation." | ||
| }, | ||
| "error": { | ||
| "$ref": "common.json#/definitions/Error", | ||
| "description": "Error encountered, if any, during the full restore operation." | ||
| }, | ||
| "jobId": { | ||
| "type": "string", | ||
| "description": "Identifier for the full restore operation." | ||
| }, | ||
| "startTime": { | ||
| "type": "integer", | ||
| "format": "unixtime", | ||
| "description": "The start time of the restore operation" | ||
| }, | ||
| "endTime": { | ||
| "type": "integer", | ||
| "format": "unixtime", | ||
| "description": "The end time of the restore operation" | ||
| } | ||
| }, | ||
| "description": "Full restore operation" | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Client API version." | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.