diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json new file mode 100644 index 000000000000..a3377ac231ef --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json @@ -0,0 +1,2157 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "DataBoxManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBox/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the subscription.", + "operationId": "Jobs_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs available under the subscription.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsList": { + "$ref": "./examples/JobsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { + "post": { + "tags": [ + "Service" + ], + "description": "This method provides the list of available skus for the given subscription and location.", + "operationId": "Service_ListAvailableSkus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "availableSkuRequest", + "in": "body", + "description": "Filters for showing the available skus.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableSkuRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available skus.", + "schema": { + "$ref": "#/definitions/AvailableSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServiceListAvailableSkus": { + "$ref": "./examples/ServiceListAvailableSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { + "post": { + "tags": [ + "Service" + ], + "description": "This method validates the customer shipping address and provide alternate addresses if any.", + "operationId": "Service_ValidateAddress", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validateAddress", + "in": "body", + "description": "Shipping address of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateAddress" + } + } + ], + "responses": { + "200": { + "description": "The valid and alternate addresses.", + "schema": { + "$ref": "#/definitions/AddressValidationOutput" + } + } + }, + "x-ms-examples": { + "ServiceValidateAddress": { + "$ref": "./examples/ServiceValidateAddress.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs by resource group.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsListByResourceGroup": { + "$ref": "./examples/JobsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Gets information about the specified job.", + "operationId": "Jobs_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on details parameter for job, which provides details on the job stages.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.", + "operationId": "Jobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "jobResource", + "in": "body", + "description": "Job details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResource" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for create Job." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsCreate": { + "$ref": "./examples/JobsCreate.json" + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "description": "Deletes a job.", + "operationId": "Jobs_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Job deleted." + } + }, + "x-ms-examples": { + "JobsDelete": { + "$ref": "./examples/JobsDelete.json" + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "description": "Updates the properties of an existing job.", + "operationId": "Jobs_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "type": "string" + }, + { + "name": "jobResourceUpdateParameter", + "in": "body", + "description": "Job update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResourceUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for job updated." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsUpdate": { + "$ref": "./examples/JobsUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Book shipment pick up.", + "operationId": "Jobs_BookShipmentPickUp", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "shipmentPickUpRequest", + "in": "body", + "description": "Details of shipment pick up request.", + "required": true, + "schema": { + "$ref": "#/definitions/ShipmentPickUpRequest" + } + } + ], + "responses": { + "200": { + "description": "Booked shipment pick up successfully.", + "schema": { + "$ref": "#/definitions/ShipmentPickUpResponse" + } + } + }, + "x-ms-examples": { + "JobsBookShipmentPickUp": { + "$ref": "./examples/JobsBookShipmentPickUp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "CancelJob.", + "operationId": "Jobs_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "204": { + "description": "Job cancelled." + } + }, + "x-ms-examples": { + "JobsCancel": { + "$ref": "./examples/JobsCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/copyLogsUri": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Provides list of copy logs uri.", + "operationId": "Jobs_GetCopyLogsUri", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Copy logs uri.", + "schema": { + "$ref": "#/definitions/GetCopyLogsUriOutput" + } + } + }, + "x-ms-examples": { + "JobsGetCopyLogsUri": { + "$ref": "./examples/JobsGetCopyLogsUri.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/downloadShippingLabel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Get shipping label sas uri.", + "operationId": "Jobs_DownloadShippingLabelUri", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Shipping label sas uri.", + "schema": { + "$ref": "#/definitions/ShippingLabelDetails" + } + } + }, + "x-ms-examples": { + "JobsDownloadShippingLabelUri": { + "$ref": "./examples/JobsDownloadShippingLabelUri.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listSecrets": { + "post": { + "tags": [ + "Jobs" + ], + "description": "This method gets the unencrypted secrets related to the job.", + "operationId": "Jobs_ListSecrets", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unencrypted secrets of the job.", + "schema": { + "$ref": "#/definitions/UnencryptedSecrets" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "JobsListSecrets": { + "$ref": "./examples/JobsListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/reportIssue": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Reports an issue.", + "operationId": "Jobs_ReportIssue", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "reportIssueDetails", + "in": "body", + "description": "Details of reported issue.", + "required": true, + "schema": { + "$ref": "#/definitions/ReportIssueDetails" + } + } + ], + "responses": { + "204": { + "description": "Accepted issue report." + } + }, + "x-ms-examples": { + "JobsReportIssue": { + "$ref": "./examples/JobsReportIssue.json" + } + } + } + } + }, + "definitions": { + "AccountCopyLogDetails": { + "description": "Copy log details for an storage account", + "required": [ + "accountName", + "copyLogLink" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Destination account name.", + "type": "string" + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Pod" + }, + "AccountCredentialDetails": { + "description": "Credential details of the account.", + "required": [ + "shareCredentialDetails" + ], + "type": "object", + "properties": { + "accountName": { + "description": "Name of the account.", + "type": "string" + }, + "shareCredentialDetails": { + "description": "Per share level unencrypted access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/ShareCredentialDetails" + } + } + } + }, + "AddressValidationOutput": { + "description": "Output of the address validation api.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressValidationProperties", + "description": "The address validation properties.", + "x-ms-client-flatten": true + } + } + }, + "AddressValidationProperties": { + "description": "The address validation output.", + "type": "object", + "properties": { + "validationStatus": { + "description": "The address validation status.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsString": false + } + }, + "alternateAddresses": { + "description": "List of alternate addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/ShippingAddress" + } + } + } + }, + "ArmBaseObject": { + "description": "Base class for all objects under resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "AvailableSkuRequest": { + "description": "The filters for showing the available skus.", + "required": [ + "transferType", + "country", + "location" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsString": false + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + } + } + }, + "AvailableSkusResult": { + "description": "The available skus operation response.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of available skus.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + } + }, + "nextLink": { + "description": "Link for the next set of skus.", + "type": "string" + } + } + }, + "CabinetJobSecrets": { + "description": "The secrets related to a cabinet job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "cabinetPodSecrets": { + "description": "Contains the list of secret objects for a cabinet job.", + "type": "array", + "items": { + "$ref": "#/definitions/CabinetPodSecret" + } + } + }, + "x-ms-discriminator-value": "Cabinet" + }, + "CabinetPodSecret": { + "description": "The secrets related to a cabinet pod.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string" + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string" + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + } + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "ContactDetails": { + "description": "Contact Details.", + "required": [ + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "type": "array", + "items": { + "type": "string" + } + }, + "notificationPreference": { + "description": "Notification preference for a job stage.", + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + } + } + } + }, + "CopyLogDetails": { + "description": "Details for log generated during copy.", + "type": "object", + "properties": { + "copyLogDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "copyLogDetailsType" + }, + "CopyProgress": { + "description": "Copy progress.", + "type": "object", + "properties": { + "storageAccountName": { + "description": "Name of the storage account where the data needs to be uploaded.", + "type": "string" + }, + "bytesSentToCloud": { + "format": "int64", + "description": "Amount of data uploaded by the job as of now.", + "type": "integer" + }, + "totalBytesToProcess": { + "format": "int64", + "description": "Total amount of data to be processed by the job.", + "type": "integer" + } + } + }, + "DestinationAccountDetails": { + "description": "Details for the destination account.", + "required": [ + "accountId" + ], + "type": "object", + "properties": { + "accountId": { + "description": "Destination storage account id.", + "type": "string" + } + } + }, + "DestinationToServiceLocationMap": { + "description": "Map of destination location to service location", + "type": "object", + "properties": { + "destinationLocation": { + "description": "Location of the destination.", + "type": "string" + }, + "serviceLocation": { + "description": "Location of the service.", + "type": "string" + } + } + }, + "DiskCopyLogDetails": { + "description": "Copy Log Details for a disk", + "required": [ + "diskSerialNumber", + "errorLogLink", + "verboseLogLink" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "diskSerialNumber": { + "description": "Disk Serial Number.", + "type": "string" + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string" + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskCopyProgress": { + "description": "Disk Copy Progress", + "type": "object", + "properties": { + "serialNumber": { + "description": "The serial number of the disk", + "type": "string" + }, + "percentComplete": { + "format": "int32", + "description": "Indicates the percentage completed for the copy of the disk.", + "type": "integer" + }, + "status": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false + } + } + } + }, + "DiskJobDetails": { + "description": "Disk Job Details.", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "preferredDisks": { + "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "copyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskCopyProgress" + } + }, + "disksAndSizeDetails": { + "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskJobSecrets": { + "description": "The secrets related to disk job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "diskSecrets": { + "description": "Contains the list of secrets object for that device.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskSecret" + } + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskSecret": { + "description": "Contains all the secrets of a Disk.", + "type": "object", + "properties": { + "diskSerialNumber": { + "description": "Serial number of the assigned disk.", + "type": "string" + }, + "bitLockerKey": { + "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.", + "type": "string" + } + } + }, + "Error": { + "description": "Top level error for the job.", + "required": [ + "code" + ], + "type": "object", + "properties": { + "code": { + "description": "Error code that can be used to programmatically identify the error.", + "type": "string" + }, + "message": { + "description": "Describes the error in detail and provides debugging information.", + "type": "string" + } + } + }, + "GetCopyLogsUriOutput": { + "description": "Output for the GetCopyLogsUri.", + "type": "object", + "properties": { + "logType": { + "description": "Type/Level of the log.", + "type": "string" + }, + "copyLogDetails": { + "description": "List of copy log details.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyLogDetails" + } + } + } + }, + "JobDetails": { + "description": "Job details.", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "properties": { + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transfered in this job, in tera bytes.", + "type": "integer" + }, + "jobStages": { + "description": "List of stages that run in the job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobStages" + } + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "errorDetails": { + "description": "Error details for failure. This is optional.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "jobDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "jobDetailsType" + }, + "JobErrorDetails": { + "description": "Job Error Details for providing the information and recommended action.", + "type": "object", + "properties": { + "errorMessage": { + "description": "Message for the error.", + "type": "string" + }, + "errorCode": { + "format": "int32", + "description": "Code for the error.", + "type": "integer" + }, + "recommendedAction": { + "description": "Recommended action for the error.", + "type": "string" + }, + "exceptionMessage": { + "description": "Contains the non localized exception message", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job Properties", + "required": [ + "destinationAccountDetails" + ], + "type": "object", + "properties": { + "deviceType": { + "description": "Type of the device to be used for the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + }, + "isCancellable": { + "description": "Describes whether the job is cancellable or not.", + "type": "boolean" + }, + "isShippingAddressEditable": { + "description": "Describes whether the shipping address is editable or not.", + "type": "boolean" + }, + "status": { + "description": "Name of the stage which is in progress.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted" + ], + "type": "string", + "x-ms-enum": { + "name": "StageName", + "modelAsString": false + } + }, + "startTime": { + "format": "date-time", + "description": "Time at which the job was started in UTC ISO 8601 format.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Top level error for the job." + }, + "deliveryPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Delivery package shipping details." + }, + "returnPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Return package shipping details." + }, + "destinationAccountDetails": { + "description": "Destination account details.", + "type": "array", + "items": { + "$ref": "#/definitions/DestinationAccountDetails" + } + }, + "details": { + "$ref": "#/definitions/JobDetails", + "description": "Details of a job run. This field will only be sent for expand details filter." + }, + "cancellationReason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "JobResource": { + "description": "Job Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Properties of a job.", + "x-ms-client-flatten": true + }, + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "JobResourceList": { + "description": "Job Resource Collection", + "type": "object", + "properties": { + "value": { + "description": "List of job resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "JobResourceUpdateParameter": { + "description": "The JobResourceUpdateParameter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateJobProperties", + "description": "Properties of a job to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "JobSecrets": { + "description": "The base class for the secrets", + "type": "object", + "properties": { + "jobSecretsType": { + "description": "Used to indicate what type of job secrets object.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "jobSecretsType" + }, + "JobStages": { + "description": "Job stages.", + "required": [ + "stageName", + "stageStatus" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the job stage.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted" + ], + "type": "string", + "x-ms-enum": { + "name": "StageName", + "modelAsString": false + } + }, + "displayName": { + "description": "Display name of the job stage.", + "type": "string" + }, + "stageStatus": { + "description": "Status of the job stage.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "SucceededWithErrors" + ], + "type": "string", + "x-ms-enum": { + "name": "StageStatus", + "modelAsString": false + } + }, + "stageTime": { + "format": "date-time", + "description": "Time for the job stage in UTC ISO 8601 format.", + "type": "string" + }, + "jobStageDetails": { + "description": "Job Stage Details", + "type": "object" + }, + "errorDetails": { + "description": "Error details for the stage.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsString": false + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean" + } + } + }, + "Operation": { + "description": "Operation entity.", + "required": [ + "name", + "display", + "properties", + "origin" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Operation display values." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + }, + "origin": { + "description": "Origin of the operation. Can be : user|system|user,system", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Operation display", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name.", + "type": "string" + }, + "operation": { + "description": "Localized name of the operation for display purpose.", + "type": "string" + }, + "description": { + "description": "Localized description of the operation for display purpose.", + "type": "string" + } + } + }, + "OperationList": { + "description": "Operation Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "Link for the next set of operations.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "PackageShippingDetails": { + "description": "Shipping details.", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string" + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Url where shipment can be tracked.", + "type": "string" + } + } + }, + "PodJobDetails": { + "description": "Pod Job Details", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + } + } + }, + "x-ms-discriminator-value": "Pod" + }, + "PodJobSecrets": { + "description": "The secrets related to a pod job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "podSecrets": { + "description": "Contains the list of secret objects for a job.", + "type": "array", + "items": { + "$ref": "#/definitions/PodSecret" + } + } + }, + "x-ms-discriminator-value": "Pod" + }, + "PodSecret": { + "description": "The secrets related to a Pod.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string" + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string" + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + } + } + } + }, + "ReportIssueDetails": { + "description": "Details of the reported issue.", + "type": "object", + "properties": { + "issueType": { + "description": "Issue Type.", + "enum": [ + "DeviceMismatch", + "ValidationStringMismatch", + "CredentialNotWorking", + "DeviceFailure" + ], + "type": "string", + "x-ms-enum": { + "name": "IssueType", + "modelAsString": false + } + }, + "deviceIssueType": { + "description": "Device Issue Type. Only used for Device failure issue.", + "enum": [ + "DeviceTampering", + "DeviceNotBootingUp", + "DeviceHealthCheckShowFailures", + "NICsAreNotWorking", + "Misc" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceIssueType", + "modelAsString": false + } + } + } + }, + "Resource": { + "description": "Model of the Resource.", + "required": [ + "location", + "sku" + ], + "type": "object", + "properties": { + "location": { + "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + } + }, + "x-ms-azure-resource": true + }, + "ShareCredentialDetails": { + "description": "Credential details of the shares in account.", + "type": "object", + "properties": { + "shareName": { + "description": "Name of the share.", + "type": "string" + }, + "userName": { + "description": "User name for the share.", + "type": "string" + }, + "password": { + "description": "Password for the share.", + "type": "string" + } + } + }, + "ShipmentPickUpRequest": { + "description": "Shipment pick up request details.", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "shipmentLocation": { + "description": "Shipment Location in the pickup place. Eg.front desk", + "type": "string" + } + } + }, + "ShipmentPickUpResponse": { + "description": "Shipment pick up response.", + "type": "object", + "properties": { + "confirmationNumber": { + "description": "Confirmation number for the pick up request.", + "type": "string" + }, + "readyByTime": { + "format": "date-time", + "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.", + "type": "string" + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "streetAddress1", + "country", + "postalCode" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsString": false + } + } + } + }, + "ShippingLabelDetails": { + "description": "Details for the shipping label.", + "required": [ + "shippingLabelSasUri" + ], + "type": "object", + "properties": { + "shippingLabelSasUri": { + "description": "Sas uri for accessing the shipping label.", + "type": "string" + } + } + }, + "Sku": { + "description": "The Sku.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "type": "string" + }, + "displayName": { + "description": "The display name of the sku.", + "type": "string" + }, + "family": { + "description": "The sku family.", + "type": "string" + } + } + }, + "SkuCapacity": { + "description": "Capacity of the sku.", + "required": [ + "usable", + "maximum" + ], + "type": "object", + "properties": { + "usable": { + "description": "Usable capacity in TB.", + "type": "string" + }, + "maximum": { + "description": "Maximum capacity in TB.", + "type": "string" + } + } + }, + "SkuCost": { + "description": "Describes metadata for retrieving price info.", + "required": [ + "meterId", + "meterType" + ], + "type": "object", + "properties": { + "meterId": { + "description": "Meter id of the Sku.", + "type": "string" + }, + "meterType": { + "description": "The type of the meter.", + "type": "string" + } + } + }, + "SkuInformation": { + "description": "Information of the sku.", + "required": [ + "sku", + "enabled", + "properties" + ], + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The Sku." + }, + "enabled": { + "description": "The sku is enabled or not.", + "type": "boolean" + }, + "properties": { + "$ref": "#/definitions/SkuProperties", + "description": "Properties of the sku.", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "Properties of the sku.", + "required": [ + "capacity", + "costs", + "apiVersions" + ], + "type": "object", + "properties": { + "destinationToServiceLocationMap": { + "description": "The map of destination location to service location.", + "type": "array", + "items": { + "$ref": "#/definitions/DestinationToServiceLocationMap" + } + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Capacity of the Sku." + }, + "costs": { + "description": "Cost of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + } + }, + "apiVersions": { + "description": "Api versions that support this Sku.", + "type": "array", + "items": { + "type": "string" + } + }, + "disabledReason": { + "description": "Reason why the Sku is disabled.", + "type": "string" + } + } + }, + "UnencryptedSecrets": { + "description": "Unencrypted secrets for accessing device.", + "required": [ + "jobName" + ], + "type": "object", + "properties": { + "jobName": { + "description": "Name of the job.", + "type": "string" + }, + "deviceType": { + "description": "The Device Type used in the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + }, + "jobSecrets": { + "$ref": "#/definitions/JobSecrets", + "description": "Secrets related to this job." + } + } + }, + "UpdateJobDetails": { + "description": "Job details for update.", + "type": "object", + "properties": { + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + } + } + }, + "UpdateJobProperties": { + "description": "Job Properties for update", + "required": [ + "details" + ], + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/UpdateJobDetails", + "description": "Details of a job to be updated." + } + } + }, + "ValidateAddress": { + "description": "The requirements to validate customer address where the device needs to be shipped.", + "type": "object", + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API Version", + "required": true, + "type": "string" + }, + "jobNameParameter": { + "name": "jobName", + "in": "path", + "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The Resource Group Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Subscription Id", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json new file mode 100644 index 000000000000..6d714c782bc2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01", + "shipmentPickUpRequest": { + "startTime": "2018-04-15T18:30:00Z", + "endTime": "2018-04-17T18:30:00Z", + "shipmentLocation": "Front desk" + } + }, + "responses": { + "200": { + "body": { + "confirmationNumber": "2929602E9CP", + "readyByTime": "2023-04-19T00:00:00Z" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json new file mode 100644 index 000000000000..aa6aee09f5ac --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details", + "cancellationReason": { + "reason": "CancelTest" + } + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json new file mode 100644 index 000000000000..8383e15ec753 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "jobResource": { + "properties": { + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ], + "details": { + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + } + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json new file mode 100644 index 000000000000..dbaf09e74212 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json new file mode 100644 index 000000000000..e5a8a9d34663 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "shippingLabelSasUri": "https://wusintd2cis2secx0fo9.blob.core.windows.net/dummycontainer/1Z12345E8791315509.PDF?sv=2016-05-31&sr=b&sig=ijNPoWPcbt0BNxTCK9p6nta4jsOr2hzJpgWyyE7AU0k%3D&st=2018-04-16T04%3A42%3A31Z&se=2018-04-16T05%3A12%3A31Z&sp=r" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json new file mode 100644 index 000000000000..c0aecc1b7796 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ], + "details": { + "copyProgress": [ + { + "storageAccountName": "kvtestwus", + "bytesSentToCloud": 0, + "totalBytesToProcess": 0 + } + ], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2018-04-13T16:28:41.1669459+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "errorDetails": [] + } + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json new file mode 100644 index 000000000000..bdf4cc32c8d0 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "copyLogDetails": [ + { + "accountName": "devicemanagertest1", + "copyLogLink": "test1234", + "copyLogDetailsType": "Pod" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json new file mode 100644 index 000000000000..cf18a05a7fe2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2017-06-15T10:31:21.3912273+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/2c3771b6-6239-464c-9973-7995b0f45a6b/resourceGroups/CloudServiceCisVaultST14113BRS/providers/Microsoft.Storage/storageAccounts/devicemanagertest1" + } + ], + "cancellationReason": "Old job which is still in ordered state cancelled by the service" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhat-test", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhat-test", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2017-06-23T15:19:15.4076847+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/2c3771b6-6239-464c-9973-7995b0f45a6b/resourceGroups/CloudServiceCisVaultST14113BRS/providers/Microsoft.Storage/storageAccounts/devicemanagertest1" + } + ], + "cancellationReason": "Old job which is still in ordered state cancelled by the service" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhat-test-Clone", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhat-test-Clone", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2018-03-19T19:29:50.3094441+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/fgsdfgdfgsdfg/providers/Microsoft.Storage/storageAccounts/aaadsfdblob" + } + ], + "cancellationReason": "test job" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhatjob-testcancel", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhatjob-testcancel", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Completed", + "startTime": "2018-04-10T13:35:54.463846+05:30", + "deliveryPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "returnPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/abbhattestRG/providers/Microsoft.Storage/storageAccounts/abbhattest2" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattest10Apr", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattest10Apr", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-10T20:43:52.0776009+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/sunil/providers/Microsoft.Storage/storageAccounts/111sunilais" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattest10Apr2", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattest10Apr2", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Completed", + "startTime": "2018-04-10T22:16:02.9830109+05:30", + "deliveryPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "returnPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/abbhat-RG/providers/Microsoft.Storage/storageAccounts/abbhattest" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattestApr10-2", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattestApr10-2", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Disk", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-12T18:27:08.0966918+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/sunil/providers/Microsoft.Storage/storageAccounts/111sunilais" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "name": "AndiDisk12April-Clone", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/AndiDisk12April-Clone", + "type": "Microsoft.DataBox/jobs" + } + ], + "nextLink": "https://management.azure.com/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/providers/Microsoft.DataBox/jobs?api-version=2018-01-01&%24skiptoken=7VVdb5swFP0v0banJQEKKVSqpnwATQQ04cuBN4wJMdhAA4GQqv99bqN11bRV2tP2UMkPtu%2f1ucf3%2bvg%2bDork1Bi4yOvBzeMAqI7rOYObwb5pqvpmPKZREaUJTYpmFJ2Ph2QUl3RcH2EdH3DV4LKox1fxZIIigR9OuOtkKCpQHMoQ7YY7QdpBKO%2buOWk3rg5li1FyqMcmjg9lXe6a0SJqoll5GmclrL9FFR62zM4gbwWOl4ccz8aXT3WOK7fMk%2bJ2vVBECLoUUb%2bPBdLCjMOmI3ZLPCOQWm2ok2N45jDa2tRwVWGZyZ8FuNiU8kZQjohZEdC4CChHX1cOIRAv1nS5OC2gIDGLxAdbu2JzDwoNgZlozfE0Xc6nsv8aU%2byNbCobfEjiwmK%2bryjzabrWbCnWPYbr6xqGusf8fuwwHs9I6VqVSHJnb4Ltiosu0Yxwm7MzpqOygJpl5lzvUt6JVP7B3tr3Ua6eATE7U1W2jjszfX1fgRyFSKseHFeLoFdVLodCk%2bNVn%2fJBkq9oQFAdUau531bYJGXn6gxPt%2b9sSrAp7KnrBVIMlr1TlLLB%2fYnRL5wdeIV%2bcuUtrGXQDydBZoHEz3u%2fsEOgrq4CP%2bYh2U82NMwgsF9iRRppHKqEQFtJIFNFxKe9CfaRo63q4GzZhtu1LvVFpK1axDUkcd%2fkXtf6UPA5V1eyS32ec%2b7drSoItD5hJ1m2f%2bPxwn7Rte9Wn93eamHBql74e%2fZGWkjsNhL84zr9fIXYGHx9EcVctVx7anxo40MbF7W%2bqw3hfv4X2gD20ctm2MzIORD4LNEu2mHrE%2fBRjcCmdzMtM4uZAECl%2fddaedWJ6k3Xb%2fpIVSL2odd1QvlRHPejuinZX08rkow6XKCyq%2f9Fexk8PX0H" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json new file mode 100644 index 000000000000..98dbe476ce58 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json new file mode 100644 index 000000000000..425d3fc73e2e --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "jobName": "sdktest5497", + "deviceType": "Pod", + "jobSecrets": { + "podSecrets": [ + { + "deviceSerialNumber": "abbhatipv1epd", + "devicePassword": "GN7$gt]W9", + "accountCredentialDetails": [ + { + "accountName": "devicemanagertest1", + "shareCredentialDetails": [ + { + "shareName": "devicemanagertest1_PageBlob", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + }, + { + "shareName": "devicemanagertest1_BlockBlob", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + }, + { + "shareName": "devicemanagertest1_AzFile", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + } + ] + } + ] + } + ], + "jobSecretsType": "Pod" + } + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json new file mode 100644 index 000000000000..96e42eae7f9e --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01", + "reportIssueDetails": { + "issueType": "DeviceFailure", + "deviceIssueType": "DeviceNotBootingUp" + } + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json new file mode 100644 index 000000000000..94c4d4ceede6 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details", + "jobResourceUpdateParameter": { + "properties": { + "details": { + "contactDetails": { + "contactName": "Update Job", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + } + } + } + } + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json new file mode 100644 index 000000000000..211756f55ce4 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBox/jobs/listSecrets/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Secrets", + "description": "Lists the unencrypted secrets related to the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/cancel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Cancel", + "description": "Cancels an order in progress." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/reportIssue/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Report Issue", + "description": "Reports an issue in the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/copyLogsUri/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Copy Log URL", + "description": "Get URL for the copy logs of each destination account." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/downloadShippingLabel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Download Shipping Label", + "description": "Get shipping label for the return shipment." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Book Shipment Pick Up", + "description": "Allows to book a pick up for return shipments." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/read", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Orders", + "description": "List or get the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/delete", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Delete Orders", + "description": "Delete the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/write", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Create or Update Orders", + "description": "Create or update the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateAddress/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Address", + "operation": "Validate Address", + "description": "Validates the shipping address and provides alternate addresses if any." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/regionAvailability/action", + "display": { + "provider": "Azure Data Box", + "resource": "Region Availability", + "operation": "Region Availability", + "description": "This method returns the list of supported regions for the service and for destination storage accounts." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/action", + "display": { + "provider": "Azure Data Box", + "resource": "ArmApiRes_availableSkus" + }, + "properties": {}, + "origin": "user" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json new file mode 100644 index 000000000000..bd7da8ef54b1 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "location": "westus", + "api-version": "2018-01-01", + "availableSkuRequest": { + "country": "US", + "location": "westus", + "transferType": "ImportToAzure" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "DataBox" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "80", + "maximum": "100" + }, + "costs": [ + { + "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", + "meterType": "DataBoxServiceFee" + }, + { + "meterId": "a701f058-119b-4713-a923-bed7da4b7801", + "meterType": "DataBoxShippingFee" + } + ], + "apiVersions": [ + "2018-01-01" + ] + } + }, + { + "sku": { + "name": "DataBoxDisk" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "18", + "maximum": "20" + }, + "costs": [], + "apiVersions": [ + "2018-01-01" + ] + } + }, + { + "sku": { + "name": "DataBoxCabinet" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "800", + "maximum": "1000" + }, + "costs": [], + "apiVersions": [ + "2018-01-01" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json new file mode 100644 index 000000000000..5c6b716dfb31 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "location": "westus", + "api-version": "2018-01-01", + "validateAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "streetAddress3": "", + "city": "SAN FRANCISCO", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "addressType": "None" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md new file mode 100644 index 000000000000..487819189c8e --- /dev/null +++ b/specification/databox/resource-manager/readme.md @@ -0,0 +1,106 @@ +# DataBox + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataBox. + + + +--- +## Getting Started +To build the SDK for DataBox, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DataBox API. + +``` yaml +openapi-type: arm + +input-file: +- Microsoft.DataBox\preview\2018-01-01\databox.json +directive: + - suppress: + - R2016 #to suppress (PatchBodyParametersSchema/R2016/RPCViolation) + - R2062 #to suppress (XmsResourceInPutResponse/R2062/RPCViolation) +``` +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataBox + output-folder: $(csharp-sdks-folder)/DataBox/Management.DataBox/Generated + clear-output-folder: true +``` + + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: databox + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +``` + +### Tag: package-2017-06 and go + +Please also specify `--go-sdk-folder=`. + +``` yaml $(go) +output-folder: $(go-sdk-folder)/services/databox/mgmt/2018-01-01/databox +``` + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.databox + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/databox +``` diff --git a/specification/databox/resource-manager/readme.nodejs.md b/specification/databox/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..081b5c0f619d --- /dev/null +++ b/specification/databox/resource-manager/readme.nodejs.md @@ -0,0 +1,11 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-databox + output-folder: $(node-sdks-folder)/lib/services/databox/lib +```