diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/CreateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/CreateJob.json new file mode 100644 index 000000000000..c9c016c38b63 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/CreateJob.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import", + "body": { + "location": "West US", + "properties": { + "storageAccountId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Tets", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "driveList": [ + { + "driveId": "9CA995BB", + "bitLockerKey": "238810-662376-448998-450120-652806-203390-606320-483076", + "manifestFile": "\\DriveManifest.xml", + "manifestHash": "109B21108597EF36D5785F08303F3638", + "driveHeaderHash": "" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + }, + "201": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/DeleteJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/DeleteJob.json new file mode 100644 index 000000000000..b2619aea61c4 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/DeleteJob.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetJob.json new file mode 100644 index 000000000000..da9bc9a3826f --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetJob.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetLocation.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetLocation.json new file mode 100644 index 000000000000..d1b9d9e619cf --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/GetLocation.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "locationName": "West US" + }, + "responses": { + "200": { + "body": { + "properties":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600", + "supportedCarriers":[ + "FedEx" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/westus" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/westus", + "name":"West US", + "type":"Microsoft.ImportExport/locations" + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListBitLockerKeys.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListBitLockerKeys.json new file mode 100644 index 000000000000..350059ad2f42 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListBitLockerKeys.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "driveId":"9CA995BB", + "bitLockerKey":"000000-000000-111111-222222-333333-444444-555555-666666" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInResourceGroup.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInResourceGroup.json new file mode 100644 index 000000000000..8064e50d333d --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInResourceGroup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/xtprodtestwu", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"787895108176", + "driveCount":1, + "shipDate":"9/29/2017 10:28:35 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Received", + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-ssd-2", + "name":"test-by1-ssd-2", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInSubscription.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInSubscription.json new file mode 100644 index 000000000000..460ccc92f82c --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListJobsInSubscription.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"city", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"425000000", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Windows Azure Import Export Service", + "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2":"", + "city":"Boydton", + "stateOrProvince":"VA", + "postalCode":"23917", + "countryOrRegion":"USA", + "phone":"+1-434-738-9443" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"992016102507", + "driveCount":1, + "shipDate":"8/11/2017 9:05:00 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Received", + "driveList":[ + { + "driveId":"7PHR882C", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"E5D632DB047C74B3B17C8F3359950ADB", + "state":"Received" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-01", + "name":"test-bn1-import-cpu100-01", + "type":"Microsoft.ImportExport/jobs", + "location":"East US 2" + }, + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"city", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4256150991", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Windows Azure Import Export Service", + "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2":"", + "city":"Boydton", + "stateOrProvince":"VA", + "postalCode":"23917", + "countryOrRegion":"USA", + "phone":"+1-434-738-9443" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"992016102508", + "driveCount":1, + "shipDate":"8/13/2017 7:32:23 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Transferring", + "percentComplete":6, + "driveList":[ + { + "driveId":"KV6H86XP", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"F6A488A65AF0CCA7D050B7F9F43A197C", + "state":"CompletedMoreInfo", + "copyStatus":"InProgress", + "verboseLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194618-350_verbose.xml", + "errorLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-021_error.xml", + "manifestUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-574_manifest.xml" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-02", + "name":"test-bn1-import-cpu100-02", + "type":"Microsoft.ImportExport/jobs", + "location":"East US 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListLocations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListLocations.json new file mode 100644 index 000000000000..7ba574f49ed3 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListLocations.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "recipientName":"Windows Azure Import/Export Service", + "streetAddress1":"Customer-A c/o NEXTDC Ltd, Delivery code ABCDEFG, 4 Eden Park Drive", + "streetAddress2":"", + "city":"Macquarie Park", + "stateOrProvince":"NSW", + "postalCode":"2113", + "countryOrRegion":"Australia", + "phone":"612 0000 0000", + "supportedCarriers":[ + "DHL" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/australiaeast" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/australiaeast", + "name":"Australia East", + "type":"Microsoft.ImportExport/locations" + }, + { + "properties":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"Microsoft, c/o NEXTDC Ltd, Delivery code ABCDEFG, 826-830 Lorimer St, Port", + "streetAddress2":"", + "city":"Melbourne", + "stateOrProvince":"Melbourne", + "postalCode":"3207", + "countryOrRegion":"Australia", + "phone":"61 0 0000 0000", + "supportedCarriers":[ + "DHL" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/australiasoutheast" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/australiasoutheast", + "name":"Australia Southeast", + "type":"Microsoft.ImportExport/locations" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListOperations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListOperations.json new file mode 100644 index 000000000000..b144ee11d26c --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/ListOperations.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "name":"Microsoft.ImportExport/locations/read", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Locations", + "operation":"Get or List Locations", + "description":"Gets the properties for the specified location or returns the list of locations." + } + }, + { + "name":"Microsoft.ImportExport/jobs/write", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Create or Update Job", + "description":"Creates a job with the specified parameters or update the properties or tags for the specified job." + } + }, + { + "name":"Microsoft.ImportExport/jobs/read", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Get or List Jobs", + "description":"Gets the properties for the specified job or returns the list of jobs." + } + }, + { + "name":"Microsoft.ImportExport/jobs/listBitLockerKeys/action", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"List BitLocker Keys", + "description":"Gets the BitLocker keys for the specified job." + } + }, + { + "name":"Microsoft.ImportExport/jobs/delete", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Delete Job", + "description":"Deletes an existing job." + } + }, + { + "name":"Microsoft.ImportExport/register/action", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Import/Export Resource Provider", + "operation":"Registers the Import/Export Resource Provider", + "description":"Registers the subscription for the import/export resource provider and enables the creation of import/export jobs." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/UpdateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/UpdateJob.json new file mode 100644 index 000000000000..c95a264b59e1 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/examples/UpdateJob.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import", + "body": { + "properties": { + "state": "", + "logLevel": "Verbose", + "backupDriveManifest": true + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-import", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } +} \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json index d015c1db7ac8..bce245786000 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json @@ -1,1210 +1,1142 @@ { - "swagger": "2.0", - "info": { - "title": "StorageImportExport", - "description": "The Microsoft Azure Storage Import/Export Resource Provider API.", - "version": "2016-11-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.windows-ppe.net/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.ImportExport/locations": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "ListLocations", - "description": "Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.", - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The locations were successfully retrieved and are in the response.", - "schema": { - "$ref": "#/definitions/LocationsListResult" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } + "swagger": "2.0", + "info": { + "title": "StorageImportExport", + "description": "The Storage Import/Export Resource Provider API.", + "version": "2016-11-01" }, - "/providers/Microsoft.ImportExport/locations/{locationName}": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "GetLocation", - "description": "Gets a location to which you can ship the disks associated with an import or export job. A location is an Azure region.", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The name of the location. For example, 'West US' or 'westus'.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The location was successfully retrieved and is in the response.", - "schema": { - "$ref": "#/definitions/Location" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_List", - "description": "Gets all the active and completed import/export jobs in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - }, - { - "name": "$top", - "in": "query", - "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", - "required": false, - "type": "integer", - "maximum": 100, - "minimum": 1 - }, - { - "name": "$filter", - "in": "query", - "description": "Can be used to restrict the results to certain conditions. The following possible values can be used with $filter: 1) $filter=type eq '{type}'; 2) $filter=trackingnumber eq '{trackingnumber}'; 3) $filter=state eq '{state}'; 4) Logical and combination of the above, for example: $filter=type eq 'Import' and state eq 'Transferring'. Valid values for type are Import and Export. Valid values for state are Creating, Shipping, Received, Transferring, Packaging, Closed, and Completed.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The jobs were successfully retrieved and are in the response.", - "schema": { - "$ref": "#/definitions/JobListResult" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_ListByResourceGroup", - "description": "Returns all active and completed import/export jobs in a resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - }, - { - "name": "$top", - "in": "query", - "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", - "required": false, - "type": "integer", - "maximum": 100, - "minimum": 1 - }, - { - "name": "$filter", - "in": "query", - "description": "Can be used to restrict the results to certain conditions. The following possible values can be used with $filter: 1) $filter=type eq '{type}'; 2) $filter=trackingnumber eq '{trackingnumber}'; 3) $filter=state eq '{state}'; 4) Logical and combination of the above, for example: $filter=type eq 'Import' and state eq 'Transferring'. Valid values for type are Import and Export. Valid values for state are Creating, Shipping, Received, Transferring, Packaging, Closed, and Completed.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The jobs were successfully retrieved and are in the response.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "paths": { + "/providers/Microsoft.ImportExport/locations":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Locations_List", + "description": "Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.", + "x-ms-examples": { + "List locations": { "$ref": "examples/ListLocations.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } } - } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_Get", - "description": "Gets information about an existing import/export job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "jobName", - "in": "path", - "description": "The name of the import/export job.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The job was successfully retrieved and is in the response.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_Update", - "description": "Updates specific properties of the import/export job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "jobName", - "in": "path", - "description": "The name of the import/export job.", - "required": true, - "type": "string" - }, - { - "name": "jobProperties", - "description": "Import/export job properties that need to be updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MutableJob" - } - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The job was successfully updated.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "/providers/Microsoft.ImportExport/locations/{locationName}":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Locations_Get", + "description": "Returns the details about a location to which you can ship the disks associated with an import or export job. A location is an Azure region.", + "x-ms-examples": { + "Get locations": { "$ref": "examples/GetLocation.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The name of the location. For example, West US or westus.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Location" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } } - } - } - }, - "put": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_CreateOrUpdate", - "description": "Creates a new import/export job or updates an existing import/export job in the specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "jobName", - "in": "path", - "description": "The name of the import/export job.", - "required": true, - "type": "string" - }, - { - "name": "jobProperties", - "description": "Properties of the import/export job that need to be specified during creation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Job" - } - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The job was successfully updated.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "201": { - "description": "The job was successfully created.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_Delete", - "description": "Deletes an existing import/export job. Only import/export jobs in the Creating or Completed states can be deleted.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "jobName", - "in": "path", - "description": "The name of the import/export job.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The job was successfully deleted." - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_ListBySubscription", + "description": "Returns all active and completed jobs in a subscription.", + "x-ms-examples": { + "List jobs in a subscription": { "$ref": "examples/ListJobsInSubscription.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", + "required": false, + "type": "integer" + }, + { + "name": "$filter", + "in": "query", + "description": "Can be used to restrict the results to certain conditions.", + "required": false, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListJobsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/moveResources": { - "post": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_Move", - "description": "Moves the specified import/export jobs from the resource group to a target resource group. The target resource group may be in a different subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "MoveJobsParameters", - "description": "Parameters to be provided to move a job from one resource group to another.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MoveJobParameters" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_ListByResourceGroup", + "description": "Returns all active and completed jobs in a resource group.", + "x-ms-examples": { + "List jobs in a resource group": { "$ref": "examples/ListJobsInResourceGroup.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", + "required": false, + "type": "integer" + }, + { + "name": "$filter", + "in": "query", + "description": "Can be used to restrict the results to certain conditions.", + "required": false, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListJobsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The job was successfully moved to the specified resource group." - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Get", + "description": "Gets information about an existing job.", + "x-ms-examples": { + "Get job": { "$ref": "examples/GetJob.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Update", + "description": "Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.", + "x-ms-examples": { + "Update job": { "$ref": "examples/UpdateJob.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"}, + { + "name": "body", + "in": "body", + "required": true, + "description": "The parameters to update in the job", + "schema": { + "$ref": "#/definitions/UpdateJobParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Create", + "description": "Creates a new job or updates an existing job in the specified subscription.", + "x-ms-examples": { + "Create job": { "$ref": "examples/CreateJob.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"}, + {"$ref": "#/parameters/x-ms-client-tenant-id"}, + { + "name": "body", + "in": "body", + "description": "The parameters used for creating the job", + "required": true, + "schema": { + "$ref": "#/definitions/PutJobParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Delete", + "description": "Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.", + "x-ms-examples": { + "Delete job": { "$ref": "examples/DeleteJob.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "Jobs_ListBitLockerKeys", - "description": "Lists the BitLocker keys for all drives in the specified import/export job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "jobName", - "in": "path", - "description": "The name of the import/export job.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The BitLocker keys were successfully retrieved and are in the response.", - "schema": { - "$ref": "#/definitions/BitLockerKeysListResult" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys":{ + "post":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "BitLockerKeys_List", + "description": "Returns the BitLocker Keys for all drives in the specified job.", + "x-ms-examples": { + "List BitLocker Keys for drives in a job": { "$ref": "examples/ListBitLockerKeys.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + {"$ref": "#/parameters/subscriptionId"}, + {"$ref": "#/parameters/resourceGroupName"}, + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetBitLockerKeysResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + }, + "/providers/Microsoft.ImportExport/operations":{ + "get":{ + "tags": [ + "StorageImportExport" + ], + "operationId": "Operations_List", + "description": "Returns the list of operations supported by the import/export resource provider.", + "x-ms-examples": { + "List available operations": { "$ref": "examples/ListOperations.json" } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + {"$ref": "#/parameters/api-version"}, + {"$ref": "#/parameters/Accept-Language"} + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ListOperationsResponse" } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } } - } } - } }, - "/providers/Microsoft.ImportExport/operations": { - "get": { - "tags": [ - "StorageImportExport" - ], - "operationId": "ListSupportedOperations", - "description": "Returns the list of operations supported by the import/export resource provider.", - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "description": "The supported operations were successfully retrieved and are in the response.", - "schema": { - "$ref": "#/definitions/SupportedOperationsListResult" + "definitions": { + "ErrorResponse":{ + "description": "Response when errors occurred", + "properties": { + "error":{ + "x-ms-client-flatten": true, + "description": "Describes the error information.", + "properties": { + "code":{ + "type": "string", + "description": "Provides information about the error code." + }, + "message":{ + "type": "string", + "description": "Provides information about the error message." + }, + "target":{ + "type": "string", + "description": "Provides information about the error target." + }, + "details":{ + "type": "array", + "description": "Describes the error details if present.", + "items": { + "properties": { + "code":{ + "type": "string", + "description": "Provides information about the error code." + }, + "target":{ + "type": "string", + "description": "Provides information about the error target." + }, + "message":{ + "type": "string", + "description": "Provides information about the error message." + } + } + } + }, + "innererror":{ + "type": "object", + "description": "Inner error object if present." + } + } + } } - }, - "default": { - "description": "An error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Resource":{ - "description": "The Resource model definition.", - "required": [ - "location" - ], - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Specifies the resource identifier of the job." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Specifies the name of the job." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Specifies the type of the job resource." - }, - "location": { - "type": "string", - "description": "Specifies the Azure location where the job is created." - }, - "tags": { - "type": "object", - "description": "Specifies the tags that are assigned to the job." - } - } - }, - "SupportedOperationsListResult": { - "description": "List of supported operations by the import/export resource provider.", - "properties": { - "value": { - "description": "List of supported operations by the import/export resource provider.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - } - } - } - }, - "BitLockerKeysListResult": { - "description": "List of BitLocker keys for the specified import/export job.", - "properties": { - "value": { - "description": "List of BitLocker keys for the specified import/export job.", - "type": "array", - "items": { - "$ref": "#/definitions/DriveStatus" - } - } - } - }, - "MoveJobParameters": { - "description": "Defines the parameters that need to be provided for moving an import/export job from one reesource group to another.", - "required": [ - "targetResourceGroup", - "resources" - ], - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "Specifies the target resource group ID to move the jobs to." - }, - "resources": { - "type": "array", - "description": "Specifies the list of jobs to move to the target resource group. The jobs must be from the current resource group from the request URL.", - "items": { - "type": "string" - } - } - } - }, - "LocationsListResult": { - "description": "List of locations.", - "required": [ - "value" - ], - "properties": { - "value": { - "description": "List of locations.", - "type": "array", - "items": { - "$ref": "#/definitions/Location" - } - } - } - }, - "ErrorBase": { - "description": "Describes the common properties of the Error object", - "properties": { - "code": { - "description": "Provides information about the error code.", - "type": "string" - }, - "message": { - "description": "Provides information about the error message.", - "type": "string" - }, - "target": { - "description": "Provides information about the error target.", - "type": "string" - } - } - }, - "ErrorInfo": { - "description": "Describes the error information.", - "properties": { - "details": { - "description": "Describes the error details if present.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorBase" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ErrorBase" - } - ] - }, - "ErrorResponse": { - "description": "Describes the model for Error Response.", - "properties": { - "error": { - "description": "Describes the error information", - "$ref": "#/definitions/ErrorInfo" - } - } - }, - "MutableJobProperties":{ - "description": "Properties of the job that can be updated.", - "properties": { - "cancelRequested": { - "type": "boolean", - "description": "If specified, the value must be true. The service will attempt to cancel the job." - }, - "state": { - "type": "string", - "description": "If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail.", - "enum": [ "Shipping" ], - "x-ms-enum": { - "name": "MutableJobState", - "modelAsString": true - } - }, - "returnAddress": { - "description": "Specifies the return address information for the job.", - "$ref": "#/definitions/ReturnAddress" - }, - "returnShipping": { - "description": "Specifies the return carrier and customer's account with the carrier.", - "$ref": "#/definitions/ReturnShipping" - }, - "deliveryPackage": { - "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", - "$ref": "#/definitions/PackageInfomation" - }, - "logLevel": { - "type": "string", - "description": "Indicates whether error logging or verbose logging is enabled." }, - "backupDriveManifest": { - "type": "boolean", - "description": "Indicates whether the manifest files on the drives should be copied to block blobs." - } - } - }, - "MutableJob": { - "description": "Describes the updatable properties of the job", - "properties": { - "tags": { - "type": "object" - }, - "properties": { - "description": "Specifies the properties of an UpdateJob.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/MutableJobProperties" - } - } - }, - "JobListResult": { - "description": "List of import/export jobs.", - "required": [ - "value" - ], - "properties": { - "nextLink": { - "type": "string" - }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Job" - } - } - } - }, - "JobProperties": { - "description": "Import/export job specific properties.", - "required": [ - "storageAccountId", - "jobType", - "returnAddress", - "returnShipping", - "diagnosticsPath" - ], - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource identifier of the storage account where data will be imported to or exported from." - }, - "containerSas": { - "type": "string", - "description": "The container shared access signature (SAS) to be used to import or export data to or from the storage account." - }, - "jobType": { - "type": "string", - "description": "The type of job: Import or Export.", - "enum": [ "Import", "Export" ], - "x-ms-enum": { - "name": "JobType", - "modelAsString": false - } - }, - "returnAddress": { - "description": "Specifies the return address information for the job.", - "$ref": "#/definitions/ReturnAddress" - }, - "returnShipping": { - "description": "Specifies the return carrier and customer's account with the carrier.", - "$ref": "#/definitions/ReturnShipping" - }, - "shippingInformation": { - "readOnly": true, - "description": "Contains information about the Microsoft datacenter to which the drives should be shipped.", - "$ref": "#/definitions/ShippingInformation" + "PutJobParameters":{ + "description": "Put Job parameters", + "properties": { + "location":{ + "type": "string", + "description": "Specifies the supported Azure location where the job should be created" + }, + "tags":{ + "type": "object", + "description": "Specifies the tags that will be assigned to the job." + }, + "properties": { + "$ref": "#/definitions/JobDetails", + "description": "Specifies the job properties" + } + } }, - "deliveryPackage": { - "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", - "$ref": "#/definitions/PackageInfomation" + "JobDetails":{ + "description": "Specifies the job properties", + "properties": { + "storageAccountId":{ + "type": "string", + "description": "The resource identifier of the storage account where data will be imported to or exported from." + }, + "jobType":{ + "type": "string", + "description": "The type of job" + }, + "returnAddress":{ + "description": "Specifies the return address information for the job. ", + "$ref": "#/definitions/ReturnAddress" + }, + "returnShipping":{ + "description": "Specifies the return carrier and customer's account with the carrier. ", + "$ref": "#/definitions/ReturnShipping" + }, + "shippingInformation":{ + "description": "Contains information about the Microsoft datacenter to which the drives should be shipped. ", + "$ref": "#/definitions/ShippingInformation" + }, + "deliveryPackage":{ + "description": "Contains information about the package being shipped by the customer to the Microsoft data center. ", + "$ref": "#/definitions/PackageInfomation" + }, + "returnPackage":{ + "description": "Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. ", + "$ref": "#/definitions/PackageInfomation" + }, + "diagnosticsPath":{ + "type": "string", + "description": "The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored." + }, + "logLevel":{ + "type": "string", + "description": "Default value is Error. Indicates whether error logging or verbose logging will be enabled." + }, + "backupDriveManifest":{ + "type": "boolean", + "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs." + }, + "state":{ + "type": "string", + "description": "Current state of the job." + }, + "cancelRequested":{ + "type": "boolean", + "description": "Indicates whether a request has been submitted to cancel the job." + }, + "percentComplete":{ + "type": "integer", + "description": "Overall percentage completed for the job." + }, + "incompleteBlobListUri":{ + "type": "string", + "description": "A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response." + }, + "driveList":{ + "description": "List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/DriveStatus" + } + }, + "export":{ + "description": "A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.", + "$ref": "#/definitions/Export" + }, + "provisioningState":{ + "type": "string", + "description": "Specifies the provisioning state of the job." + } + } }, - "returnPackage": { - "readOnly": true, - "description": "Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.", - "$ref": "#/definitions/PackageInfomation" + "UpdateJobParameters":{ + "description": "Update Job parameters", + "properties": { + "tags":{ + "type": "object", + "description": "Specifies the tags that will be assigned to the job" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "cancelRequested":{ + "type": "boolean", + "description": "If specified, the value must be true. The service will attempt to cancel the job. " + }, + "state":{ + "type": "string", + "description": "If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. " + }, + "returnAddress":{ + "description": "Specifies the return address information for the job.", + "$ref": "#/definitions/ReturnAddress" + }, + "returnShipping":{ + "description": "Specifies the return carrier and customer's account with the carrier.", + "$ref": "#/definitions/ReturnShipping" + }, + "deliveryPackage":{ + "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", + "$ref": "#/definitions/PackageInfomation" + }, + "logLevel":{ + "type": "string", + "description": "Indicates whether error logging or verbose logging is enabled." + }, + "backupDriveManifest":{ + "type": "boolean", + "description": "Indicates whether the manifest files on the drives should be copied to block blobs." + }, + "driveList":{ + "description": "List of drives that comprise the job.", + "type": "array", + "items": { + "$ref": "#/definitions/DriveStatus" + } + } + }, + "description": "Specifies the properties of a UpdateJob." + } + } }, - "diagnosticsPath": { - "type": "string", - "description": "The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored." + "ListJobsResponse":{ + "description": "List jobs response", + "properties": { + "nextLink":{ + "type": "string", + "description": "link to next batch of jobs" + }, + "value":{ + "type": "array", + "description": "Job list", + "items":{ + "$ref": "#/definitions/JobResponse" + } + } + } }, - "logLevel": { - "type": "string", - "description": "Default value is Error. Indicates whether error logging or verbose logging will be enabled.", - "default": "Error", - "enum": [ "Error", "Verbose" ], - "x-ms-enum": { - "name": "LogLevel", - "modelAsString": true - } + "JobResponse":{ + "x-ms-azure-resource": true, + "description": "Contains the job information.", + "properties": { + "id":{ + "type": "string", + "description": "Specifies the resource identifier of the job.", + "readOnly": true + }, + "name":{ + "type": "string", + "description": "Specifies the name of the job.", + "readOnly": true + }, + "type":{ + "type": "string", + "description": "Specifies the type of the job resource.", + "readOnly": true + }, + "location":{ + "type": "string", + "description": "Specifies the Azure location where the job is created." + }, + "tags":{ + "type": "object", + "description": "Specifies the tags that are assigned to the job." + }, + "properties": { + "$ref": "#/definitions/JobDetails", + "description": "Specifies the job properties" + } + } }, - "backupDriveManifest": { - "type": "boolean", - "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.", - "default": false + "Operation":{ + "description": "Describes a supported operation by the Storage Import/Export job API.", + "required": ["name", "display"], + "properties": { + "name":{ + "type": "string", + "description": "Name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "description": "operation display properties", + "properties": { + "provider":{ + "type": "string", + "description": "The resource provider name to which the operation belongs." + }, + "resource":{ + "type": "string", + "description": "The name of the resource to which the operation belongs." + }, + "operation":{ + "type": "string", + "description": "The display name of the operation." + }, + "description":{ + "type": "string", + "description": "Short description of the operation." + } + } + } + } }, - "state": { - "type": "string", - "readOnly": true, - "description": "Current state of the job.", - "enum": [ "Creating", "Shipping", "Received", "Transferring", "Packaging", "Closed", "Completed" ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": true - } + "Location":{ + "description": "Provides information about an Azure data center location.", + "properties": { + "id":{ + "description": "Specifies the resource identifier of the location. ", + "type": "string" + }, + "name":{ + "description": "Specifies the name of the location. Use List Locations to get all supported locations. ", + "type": "string" + }, + "type":{ + "description": "Specifies the type of the location. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "location properties", + "properties": { + "recipientName":{ + "description": "The recipient name to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "streetAddress1":{ + "description": "The first line of the street address to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "streetAddress2":{ + "description": "The second line of the street address to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "city":{ + "description": "The city name to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "stateOrProvince":{ + "description": "The state or province to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "postalCode":{ + "description": "The postal code to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "countryOrRegion":{ + "description": "The country or region to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "phone":{ + "description": "The phone number for the Azure data center. ", + "type": "string" + }, + "supportedCarriers":{ + "type": "array", + "description": "A list of carriers that are supported at this location. ", + "items":{ + "type": "string" + } + }, + "alternateLocations":{ + "type": "array", + "description": "A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ", + "items":{ + "type": "string" + } + } + } + } + } }, - "cancelRequested": { - "type": "boolean", - "description": "Indicates whether a request has been submitted to cancel the job." + "ReturnAddress": { + "description": "Specifies the return address information for the job.", + "required": [ + "recipientName", + "streetAddress1", + "city", + "postalCode", + "countryOrRegion", + "phone", + "email" + ], + "properties": { + "recipientName": { + "type": "string", + "description": "The name of the recipient who will receive the hard drives when they are returned. " + }, + "streetAddress1": { + "type": "string", + "description": "The first line of the street address to use when returning the drives. " + }, + "streetAddress2": { + "type": "string", + "description": "The second line of the street address to use when returning the drives. " + }, + "city": { + "type": "string", + "description": "The city name to use when returning the drives." + }, + "stateOrProvince": { + "type": "string", + "description": "The state or province to use when returning the drives." + }, + "postalCode": { + "type": "string", + "description": "The postal code to use when returning the drives." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region to use when returning the drives. " + }, + "phone": { + "type": "string", + "description": "Phone number of the recipient of the returned drives." + }, + "email": { + "type": "string", + "description": "Email address of the recipient of the returned drives." + } + } }, - "percentComplete": { - "readOnly": true, - "type": "integer", - "description": "Overall percentage completed for the job." + "ReturnShipping":{ + "description": "Specifies the return carrier and customer's account with the carrier.", + "required": [ + "carrierName", + "carrierAccountNumber" + ], + "properties": { + "carrierName": { + "type": "string", + "description": "The carrier's name." + }, + "carrierAccountNumber": { + "type": "string", + "description": "The customer's account number with the carrier." + } + } }, - "incompleteBlobListUri": { - "readOnly": true, - "type": "string", - "description": "A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response." + "ShippingInformation":{ + "description": "Contains information about the Microsoft datacenter to which the drives should be shipped.", + "required": [ + "recipientName", + "streetAddress1", + "city", + "stateOrProvince", + "postalCode", + "countryOrRegion" + ], + "properties": { + "recipientName": { + "type": "string", + "description": "The name of the recipient who will receive the hard drives when they are returned. " + }, + "streetAddress1": { + "type": "string", + "description": "The first line of the street address to use when returning the drives. " + }, + "streetAddress2": { + "type": "string", + "description": "The second line of the street address to use when returning the drives. " + }, + "city": { + "type": "string", + "description": "The city name to use when returning the drives." + }, + "stateOrProvince": { + "type": "string", + "description": "The state or province to use when returning the drives." + }, + "postalCode": { + "type": "string", + "description": "The postal code to use when returning the drives." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region to use when returning the drives. " + }, + "phone": { + "type": "string", + "description": "Phone number of the recipient of the returned drives." + } + } }, - "driveList": { - "description": "List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/DriveStatus" - }, - "minItems": 0, - "maxItems": 10 + "PackageInfomation":{ + "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", + "required": [ + "carrierName", + "trackingNumber", + "driveCount", + "shipDate" + ], + "properties": { + "carrierName": { + "type": "string", + "description": "The name of the carrier that is used to ship the import or export drives." + }, + "trackingNumber": { + "type": "string", + "description": "The tracking number of the package." + }, + "driveCount": { + "type": "integer", + "description": "The number of drives included in the package." + }, + "shipDate": { + "type": "string", + "description": "The date when the package is shipped." + } + } }, - "export": { - "description": "A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.", - "$ref": "#/definitions/Export" + "DriveStatus":{ + "description": "Provides information about the drive's status", + "properties": { + "driveId": { + "type": "string", + "description": "The drive's hardware serial number, without spaces." + }, + "bitLockerKey": { + "type": "string", + "description": "The BitLocker key used to encrypt the drive." + }, + "manifestFile": { + "type": "string", + "description": "The relative path of the manifest file on the drive. " + }, + "manifestHash": { + "type": "string", + "description": "The Base16-encoded MD5 hash of the manifest file on the drive." + }, + "driveHeaderHash": { + "type": "string", + "description": "The drive header hash value." + }, + "state":{ + "type": "string", + "description": "The drive's current state. ", + "enum": [ "Specified", "Received", "NeverReceived", "Transferring", "Completed", "CompletedMoreInfo", "ShippedBack" ], + "x-ms-enum": { + "name": "DriveState", + "modelAsString": true + } + }, + "copyStatus":{ + "type": "string", + "description": "Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state." + }, + "percentComplete":{ + "type": "integer", + "description": "Percentage completed for the drive. " + }, + "verboseLogUri":{ + "type": "string", + "description": "A URI that points to the blob containing the verbose log for the data transfer operation. " + }, + "errorLogUri":{ + "type": "string", + "description": "A URI that points to the blob containing the error log for the data transfer operation." + }, + "manifestUri":{ + "type": "string", + "description": "A URI that points to the blob containing the drive manifest file. " + }, + "bytesSucceeded": { + "type": "integer", + "format": "int64", + "description": "Bytes successfully transferred for the drive." + } + } }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Specifies the provisioning state of the job." - } - } - }, - "Job": { - "description": "Describes an import/export job.", - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Import/export job properties.", - "$ref": "#/definitions/JobProperties", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "OperationDisplayInformation": { - "description": "Display information about the operation.", - "properties": { - "provider": { - "description": "The resource provider name to which the operation belongs.", - "type": "string" + "Export": { + "description": "A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.", + "properties":{ + "blobList":{ + "description": "A list of the blobs to be exported.", + "x-ms-client-flatten": true, + "properties": { + "blobPath": { + "type": "array", + "description":"A collection of blob-path strings.", + "items": { + "type": "string" + } + }, + "blobPathPrefix":{ + "type": "array", + "description":"A collection of blob-prefix strings.", + "items": { + "type": "string" + } + } + } + }, + "blobListblobPath":{ + "type": "string", + "description": "The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. " + } + } }, - "resource": { - "description": "The name of the resource to which the operation belongs.", - "type": "string" + "LocationsResponse": { + "description": "Locations response", + "properties": { + "value":{ + "type": "array", + "description": "locations", + "items":{ + "$ref": "#/definitions/Location" + } + } + } }, - "operation": { - "description": "The display name of the operation.", - "type": "string" + "GetBitLockerKeysResponse": { + "description": "GetBitLockerKeys response", + "properties": { + "value":{ + "type": "array", + "description": "drive status", + "items":{ + "$ref": "#/definitions/DriveBitLockerKey" + } + } + } }, - "description": { - "description": "Short description of the operation.", - "type": "string" - } - } - }, - "Operation": { - "description": "Describes a supported operation by the Storage Import/Export job API.", - "required": ["name", "display"], - "properties": { - "name": { - "description": "Name of the operation.", - "type": "string" + "DriveBitLockerKey": { + "description": "BitLocker recovery key or password to the specified drive", + "properties": { + "bitLockerKey": { + "type": "string", + "description": "BitLocker recovery key or password" + }, + "driveId": { + "type": "string", + "description": "Drive ID" + } + } }, - "display": { - "description": "Display information about the operation.", - "$ref": "#/definitions/OperationDisplayInformation", - "x-ms-client-flatten": true + "ListOperationsResponse": { + "description": "List operations response", + "properties": { + "value":{ + "type": "array", + "description": "operations", + "items":{ + "$ref": "#/definitions/Operation" + } + } + } } - } }, - "LocationProperties": { - "description": "Describes the properties of a location.", - "properties": { - "recipientName": { - "description": "The recipient name to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "streetAddress1": { - "description": "The first line of the street address to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "streetAddress2": { - "description": "The second line of the street address to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "city": { - "description": "The city name to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "stateOrProvince": { - "description": "The state or province to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "postalCode": { - "description": "The postal code to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "countryOrRegion": { - "description": "The country or region to use when shipping the drives to the Azure data center.", - "type": "string" - }, - "phone": { - "description": "The phone number for the Azure data center.", - "type": "string" - }, - "supportedCarriers": { - "type": "array", - "description": "A list of carriers that are supported at this location.", - "items": { - "type": "string" - } + "parameters":{ + "api-version":{ + "name": "api-version", + "in": "query", + "description": "Specifies the API version to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2016-11-01" + ] }, - "alternateLocations": { - "type": "array", - "description": "A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations.", - "items": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID for the Azure user.", + "required": true, "type": "string" - } - } - } - }, - "Location": { - "description": "Provides information about an Azure data center location.", - "properties": { - "id": { - "description": "Specifies the resource identifier of the location.", - "type": "string" - }, - "name": { - "description": "Specifies the name of the location. Use List Locations to get all supported locations.", - "type": "string" - }, - "type": { - "description": "Specifies the resource type of the location.", - "type": "string" - }, - "properties": { - "description": "Describes the properties of a location.", - "$ref": "#/definitions/LocationProperties", - "x-ms-client-flatten": true - } - } - }, - "ReturnAddress": { - "description": "Specifies the return address information for the job.", - "required": [ - "recipientName", - "streetAddress1", - "city", - "postalCode", - "countryOrRegion", - "phone", - "email" - ], - "properties": { - "recipientName": { - "type": "string", - "description": "The name of the recipient who will receive the hard drives when they are returned." - }, - "streetAddress1": { - "type": "string", - "description": "The first line of the street address to use when returning the drives." - }, - "streetAddress2": { - "type": "string", - "description": "The second line of the street address to use when returning the drives." - }, - "city": { - "type": "string", - "description": "The city name to use when returning the drives." - }, - "stateOrProvince": { - "type": "string", - "description": "The state or province to use when returning the drives." - }, - "postalCode": { - "type": "string", - "description": "The postal code to use when returning the drives." - }, - "countryOrRegion": { - "type": "string", - "description": "The country or region to use when returning the drives." }, - "phone": { - "type": "string", - "description": "Phone number of the recipient of the returned drives." - }, - "email": { - "type": "string", - "description": "Email address of the recipient of the returned drives." - } - } - }, - "ReturnShipping": { - "description": "Specifies the return carrier and customer's account with the carrier.", - "required": [ - "carrierName", - "carrierAccountNumber" - ], - "properties": { - "carrierName": { - "type": "string", - "description": "The carrier's name." - }, - "carrierAccountNumber": { - "type": "string", - "description": "The customer's account number with the carrier." - } - } - }, - "ShippingInformation": { - "description": "Provides information about the Microsoft datacenter to which the drives should be shipped.", - "required": [ - "name", - "address" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the recipient at the datacenter." - }, - "address": { - "type": "string", - "description": "The address of the datacenter." - } - } - }, - "PackageInfomation": { - "description": "Provides information about the package being shipped by the customer to the Microsoft data center.", - "required": [ - "carrierName", - "trackingNumber", - "driveCount", - "shipDate" - ], - "properties": { - "carrierName": { - "type": "string", - "description": "The name of the carrier that is used to ship the import or export drives." - }, - "trackingNumber": { - "type": "string", - "description": "The tracking number of the package." - }, - "driveCount": { - "type": "integer", - "description": "The number of drives included in the package." - }, - "shipDate": { - "type": "string", - "description": "The date the package is shipped." - } - } - }, - "Drive": { - "description": "Provides information about the drive that contains information about the import/export jobs.", - "required": [ - "driveId", - "bitLockerKey", - "manifestFile", - "manifestHash" - ], - "properties": { - "driveId": { - "type": "string", - "description": "The drive's hardware serial number, without spaces." - }, - "bitLockerKey": { - "type": "string", - "description": "The BitLocker key used to encrypt the drive." - }, - "manifestFile": { - "type": "string", - "description": "The relative path of the manifest file on the drive." - }, - "manifestHash": { - "type": "string", - "description": "The Base16-encoded MD5 hash of the manifest file on the drive." - } - } - }, - "DriveStatus": { - "description": "Provides information about the drive's status.", - "properties": { - "state": { - "type": "string", - "description": "The drive's current state.", - "enum": [ "Specified", "Received", "NeverReceived", "Transferring", "Completed", "CompletedMoreInfo", "ShippedBack" ], - "x-ms-enum": { - "name": "DriveState", - "modelAsString": true - } - }, - "copyStatus": { - "type": "string", - "description": "Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state." - }, - "percentComplete": { - "type": "integer", - "description": "Percentage completed for the drive." - }, - "verboseLogUri": { - "type": "string", - "description": "A URI that points to the blob containing the verbose log for the data transfer operation." - }, - "errorLogUri": { - "type": "string", - "description": "A URI that points to the blob containing the error log for the data transfer operation." + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name uniquely identifies the resource group within the user subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" }, - "manifestUri": { - "type": "string", - "description": "A URI that points to the blob containing the drive manifest file." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Drive" - } - ] - }, - "Export": { - "description": "A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.", - "properties": { - "blobList": { - "description": "A list of the blobs to be exported.", - "x-ms-client-flatten": true, - "properties": { - "blobPath": { - "type": "array", - "description": "A collection of blob-path strings.", - "items": { - "type": "string" - } - }, - "blobPathPrefix": { - "type": "array", - "description": "A collection of blob-prefix strings.", - "items": { - "type": "string" - } - } - } + "Accept-Language":{ + "name": "Accept-Language", + "in": "header", + "description": "Specifies the preferred language for the response.", + "required": false, + "type": "string" }, - "blobListblobPath": { - "type": "string", - "description": "The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in the root container, the URI must begin with $root." + "x-ms-client-tenant-id":{ + "name": "x-ms-client-tenant-id", + "in": "header", + "description": "The tenant ID of the client making the request.", + "required": false, + "type": "string", + "x-ms-client-name": "ClientTenantId", + "x-ms-parameter-location": "method" } - } - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "Specifies the API version to use for this request.", - "required": true, - "type": "string", - "enum": [ - "2016-11-01" - ] - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID for the Azure user.", - "required": true, - "type": "string" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name uniquely identifies the resource group within the user subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Accept-Language": { - "name": "Accept-Language", - "in": "header", - "description": "Specifies the preferred language for the response.", - "required": true, - "type": "string", - "enum": [ - "en-us" - ] + } - } -} +} \ No newline at end of file