|
418 | 418 | "tags": [ |
419 | 419 | "Confidential Ledger" |
420 | 420 | ], |
421 | | - "summary": "Retrieves information about all Confidential Ledger resources under the given subscription", |
422 | | - "description": "Retrieves the properties of all Confidential Ledgers.", |
423 | | - "operationId": "Ledger_ListBySubscription", |
| 421 | + "summary": "Performs the backup operation on a Confidential Ledger Resource.", |
| 422 | + "description": "Backs up a Confidential Ledger Resource.", |
| 423 | + "operationId": "Ledger_Backup", |
424 | 424 | "parameters": [ |
425 | 425 | { |
426 | 426 | "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
|
429 | 429 | "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
430 | 430 | }, |
431 | 431 | { |
432 | | - "type": "string", |
433 | | - "description": "The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'", |
434 | | - "name": "$filter", |
435 | | - "in": "query" |
| 432 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 433 | + }, |
| 434 | + { |
| 435 | + "$ref": "#/parameters/LedgerNameParameter" |
| 436 | + }, |
| 437 | + { |
| 438 | + "name": "confidentialLedger", |
| 439 | + "in": "body", |
| 440 | + "description": "Confidential Ledger Backup Request Body", |
| 441 | + "required": true, |
| 442 | + "schema": { |
| 443 | + "$ref": "#/definitions/ConfidentialLedgerBackup" |
| 444 | + } |
436 | 445 | } |
437 | 446 | ], |
438 | 447 | "responses": { |
439 | 448 | "200": { |
440 | | - "description": "The request was successful; response contains the list of Confidential Ledgers", |
441 | | - "schema": { |
442 | | - "$ref": "#/definitions/ConfidentialLedgerList" |
443 | | - } |
| 449 | + "description": "The request was successful; response contains a message stating the instance is successfully being backed up." |
444 | 450 | }, |
445 | 451 | "default": { |
446 | 452 | "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", |
|
449 | 455 | } |
450 | 456 | } |
451 | 457 | }, |
452 | | - "x-ms-pageable": { |
453 | | - "nextLinkName": "nextLink" |
454 | | - }, |
455 | 458 | "x-ms-examples": { |
456 | 459 | "ConfidentialLedgerListBySub": { |
457 | 460 | "$ref": "./examples/ConfidentialLedger_Backup.json" |
|
464 | 467 | "tags": [ |
465 | 468 | "Confidential Ledger" |
466 | 469 | ], |
467 | | - "summary": "Retrieves information about all Confidential Ledger resources under the given subscription", |
468 | | - "description": "Retrieves the properties of all Confidential Ledgers.", |
469 | | - "operationId": "Ledger_ListBySubscription", |
| 470 | + "summary": "Performs the restore operation to spin up a newly restored Confidential Ledger Resource.", |
| 471 | + "description": "Restores a Confidential Ledger Resource.", |
| 472 | + "operationId": "Ledger_Restore", |
470 | 473 | "parameters": [ |
471 | 474 | { |
472 | 475 | "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
|
475 | 478 | "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
476 | 479 | }, |
477 | 480 | { |
478 | | - "type": "string", |
479 | | - "description": "The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'", |
480 | | - "name": "$filter", |
481 | | - "in": "query" |
| 481 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 482 | + }, |
| 483 | + { |
| 484 | + "$ref": "#/parameters/LedgerNameParameter" |
| 485 | + }, |
| 486 | + { |
| 487 | + "name": "confidentialLedger", |
| 488 | + "in": "body", |
| 489 | + "description": "Confidential Ledger Restore Request Body", |
| 490 | + "required": true, |
| 491 | + "schema": { |
| 492 | + "$ref": "#/definitions/ConfidentialLedgerRestore" |
| 493 | + } |
482 | 494 | } |
483 | 495 | ], |
484 | 496 | "responses": { |
485 | 497 | "200": { |
486 | | - "description": "The request was successful; response contains the list of Confidential Ledgers", |
487 | | - "schema": { |
488 | | - "$ref": "#/definitions/ConfidentialLedgerList" |
489 | | - } |
| 498 | + "description": "The request was successful; response contains a message stating the instance is successfully being restored." |
490 | 499 | }, |
491 | 500 | "default": { |
492 | | - "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", |
| 501 | + "description": "Error response describing the reason for operation failure.", |
493 | 502 | "schema": { |
494 | 503 | "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" |
495 | 504 | } |
496 | 505 | } |
497 | 506 | }, |
498 | | - "x-ms-pageable": { |
499 | | - "nextLinkName": "nextLink" |
500 | | - }, |
501 | 507 | "x-ms-examples": { |
502 | 508 | "ConfidentialLedgerListBySub": { |
503 | 509 | "$ref": "./examples/ConfidentialLedger_Restore.json" |
|
715 | 721 | } |
716 | 722 | } |
717 | 723 | }, |
| 724 | + "ConfidentialLedgerBackup": { |
| 725 | + "description": "Object representing Backup properties of Confidential Ledger Resource.", |
| 726 | + "type": "string", |
| 727 | + "properties": { |
| 728 | + "location": { |
| 729 | + "type": "string", |
| 730 | + "readOnly": false, |
| 731 | + "description": "Location where the Confidential Ledger Resource will be backed up for or restored to." |
| 732 | + }, |
| 733 | + "sasUrl": { |
| 734 | + "type": "string", |
| 735 | + "readOnly": false, |
| 736 | + "description": "SAS URI used to access the backup Fileshare." |
| 737 | + } |
| 738 | + } |
| 739 | + }, |
| 740 | + "ConfidentialLedgerRestore": { |
| 741 | + "description": "Object representing Restore properties of Confidential Ledger Resource.", |
| 742 | + "type": "string", |
| 743 | + "properties": { |
| 744 | + "fileShareName": { |
| 745 | + "type": "string", |
| 746 | + "readOnly": false, |
| 747 | + "description": "Fileshare Name where the Confidential Ledger Resource backup is stored." |
| 748 | + }, |
| 749 | + "location": { |
| 750 | + "type": "string", |
| 751 | + "readOnly": false, |
| 752 | + "description": "Location where the Confidential Ledger Resource will be backed up for or restored to." |
| 753 | + }, |
| 754 | + "sasUrl": { |
| 755 | + "type": "string", |
| 756 | + "readOnly": false, |
| 757 | + "description": "SAS URI used to access the backup Fileshare." |
| 758 | + } |
| 759 | + } |
| 760 | + }, |
718 | 761 | "ConfidentialLedger": { |
719 | 762 | "type": "object", |
720 | 763 | "description": "Confidential Ledger. Contains the properties of Confidential Ledger Resource.", |
|
746 | 789 | "type": "string" |
747 | 790 | } |
748 | 791 | } |
749 | | - }, |
750 | | - "ConfidentialLedgerBackup": { |
751 | | - "description": "Object that includes an array of Confidential Ledgers and a possible link for next set.", |
752 | | - "type": "object", |
753 | | - "properties": { |
754 | | - "value": { |
755 | | - "description": "List of Confidential Ledgers", |
756 | | - "type": "array", |
757 | | - "items": { |
758 | | - "$ref": "#/definitions/ConfidentialLedger" |
759 | | - } |
760 | | - }, |
761 | | - "nextLink": { |
762 | | - "description": "The URL the client should use to fetch the next page (per server side paging).", |
763 | | - "type": "string" |
764 | | - } |
765 | | - } |
766 | | - }, |
767 | | - "ConfidentialLedgerRestore": { |
768 | | - "description": "Object that includes an array of Confidential Ledgers and a possible link for next set.", |
769 | | - "type": "object", |
770 | | - "properties": { |
771 | | - "value": { |
772 | | - "description": "List of Confidential Ledgers", |
773 | | - "type": "array", |
774 | | - "items": { |
775 | | - "$ref": "#/definitions/ConfidentialLedger" |
776 | | - } |
777 | | - }, |
778 | | - "nextLink": { |
779 | | - "description": "The URL the client should use to fetch the next page (per server side paging).", |
780 | | - "type": "string" |
781 | | - } |
782 | | - } |
783 | 792 | } |
784 | 793 | }, |
785 | 794 | "parameters": { |
|
0 commit comments