From 9bc0626e5c6c16c39a08ce77e7007e738691c442 Mon Sep 17 00:00:00 2001 From: Aditya Vutukuri Date: Thu, 30 Jul 2020 05:18:47 -0700 Subject: [PATCH 1/3] sort definitions in the 2019 version --- .../stable/2019-11-01/DataShare.json | 4366 ++++++++--------- 1 file changed, 2183 insertions(+), 2183 deletions(-) diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json index 734c0df12808..52cb2b83c073 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json @@ -3067,27 +3067,6 @@ } }, "definitions": { - "AccountList": { - "description": "List response for get Accounts.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Account" - } - } - } - }, "Account": { "description": "An account data transfer object.", "required": [ @@ -3111,29 +3090,23 @@ } } }, - "Identity": { - "description": "Identity of resource", + "AccountList": { + "description": "List response for get Accounts.", + "required": [ + "value" + ], "type": "object", "properties": { - "principalId": { - "description": "service principal Id", - "type": "string", - "readOnly": true - }, - "tenantId": { - "description": "Tenant Id", - "type": "string", - "readOnly": true + "nextLink": { + "description": "The Url of next result page.", + "type": "string" }, - "type": { - "description": "Identity Type", - "enum": [ - "SystemAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "type", - "modelAsString": true + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Account" } } } @@ -3176,976 +3149,835 @@ } } }, - "DataShareError": { - "description": "The data share error model.", - "required": [ - "error" - ], + "AccountUpdateParameters": { + "description": "Update parameters for accounts", "type": "object", "properties": { - "error": { - "$ref": "#/definitions/DataShareErrorInfo", - "description": "The data share error body" + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "DataShareErrorInfo": { - "description": "The data share error body model.", + "ADLSGen1FileDataSet": { + "description": "An ADLS Gen 1 file data set.", "required": [ - "code", - "message" + "properties", + "kind" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], "properties": { - "code": { - "description": "Code of the error", - "type": "string" - }, - "details": { - "description": "Nested details of the error model", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DataShareErrorInfo" - } - }, - "message": { - "description": "Message of the error", - "type": "string" - }, - "target": { - "description": "Target of the error", - "type": "string" + "properties": { + "$ref": "#/definitions/ADLSGen1FileProperties", + "description": "ADLS Gen 1 file data set properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "AdlsGen1File" }, - "OperationResponse": { - "description": "Response for long running operation", + "ADLSGen1FileProperties": { + "description": "Properties of the ADLS Gen1 file data set.", "required": [ - "status" + "subscriptionId", + "resourceGroup", + "accountName", + "folderPath", + "fileName" ], "type": "object", "properties": { - "endTime": { - "format": "date-time", - "description": "start time", + "accountName": { + "description": "The ADLS account name.", "type": "string" }, - "error": { - "$ref": "#/definitions/DataShareErrorInfo", - "description": "The error property when status is failed." + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true }, - "startTime": { - "format": "date-time", - "description": "start time", + "fileName": { + "description": "The file name in the ADLS account.", "type": "string" }, - "status": { - "description": "Operation state of the long running operation.", - "enum": [ - "Accepted", - "InProgress", - "TransientFailure", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "status", - "modelAsString": true - } + "folderPath": { + "description": "The folder path within the ADLS account.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of ADLS account.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of ADLS account.", + "type": "string" } } }, - "AccountUpdateParameters": { - "description": "Update parameters for accounts", + "ADLSGen1FolderDataSet": { + "description": "An ADLS Gen 1 folder data set.", + "required": [ + "properties", + "kind" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], "properties": { - "tags": { - "description": "Tags on the azure resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "properties": { + "$ref": "#/definitions/ADLSGen1FolderProperties", + "description": "ADLS Gen 1 folder data set properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "AdlsGen1Folder" }, - "ConsumerInvitationList": { - "description": "List response for get InvitationList", + "ADLSGen1FolderProperties": { + "description": "Properties of the ADLS Gen1 folder data set.", "required": [ - "value" + "subscriptionId", + "resourceGroup", + "accountName", + "folderPath" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "accountName": { + "description": "The ADLS account name.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConsumerInvitation" - } + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true + }, + "folderPath": { + "description": "The folder path within the ADLS account.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of ADLS account.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of ADLS account.", + "type": "string" } } }, - "ConsumerInvitation": { - "description": "A consumer Invitation data transfer object.", + "ADLSGen2FileDataSet": { + "description": "An ADLS Gen 2 file data set.", "required": [ - "properties" + "properties", + "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyDto" + "$ref": "#/definitions/DataSet" } ], "properties": { "properties": { - "$ref": "#/definitions/ConsumerInvitationProperties", - "description": "Properties on the account", + "$ref": "#/definitions/ADLSGen2FileProperties", + "description": "ADLS Gen 2 file data set properties.", "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "AdlsGen2File" }, - "ConsumerInvitationProperties": { - "description": "Properties of consumer invitation", + "ADLSGen2FileDataSetMapping": { + "description": "An ADLS Gen2 file data set mapping.", "required": [ - "invitationId" + "properties", + "kind" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSetMapping" + } + ], "properties": { - "dataSetCount": { - "format": "int32", - "description": "Number of data sets in a share", - "type": "integer", - "readOnly": true - }, - "description": { - "description": "Description shared when the invitation was created", - "type": "string", - "readOnly": true - }, - "invitationId": { - "description": "Unique id of the invitation.", + "properties": { + "$ref": "#/definitions/ADLSGen2FileDataSetMappingProperties", + "description": "ADLS Gen2 file data set mapping properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "AdlsGen2File" + }, + "ADLSGen2FileDataSetMappingProperties": { + "description": "ADLS Gen 2 file data set mapping property bag.", + "required": [ + "fileSystem", + "filePath", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" + ], + "type": "object", + "properties": { + "dataSetId": { + "description": "The id of the source data set.", "type": "string" }, - "invitationStatus": { - "description": "The status of the invitation.", + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", "enum": [ - "Pending", - "Accepted", - "Rejected", - "Withdrawn" + "Ok", + "Broken" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "invitationStatus", + "name": "dataSetMappingStatus", "modelAsString": true } }, - "location": { - "description": "invitation location", - "type": "string", - "readOnly": true + "filePath": { + "description": "File path within the file system.", + "type": "string" }, - "providerEmail": { - "description": "Email of the provider who created the resource", - "type": "string", - "readOnly": true + "fileSystem": { + "description": "File system to which the file belongs.", + "type": "string" }, - "providerName": { - "description": "Name of the provider who created the resource", + "outputType": { + "description": "Type of output file", + "enum": [ + "Csv", + "Parquet" + ], "type": "string", - "readOnly": true + "x-ms-enum": { + "name": "outputType", + "modelAsString": true + } }, - "providerTenantName": { - "description": "Tenant name of the provider who created the resource", + "provisioningState": { + "description": "Provisioning state of the data set mapping.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } }, - "respondedAt": { - "format": "date-time", - "description": "The time the recipient responded to the invitation.", - "type": "string", - "readOnly": true + "resourceGroup": { + "description": "Resource group of storage account.", + "type": "string" }, - "sentAt": { - "format": "date-time", - "description": "Gets the time at which the invitation was sent.", - "type": "string", - "readOnly": true + "storageAccountName": { + "description": "Storage account name of the source data set.", + "type": "string" }, - "shareName": { - "description": "Gets the source share Name.", + "subscriptionId": { + "description": "Subscription id of storage account.", + "type": "string" + } + } + }, + "ADLSGen2FileProperties": { + "description": "Properties of the ADLS Gen2 file data set.", + "required": [ + "fileSystem", + "filePath", + "subscriptionId", + "resourceGroup", + "storageAccountName" + ], + "type": "object", + "properties": { + "dataSetId": { + "description": "Unique id for identifying a data set resource", "type": "string", "readOnly": true }, - "termsOfUse": { - "description": "Terms of use shared when the invitation was created", - "type": "string", - "readOnly": true + "filePath": { + "description": "File path within the file system.", + "type": "string" }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true + "fileSystem": { + "description": "File system to which the file belongs.", + "type": "string" }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true + "resourceGroup": { + "description": "Resource group of storage account", + "type": "string" + }, + "storageAccountName": { + "description": "Storage account name of the source data set", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of storage account", + "type": "string" } } }, - "DataSet": { - "description": "A DataSet data transfer object.", + "ADLSGen2FileSystemDataSet": { + "description": "An ADLS Gen 2 file system data set.", "required": [ + "properties", "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyDto" + "$ref": "#/definitions/DataSet" } ], "properties": { - "kind": { - "description": "Kind of data set.", - "enum": [ - "Blob", - "Container", - "BlobFolder", - "AdlsGen2FileSystem", - "AdlsGen2Folder", - "AdlsGen2File", - "AdlsGen1Folder", - "AdlsGen1File", - "KustoCluster", - "KustoDatabase", - "SqlDBTable", - "SqlDWTable" - ], - "type": "string", - "x-ms-enum": { - "name": "kind", - "modelAsString": true - } + "properties": { + "$ref": "#/definitions/ADLSGen2FileSystemProperties", + "description": "ADLS Gen 2 file system data set properties.", + "x-ms-client-flatten": true } }, - "discriminator": "kind" - }, - "DataSetList": { - "description": "List response for get DataSets", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DataSet" - } - } - } + "x-ms-discriminator-value": "AdlsGen2FileSystem" }, - "DataSetMapping": { - "description": "A data set mapping data transfer object.", + "ADLSGen2FileSystemDataSetMapping": { + "description": "An ADLS Gen2 file system data set mapping.", "required": [ + "properties", "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyDto" + "$ref": "#/definitions/DataSetMapping" } ], "properties": { - "kind": { - "description": "Kind of data set mapping.", - "enum": [ - "Blob", - "Container", - "BlobFolder", - "AdlsGen2FileSystem", - "AdlsGen2Folder", - "AdlsGen2File", - "KustoCluster", - "KustoDatabase", - "SqlDBTable", - "SqlDWTable" - ], - "type": "string", - "x-ms-enum": { - "name": "kind", - "modelAsString": true - } + "properties": { + "$ref": "#/definitions/ADLSGen2FileSystemDataSetMappingProperties", + "description": "ADLS Gen2 file system data set mapping properties.", + "x-ms-client-flatten": true } }, - "discriminator": "kind" + "x-ms-discriminator-value": "AdlsGen2FileSystem" }, - "DataSetMappingList": { - "description": "List response for get DataSetMappings", + "ADLSGen2FileSystemDataSetMappingProperties": { + "description": "ADLS Gen 2 file system data set mapping property bag.", "required": [ - "value" + "fileSystem", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "dataSetId": { + "description": "The id of the source data set.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DataSetMapping" - } - } - } - }, - "Invitation": { - "description": "A Invitation data transfer object.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/InvitationProperties", - "description": "Properties on the Invitation", - "x-ms-client-flatten": true - } - } - }, - "InvitationProperties": { - "description": "Invitation property bag.", - "type": "object", - "properties": { - "invitationId": { - "description": "unique invitation id", - "type": "string", - "readOnly": true - }, - "invitationStatus": { - "description": "The status of the invitation.", + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", "enum": [ - "Pending", - "Accepted", - "Rejected", - "Withdrawn" + "Ok", + "Broken" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "invitationStatus", + "name": "dataSetMappingStatus", "modelAsString": true } }, - "respondedAt": { - "format": "date-time", - "description": "The time the recipient responded to the invitation.", - "type": "string", - "readOnly": true + "fileSystem": { + "description": "The file system name.", + "type": "string" }, - "sentAt": { - "format": "date-time", - "description": "Gets the time at which the invitation was sent.", + "provisioningState": { + "description": "Provisioning state of the data set mapping.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } }, - "targetActiveDirectoryId": { - "description": "The target Azure AD Id. Can't be combined with email.", + "resourceGroup": { + "description": "Resource group of storage account.", "type": "string" }, - "targetEmail": { - "description": "The email the invitation is directed to.", + "storageAccountName": { + "description": "Storage account name of the source data set.", "type": "string" }, - "targetObjectId": { - "description": "The target user or application Id that invitation is being sent to.\r\nMust be specified along TargetActiveDirectoryId. This enables sending\r\ninvitations to specific users or applications in an AD tenant.", + "subscriptionId": { + "description": "Subscription id of storage account.", "type": "string" - }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true } } }, - "InvitationList": { - "description": "List response for get InvitationList", + "ADLSGen2FileSystemProperties": { + "description": "Properties of the ADLS Gen2 file system data set.", "required": [ - "value" + "fileSystem", + "subscriptionId", + "resourceGroup", + "storageAccountName" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true + }, + "fileSystem": { + "description": "The file system name.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Invitation" - } + "resourceGroup": { + "description": "Resource group of storage account", + "type": "string" + }, + "storageAccountName": { + "description": "Storage account name of the source data set", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of storage account", + "type": "string" } } }, - "OperationList": { - "description": "List response for get operations.", + "ADLSGen2FolderDataSet": { + "description": "An ADLS Gen 2 folder data set.", "required": [ - "value" + "properties", + "kind" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationModel" - } + "properties": { + "$ref": "#/definitions/ADLSGen2FolderProperties", + "description": "ADLS Gen 2 folder data set properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "AdlsGen2Folder" }, - "OperationModel": { - "description": "The response model for get operations", + "ADLSGen2FolderDataSetMapping": { + "description": "An ADLS Gen2 folder data set mapping.", + "required": [ + "properties", + "kind" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSetMapping" + } + ], "properties": { - "display": { - "$ref": "#/definitions/OperationModelProperties", - "description": "Properties on the operation" - }, - "name": { - "description": "Operation name for display purposes", - "type": "string" - }, - "origin": { - "description": "origin of the operation", - "type": "string" - }, "properties": { - "$ref": "#/definitions/OperationMetaPropertyInfo", - "description": "properties for the operation meta info", + "$ref": "#/definitions/ADLSGen2FolderDataSetMappingProperties", + "description": "ADLS Gen2 folder data set mapping properties.", "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "AdlsGen2Folder" }, - "OperationModelProperties": { - "description": "Properties on operations", + "ADLSGen2FolderDataSetMappingProperties": { + "description": "ADLS Gen 2 folder data set mapping property bag.", + "required": [ + "fileSystem", + "folderPath", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" + ], "type": "object", "properties": { - "description": { - "description": "Description of the operation for display purposes", + "dataSetId": { + "description": "The id of the source data set.", "type": "string" }, - "operation": { - "description": "Name of the operation for display purposes", - "type": "string" + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", + "enum": [ + "Ok", + "Broken" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "dataSetMappingStatus", + "modelAsString": true + } }, - "provider": { - "description": "Name of the provider for display purposes", + "fileSystem": { + "description": "File system to which the folder belongs.", "type": "string" }, - "resource": { - "description": "Name of the resource type for display purposes", + "folderPath": { + "description": "Folder path within the file system.", "type": "string" - } - } - }, - "OperationMetaPropertyInfo": { - "description": "properties on meta info", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/OperationMetaServiceSpecification", - "description": "meta service specification" - } - } - }, - "OperationMetaServiceSpecification": { - "description": "The operation meta service specification", - "type": "object", - "properties": { - "logSpecifications": { - "description": "log specifications for the operation", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetaLogSpecification" - } }, - "metricSpecifications": { - "description": "metric specifications for the operation", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetaMetricSpecification" - } - } - } - }, - "OperationMetaMetricSpecification": { - "description": "metric specifications for the operation", - "type": "object", - "properties": { - "aggregationType": { - "description": "aggregation type of metric", - "type": "string" - }, - "dimensions": { - "description": "properties for dimension", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DimensionProperties" + "provisioningState": { + "description": "Provisioning state of the data set mapping.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true } }, - "displayDescription": { - "description": "description of the metric", + "resourceGroup": { + "description": "Resource group of storage account.", "type": "string" }, - "displayName": { - "description": "localized name of the metric", + "storageAccountName": { + "description": "Storage account name of the source data set.", "type": "string" }, - "enableRegionalMdmAccount": { - "description": "enable regional mdm account", + "subscriptionId": { + "description": "Subscription id of storage account.", "type": "string" + } + } + }, + "ADLSGen2FolderProperties": { + "description": "Properties of the ADLS Gen2 folder data set.", + "required": [ + "fileSystem", + "folderPath", + "subscriptionId", + "resourceGroup", + "storageAccountName" + ], + "type": "object", + "properties": { + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true }, - "internalMetricName": { - "description": "internal metric name", + "fileSystem": { + "description": "File system to which the folder belongs.", "type": "string" }, - "name": { - "description": "name of the metric", + "folderPath": { + "description": "Folder path within the file system.", "type": "string" }, - "resourceIdDimensionNameOverride": { - "description": "dimension name use to replace resource id if specified", + "resourceGroup": { + "description": "Resource group of storage account", "type": "string" }, - "supportedAggregationTypes": { - "description": "supported aggregation types", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "supportedTimeGrainTypes": { - "description": "supported time grain types", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "storageAccountName": { + "description": "Storage account name of the source data set", + "type": "string" }, - "unit": { - "description": "units for the metric", + "subscriptionId": { + "description": "Subscription id of storage account", "type": "string" } } }, - "OperationMetaLogSpecification": { - "description": "log specifications for operation api", + "BlobContainerDataSet": { + "description": "An Azure storage blob container data set.", + "required": [ + "properties", + "kind" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], "properties": { - "blobDuration": { - "description": "blob duration of the log", - "type": "string" - }, - "displayName": { - "description": "localized name of the log category", - "type": "string" - }, - "name": { - "description": "name of the log category", - "type": "string" + "properties": { + "$ref": "#/definitions/BlobContainerProperties", + "description": "Blob container data set properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "Container" }, - "DimensionProperties": { - "description": "properties for dimension", + "BlobContainerDataSetMapping": { + "description": "A Blob container data set mapping.", + "required": [ + "properties", + "kind" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSetMapping" + } + ], "properties": { - "displayName": { - "description": "localized display name of the dimension to customer", - "type": "string" - }, - "name": { - "description": "dimension name", - "type": "string" + "properties": { + "$ref": "#/definitions/BlobContainerMappingProperties", + "description": "Blob container data set mapping properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "Container" }, - "ShareSynchronization": { - "description": "A ShareSynchronization data transfer object.", + "BlobContainerMappingProperties": { + "description": "Azure storage Blob container data set mapping property bag.", + "required": [ + "containerName", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" + ], "type": "object", "properties": { - "consumerEmail": { - "description": "Email of the user who created the synchronization", - "type": "string" - }, - "consumerName": { - "description": "Name of the user who created the synchronization", - "type": "string" - }, - "consumerTenantName": { - "description": "Tenant name of the consumer who created the synchronization", - "type": "string" - }, - "durationMs": { - "format": "int32", - "description": "synchronization duration", - "type": "integer" - }, - "endTime": { - "format": "date-time", - "description": "End time of synchronization", - "type": "string" - }, - "message": { - "description": "message of synchronization", - "type": "string" - }, - "startTime": { - "format": "date-time", - "description": "start time of synchronization", + "containerName": { + "description": "BLOB Container name.", "type": "string" }, - "status": { - "description": "Raw Status", + "dataSetId": { + "description": "The id of the source data set.", "type": "string" }, - "synchronizationId": { - "description": "Synchronization id", - "type": "string" + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", + "enum": [ + "Ok", + "Broken" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "dataSetMappingStatus", + "modelAsString": true + } }, - "synchronizationMode": { - "description": "Synchronization mode", + "provisioningState": { + "description": "Provisioning state of the data set mapping.", "enum": [ - "Incremental", - "FullSync" + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "synchronizationMode", + "name": "provisioningState", "modelAsString": true } + }, + "resourceGroup": { + "description": "Resource group of storage account.", + "type": "string" + }, + "storageAccountName": { + "description": "Storage account name of the source data set.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of storage account.", + "type": "string" } } }, - "SynchronizationDetailsList": { - "description": "details of synchronization", + "BlobContainerProperties": { + "description": "Properties of the BLOB container data set.", "required": [ - "value" + "containerName", + "subscriptionId", + "resourceGroup", + "storageAccountName" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "containerName": { + "description": "BLOB Container name.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SynchronizationDetails" - } - } - } - }, - "SynchronizationDetails": { - "description": "Synchronization details at data set level", - "type": "object", - "properties": { "dataSetId": { - "description": "Id of data set", - "type": "string", - "readOnly": true - }, - "dataSetType": { - "description": "Type of the data set", - "enum": [ - "Blob", - "Container", - "BlobFolder", - "AdlsGen2FileSystem", - "AdlsGen2Folder", - "AdlsGen2File", - "AdlsGen1Folder", - "AdlsGen1File", - "KustoCluster", - "KustoDatabase", - "SqlDBTable", - "SqlDWTable" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetType", - "modelAsString": true - } - }, - "durationMs": { - "format": "int32", - "description": "Duration of data set level copy", - "type": "integer", - "readOnly": true - }, - "endTime": { - "format": "date-time", - "description": "End time of data set level copy", - "type": "string", - "readOnly": true - }, - "filesRead": { - "format": "int64", - "description": "The number of files read from the source data set", - "type": "integer", - "readOnly": true - }, - "filesWritten": { - "format": "int64", - "description": "The number of files written into the sink data set", - "type": "integer", - "readOnly": true - }, - "message": { - "description": "Error message if any", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the data set", + "description": "Unique id for identifying a data set resource", "type": "string", "readOnly": true }, - "rowsCopied": { - "format": "int64", - "description": "The number of files copied into the sink data set", - "type": "integer", - "readOnly": true - }, - "rowsRead": { - "format": "int64", - "description": "The number of rows read from the source data set.", - "type": "integer", - "readOnly": true - }, - "sizeRead": { - "format": "int64", - "description": "The size of the data read from the source data set in bytes", - "type": "integer", - "readOnly": true - }, - "sizeWritten": { - "format": "int64", - "description": "The size of the data written into the sink data set in bytes", - "type": "integer", - "readOnly": true - }, - "startTime": { - "format": "date-time", - "description": "Start time of data set level copy", - "type": "string", - "readOnly": true + "resourceGroup": { + "description": "Resource group of storage account", + "type": "string" }, - "status": { - "description": "Raw Status", - "type": "string", - "readOnly": true + "storageAccountName": { + "description": "Storage account name of the source data set", + "type": "string" }, - "vCore": { - "format": "int64", - "description": "The vCore units consumed for the data set synchronization", - "type": "integer", - "readOnly": true + "subscriptionId": { + "description": "Subscription id of storage account", + "type": "string" } } }, - "ShareSynchronizationList": { - "description": "List response for get ShareSynchronization.", + "BlobDataSet": { + "description": "An Azure storage blob data set.", "required": [ - "value" + "properties", + "kind" ], "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ShareSynchronization" - } - } - } - }, - "ProviderShareSubscription": { - "description": "A provider side share subscription data transfer object.", - "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyDto" + "$ref": "#/definitions/DataSet" } ], "properties": { "properties": { - "$ref": "#/definitions/ProviderShareSubscriptionProperties", - "description": "properties of providerShareSubscription", + "$ref": "#/definitions/BlobProperties", + "description": "Blob data set properties.", "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "Blob" }, - "ProviderShareSubscriptionProperties": { - "description": "Provider share subscription properties", + "BlobDataSetMapping": { + "description": "A Blob data set mapping.", + "required": [ + "properties", + "kind" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSetMapping" + } + ], "properties": { - "consumerEmail": { - "description": "Email of the consumer who created the share subscription", - "type": "string", - "readOnly": true - }, - "consumerName": { - "description": "Name of the consumer who created the share subscription", - "type": "string", - "readOnly": true - }, - "consumerTenantName": { - "description": "Tenant name of the consumer who created the share subscription", - "type": "string", - "readOnly": true - }, - "createdAt": { - "format": "date-time", - "description": "created at", - "type": "string", - "readOnly": true - }, - "providerEmail": { - "description": "Email of the provider who created the share", - "type": "string", - "readOnly": true - }, - "providerName": { - "description": "Name of the provider who created the share", - "type": "string", - "readOnly": true - }, - "sharedAt": { - "format": "date-time", - "description": "Shared at", - "type": "string", - "readOnly": true - }, - "shareSubscriptionObjectId": { - "description": "share Subscription Object Id", - "type": "string", - "readOnly": true - }, - "shareSubscriptionStatus": { - "description": "Gets the status of share subscription", - "enum": [ - "Active", - "Revoked", - "SourceDeleted", - "Revoking" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "shareSubscriptionStatus", - "modelAsString": true - } + "properties": { + "$ref": "#/definitions/BlobMappingProperties", + "description": "Blob data set mapping properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "Blob" }, - "ProviderShareSubscriptionList": { - "description": "List response for get ShareSubscription.", + "BlobFolderDataSet": { + "description": "An Azure storage blob folder data set.", "required": [ - "value" + "properties", + "kind" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ProviderShareSubscription" - } + "properties": { + "$ref": "#/definitions/BlobFolderProperties", + "description": "Blob folder data set properties.", + "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "BlobFolder" }, - "Share": { - "description": "A share data transfer object.", + "BlobFolderDataSetMapping": { + "description": "A Blob folder data set mapping.", + "required": [ + "properties", + "kind" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyDto" + "$ref": "#/definitions/DataSetMapping" } ], "properties": { "properties": { - "$ref": "#/definitions/ShareProperties", - "description": "Properties on the share", + "$ref": "#/definitions/BlobFolderMappingProperties", + "description": "Blob folder data set mapping properties.", "x-ms-client-flatten": true } - } + }, + "x-ms-discriminator-value": "BlobFolder" }, - "ShareProperties": { - "description": "Share property bag.", + "BlobFolderMappingProperties": { + "description": "Azure storage Blob folder data set mapping property bag.", + "required": [ + "containerName", + "prefix", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" + ], "type": "object", "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the share was created.", + "containerName": { + "description": "Container that has the file path.", + "type": "string" + }, + "dataSetId": { + "description": "The id of the source data set.", + "type": "string" + }, + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", + "enum": [ + "Ok", + "Broken" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "dataSetMappingStatus", + "modelAsString": true + } }, - "description": { - "description": "Share description.", + "prefix": { + "description": "Prefix for blob folder", "type": "string" }, "provisioningState": { - "description": "Gets or sets the provisioning state", + "description": "Provisioning state of the data set mapping.", "enum": [ "Succeeded", "Creating", @@ -4160,239 +3992,196 @@ "modelAsString": true } }, - "shareKind": { - "description": "Share kind.", - "enum": [ - "CopyBased", - "InPlace" - ], - "type": "string", - "x-ms-enum": { - "name": "shareKind", - "modelAsString": true - } - }, - "terms": { - "description": "Share terms.", + "resourceGroup": { + "description": "Resource group of storage account.", "type": "string" }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true - } - } - }, - "ShareList": { - "description": "List response for get Shares.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", + "storageAccountName": { + "description": "Storage account name of the source data set.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Share" - } + "subscriptionId": { + "description": "Subscription id of storage account.", + "type": "string" } } }, - "ShareSubscriptionSynchronization": { - "description": "A ShareSubscriptionSynchronization data transfer object.", + "BlobFolderProperties": { + "description": "Properties of the blob folder data set.", "required": [ - "synchronizationId" + "containerName", + "prefix", + "subscriptionId", + "resourceGroup", + "storageAccountName" ], "type": "object", "properties": { - "durationMs": { - "format": "int32", - "description": "Synchronization duration", - "type": "integer", - "readOnly": true - }, - "endTime": { - "format": "date-time", - "description": "End time of synchronization", - "type": "string", - "readOnly": true + "containerName": { + "description": "Container that has the file path.", + "type": "string" }, - "message": { - "description": "message of Synchronization", + "dataSetId": { + "description": "Unique id for identifying a data set resource", "type": "string", "readOnly": true }, - "startTime": { - "format": "date-time", - "description": "start time of synchronization", - "type": "string", - "readOnly": true + "prefix": { + "description": "Prefix for blob folder", + "type": "string" }, - "status": { - "description": "Raw Status", - "type": "string", - "readOnly": true + "resourceGroup": { + "description": "Resource group of storage account", + "type": "string" }, - "synchronizationId": { - "description": "Synchronization id", + "storageAccountName": { + "description": "Storage account name of the source data set", "type": "string" }, - "synchronizationMode": { - "description": "Synchronization Mode", - "enum": [ - "Incremental", - "FullSync" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "synchronizationMode", - "modelAsString": true - } + "subscriptionId": { + "description": "Subscription id of storage account", + "type": "string" } } }, - "ConsumerSourceDataSetList": { - "description": "A consumer side list of source dataSets", + "BlobMappingProperties": { + "description": "Azure storage Blob data set mapping property bag.", "required": [ - "value" + "containerName", + "filePath", + "subscriptionId", + "resourceGroup", + "storageAccountName", + "dataSetId" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "containerName": { + "description": "Container that has the file path.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConsumerSourceDataSet" - } - } - } - }, - "ConsumerSourceDataSet": { - "description": "A consumer side dataSet data transfer object.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ConsumerSourceDataSetProperties", - "description": "source dataSet properties", - "x-ms-client-flatten": true - } - } - }, - "ConsumerSourceDataSetProperties": { - "description": "Properties of consumer source dataSet", - "type": "object", - "properties": { "dataSetId": { - "description": "DataSet Id", - "type": "string", - "readOnly": true - }, - "dataSetLocation": { - "description": "Location of the data set.", - "type": "string", - "readOnly": true + "description": "The id of the source data set.", + "type": "string" }, - "dataSetName": { - "description": "DataSet name", + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", + "enum": [ + "Ok", + "Broken" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "dataSetMappingStatus", + "modelAsString": true + } }, - "dataSetPath": { - "description": "DataSet path", - "type": "string", - "readOnly": true + "filePath": { + "description": "File path within the source data set", + "type": "string" }, - "dataSetType": { - "description": "Type of data set", + "outputType": { + "description": "File output type", "enum": [ - "Blob", - "Container", - "BlobFolder", - "AdlsGen2FileSystem", - "AdlsGen2Folder", - "AdlsGen2File", - "AdlsGen1Folder", - "AdlsGen1File", - "KustoCluster", - "KustoDatabase", - "SqlDBTable", - "SqlDWTable" + "Csv", + "Parquet" + ], + "type": "string", + "x-ms-enum": { + "name": "outputType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the data set mapping.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "dataSetType", + "name": "provisioningState", "modelAsString": true } + }, + "resourceGroup": { + "description": "Resource group of storage account.", + "type": "string" + }, + "storageAccountName": { + "description": "Storage account name of the source data set.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of storage account.", + "type": "string" } } }, - "SourceShareSynchronizationSettingList": { - "description": "List response for get source share Synchronization settings", + "BlobProperties": { + "description": "Properties of the blob data set.", "required": [ - "value" + "containerName", + "filePath", + "subscriptionId", + "resourceGroup", + "storageAccountName" ], "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "containerName": { + "description": "Container that has the file path.", "type": "string" }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SourceShareSynchronizationSetting" - } + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true + }, + "filePath": { + "description": "File path within the source data set", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of storage account", + "type": "string" + }, + "storageAccountName": { + "description": "Storage account name of the source data set", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id of storage account", + "type": "string" } } }, - "SourceShareSynchronizationSetting": { - "description": "A view of synchronization setting added by the provider", + "ConsumerInvitation": { + "description": "A consumer Invitation data transfer object.", "required": [ - "kind" + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], "properties": { - "kind": { - "description": "Kind of synchronization", - "enum": [ - "ScheduleBased" - ], - "type": "string", - "x-ms-enum": { - "name": "kind", - "modelAsString": true - } + "properties": { + "$ref": "#/definitions/ConsumerInvitationProperties", + "description": "Properties on the account", + "x-ms-client-flatten": true } - }, - "discriminator": "kind" + } }, - "ShareSubscriptionSynchronizationList": { - "description": "A consumer side list of share subscription synchronizations", + "ConsumerInvitationList": { + "description": "List response for get InvitationList", "required": [ "value" ], @@ -4407,34 +4196,104 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ConsumerInvitation" } } } }, - "Synchronize": { - "description": "Payload for the synchronizing the data.", + "ConsumerInvitationProperties": { + "description": "Properties of consumer invitation", + "required": [ + "invitationId" + ], "type": "object", "properties": { - "synchronizationMode": { - "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", + "dataSetCount": { + "format": "int32", + "description": "Number of data sets in a share", + "type": "integer", + "readOnly": true + }, + "description": { + "description": "Description shared when the invitation was created", + "type": "string", + "readOnly": true + }, + "invitationId": { + "description": "Unique id of the invitation.", + "type": "string" + }, + "invitationStatus": { + "description": "The status of the invitation.", "enum": [ - "Incremental", - "FullSync" + "Pending", + "Accepted", + "Rejected", + "Withdrawn" ], "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "synchronizationMode", + "name": "invitationStatus", "modelAsString": true } + }, + "location": { + "description": "invitation location", + "type": "string", + "readOnly": true + }, + "providerEmail": { + "description": "Email of the provider who created the resource", + "type": "string", + "readOnly": true + }, + "providerName": { + "description": "Name of the provider who created the resource", + "type": "string", + "readOnly": true + }, + "providerTenantName": { + "description": "Tenant name of the provider who created the resource", + "type": "string", + "readOnly": true + }, + "respondedAt": { + "format": "date-time", + "description": "The time the recipient responded to the invitation.", + "type": "string", + "readOnly": true + }, + "sentAt": { + "format": "date-time", + "description": "Gets the time at which the invitation was sent.", + "type": "string", + "readOnly": true + }, + "shareName": { + "description": "Gets the source share Name.", + "type": "string", + "readOnly": true + }, + "termsOfUse": { + "description": "Terms of use shared when the invitation was created", + "type": "string", + "readOnly": true + }, + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Name of the user who created the resource", + "type": "string", + "readOnly": true } } }, - "ShareSubscription": { - "description": "A share subscription data transfer object.", - "required": [ - "properties" - ], + "ConsumerSourceDataSet": { + "description": "A consumer side dataSet data transfer object.", "type": "object", "allOf": [ { @@ -4443,122 +4302,121 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ShareSubscriptionProperties", - "description": "Properties on the share subscription", + "$ref": "#/definitions/ConsumerSourceDataSetProperties", + "description": "source dataSet properties", "x-ms-client-flatten": true } } }, - "ShareSubscriptionProperties": { - "description": "Share subscription property bag.", + "ConsumerSourceDataSetList": { + "description": "A consumer side list of source dataSets", "required": [ - "invitationId", - "sourceShareLocation" + "value" ], "type": "object", "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the share subscription was created.", - "type": "string", - "readOnly": true - }, - "invitationId": { - "description": "The invitation id.", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "providerEmail": { - "description": "Email of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerName": { - "description": "Name of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerTenantName": { - "description": "Tenant name of the provider who created the resource", + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConsumerSourceDataSet" + } + } + } + }, + "ConsumerSourceDataSetProperties": { + "description": "Properties of consumer source dataSet", + "type": "object", + "properties": { + "dataSetId": { + "description": "DataSet Id", "type": "string", "readOnly": true }, - "provisioningState": { - "description": "Provisioning state of the share subscription", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], + "dataSetLocation": { + "description": "Location of the data set.", "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } + "readOnly": true }, - "shareDescription": { - "description": "Description of share", + "dataSetName": { + "description": "DataSet name", "type": "string", "readOnly": true }, - "shareKind": { - "description": "Kind of share", + "dataSetPath": { + "description": "DataSet path", + "type": "string", + "readOnly": true + }, + "dataSetType": { + "description": "Type of data set", "enum": [ - "CopyBased", - "InPlace" + "Blob", + "Container", + "BlobFolder", + "AdlsGen2FileSystem", + "AdlsGen2Folder", + "AdlsGen2File", + "AdlsGen1Folder", + "AdlsGen1File", + "KustoCluster", + "KustoDatabase", + "SqlDBTable", + "SqlDWTable" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "shareKind", + "name": "dataSetType", "modelAsString": true } - }, - "shareName": { - "description": "Name of the share", - "type": "string", - "readOnly": true - }, - "shareSubscriptionStatus": { - "description": "Gets the current status of share subscription.", + } + } + }, + "DataSet": { + "description": "A DataSet data transfer object.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], + "properties": { + "kind": { + "description": "Kind of data set.", "enum": [ - "Active", - "Revoked", - "SourceDeleted", - "Revoking" + "Blob", + "Container", + "BlobFolder", + "AdlsGen2FileSystem", + "AdlsGen2Folder", + "AdlsGen2File", + "AdlsGen1Folder", + "AdlsGen1File", + "KustoCluster", + "KustoDatabase", + "SqlDBTable", + "SqlDWTable" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "shareSubscriptionStatus", + "name": "kind", "modelAsString": true } - }, - "shareTerms": { - "description": "Terms of a share", - "type": "string", - "readOnly": true - }, - "sourceShareLocation": { - "description": "Source share location.", - "type": "string" - }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true } - } + }, + "discriminator": "kind" }, - "ShareSubscriptionList": { - "description": "List response for get ShareSubscription.", + "DataSetList": { + "description": "List response for get DataSets", "required": [ "value" ], @@ -4573,13 +4431,13 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/DataSet" } } } }, - "SynchronizationSetting": { - "description": "A Synchronization Setting data transfer object.", + "DataSetMapping": { + "description": "A data set mapping data transfer object.", "required": [ "kind" ], @@ -4591,9 +4449,18 @@ ], "properties": { "kind": { - "description": "Kind of synchronization", + "description": "Kind of data set mapping.", "enum": [ - "ScheduleBased" + "Blob", + "Container", + "BlobFolder", + "AdlsGen2FileSystem", + "AdlsGen2Folder", + "AdlsGen2File", + "KustoCluster", + "KustoDatabase", + "SqlDBTable", + "SqlDWTable" ], "type": "string", "x-ms-enum": { @@ -4604,8 +4471,8 @@ }, "discriminator": "kind" }, - "SynchronizationSettingList": { - "description": "List response for get Synchronization settings", + "DataSetMappingList": { + "description": "List response for get DataSetMappings", "required": [ "value" ], @@ -4620,39 +4487,146 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/SynchronizationSetting" + "$ref": "#/definitions/DataSetMapping" } } } }, - "Trigger": { - "description": "A Trigger data transfer object.", + "DataShareError": { + "description": "The data share error model.", "required": [ - "kind" + "error" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" + "properties": { + "error": { + "$ref": "#/definitions/DataShareErrorInfo", + "description": "The data share error body" } + } + }, + "DataShareErrorInfo": { + "description": "The data share error body model.", + "required": [ + "code", + "message" ], + "type": "object", "properties": { - "kind": { - "description": "Kind of synchronization", + "code": { + "description": "Code of the error", + "type": "string" + }, + "details": { + "description": "Nested details of the error model", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DataShareErrorInfo" + } + }, + "message": { + "description": "Message of the error", + "type": "string" + }, + "target": { + "description": "Target of the error", + "type": "string" + } + } + }, + "DefaultDto": { + "description": "Base data transfer object implementation for default resources.", + "type": "object", + "properties": { + "id": { + "description": "The resource id of the azure resource", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Location of the azure resource.", + "type": "string" + }, + "name": { + "description": "Name of the azure resource", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "type": { + "description": "Type of the azure resource", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DimensionProperties": { + "description": "properties for dimension", + "type": "object", + "properties": { + "displayName": { + "description": "localized display name of the dimension to customer", + "type": "string" + }, + "name": { + "description": "dimension name", + "type": "string" + } + } + }, + "Identity": { + "description": "Identity of resource", + "type": "object", + "properties": { + "principalId": { + "description": "service principal Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identity Type", "enum": [ - "ScheduleBased" + "SystemAssigned" ], "type": "string", "x-ms-enum": { - "name": "kind", + "name": "type", "modelAsString": true } } - }, - "discriminator": "kind" + } + }, + "Invitation": { + "description": "A Invitation data transfer object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InvitationProperties", + "description": "Properties on the Invitation", + "x-ms-client-flatten": true + } + } }, - "TriggerList": { - "description": "List response for get triggers", + "InvitationList": { + "description": "List response for get InvitationList", "required": [ "value" ], @@ -4667,88 +4641,73 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/Trigger" + "$ref": "#/definitions/Invitation" } } } }, - "ScheduledSynchronizationSetting": { - "description": "A type of synchronization setting based on schedule", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SynchronizationSetting" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ScheduledSynchronizationSettingProperties", - "description": "Properties of scheduled synchronization", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "ScheduleBased" - }, - "ScheduledSynchronizationSettingProperties": { - "description": "A Scheduled synchronization setting data transfer object.", - "required": [ - "recurrenceInterval", - "synchronizationTime" - ], + "InvitationProperties": { + "description": "Invitation property bag.", "type": "object", "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the synchronization setting was created.", + "invitationId": { + "description": "unique invitation id", "type": "string", "readOnly": true }, - "provisioningState": { - "description": "Gets or sets the provisioning state", + "invitationStatus": { + "description": "The status of the invitation.", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Pending", + "Accepted", + "Rejected", + "Withdrawn" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "invitationStatus", "modelAsString": true } }, - "recurrenceInterval": { - "description": "Recurrence Interval", - "enum": [ - "Hour", - "Day" - ], + "respondedAt": { + "format": "date-time", + "description": "The time the recipient responded to the invitation.", "type": "string", - "x-ms-enum": { - "name": "recurrenceInterval", - "modelAsString": true - } + "readOnly": true }, - "synchronizationTime": { + "sentAt": { "format": "date-time", - "description": "Synchronization time", + "description": "Gets the time at which the invitation was sent.", + "type": "string", + "readOnly": true + }, + "targetActiveDirectoryId": { + "description": "The target Azure AD Id. Can't be combined with email.", + "type": "string" + }, + "targetEmail": { + "description": "The email the invitation is directed to.", "type": "string" }, + "targetObjectId": { + "description": "The target user or application Id that invitation is being sent to.\r\nMust be specified along TargetActiveDirectoryId. This enables sending\r\ninvitations to specific users or applications in an AD tenant.", + "type": "string" + }, + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, "userName": { - "description": "Name of the user who created the synchronization setting.", + "description": "Name of the user who created the resource", "type": "string", "readOnly": true } } }, - "ScheduledTrigger": { - "description": "A type of trigger based on schedule", + "KustoClusterDataSet": { + "description": "A kusto cluster data set.", "required": [ "properties", "kind" @@ -4756,159 +4715,132 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/Trigger" + "$ref": "#/definitions/DataSet" } ], "properties": { "properties": { - "$ref": "#/definitions/ScheduledTriggerProperties", - "description": "Properties of scheduled synchronization", + "$ref": "#/definitions/KustoClusterDataSetProperties", + "description": "Kusto cluster data set properties.", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "ScheduleBased" + "x-ms-discriminator-value": "KustoCluster" }, - "ScheduledTriggerProperties": { - "description": "A Scheduled trigger data transfer object.", + "KustoClusterDataSetMapping": { + "description": "A Kusto cluster data set mapping", "required": [ - "recurrenceInterval", - "synchronizationTime" + "properties", + "kind" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSetMapping" + } + ], "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the trigger was created.", - "type": "string", - "readOnly": true + "properties": { + "$ref": "#/definitions/KustoClusterDataSetMappingProperties", + "description": "Kusto cluster data set mapping properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "KustoCluster" + }, + "KustoClusterDataSetMappingProperties": { + "description": "Properties of the Kusto cluster data set mapping", + "required": [ + "kustoClusterResourceId", + "dataSetId" + ], + "type": "object", + "properties": { + "dataSetId": { + "description": "The id of the source data set.", + "type": "string" }, - "provisioningState": { - "description": "Gets the provisioning state", + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Ok", + "Broken" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "dataSetMappingStatus", "modelAsString": true } }, - "recurrenceInterval": { - "description": "Recurrence Interval", - "enum": [ - "Hour", - "Day" - ], - "type": "string", - "x-ms-enum": { - "name": "recurrenceInterval", - "modelAsString": true - } + "kustoClusterResourceId": { + "description": "Resource id of the sink kusto cluster.", + "type": "string" }, - "synchronizationMode": { - "description": "Synchronization mode", - "enum": [ - "Incremental", - "FullSync" - ], + "location": { + "description": "Location of the sink kusto cluster.", "type": "string", - "x-ms-enum": { - "name": "synchronizationMode", - "modelAsString": true - } - }, - "synchronizationTime": { - "format": "date-time", - "description": "Synchronization time", - "type": "string" + "readOnly": true }, - "triggerStatus": { - "description": "Gets the trigger state", + "provisioningState": { + "description": "Provisioning state of the data set mapping.", "enum": [ - "Active", - "Inactive", - "SourceSynchronizationSettingDeleted" + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "triggerStatus", + "name": "provisioningState", "modelAsString": true } - }, - "userName": { - "description": "Name of the user who created the trigger.", - "type": "string", - "readOnly": true } } }, - "BlobDataSet": { - "description": "An Azure storage blob data set.", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BlobProperties", - "description": "Blob data set properties.", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "Blob" - }, - "BlobProperties": { - "description": "Properties of the blob data set.", + "KustoClusterDataSetProperties": { + "description": "Properties of the kusto cluster data set.", "required": [ - "containerName", - "filePath", - "subscriptionId", - "resourceGroup", - "storageAccountName" + "kustoClusterResourceId" ], "type": "object", "properties": { - "containerName": { - "description": "Container that has the file path.", - "type": "string" - }, "dataSetId": { "description": "Unique id for identifying a data set resource", "type": "string", - "readOnly": true - }, - "filePath": { - "description": "File path within the source data set", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of storage account", - "type": "string" + "readOnly": true }, - "storageAccountName": { - "description": "Storage account name of the source data set", + "kustoClusterResourceId": { + "description": "Resource id of the kusto cluster.", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of storage account", - "type": "string" + "location": { + "description": "Location of the kusto cluster.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the kusto cluster data set.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } } } }, - "BlobFolderDataSet": { - "description": "An Azure storage blob folder data set.", + "KustoDatabaseDataSet": { + "description": "A kusto database data set.", "required": [ "properties", "kind" @@ -4921,53 +4853,15 @@ ], "properties": { "properties": { - "$ref": "#/definitions/BlobFolderProperties", - "description": "Blob folder data set properties.", + "$ref": "#/definitions/KustoDatabaseDataSetProperties", + "description": "Kusto database data set properties.", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "BlobFolder" - }, - "BlobFolderProperties": { - "description": "Properties of the blob folder data set.", - "required": [ - "containerName", - "prefix", - "subscriptionId", - "resourceGroup", - "storageAccountName" - ], - "type": "object", - "properties": { - "containerName": { - "description": "Container that has the file path.", - "type": "string" - }, - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true - }, - "prefix": { - "description": "Prefix for blob folder", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of storage account", - "type": "string" - }, - "storageAccountName": { - "description": "Storage account name of the source data set", - "type": "string" - }, - "subscriptionId": { - "description": "Subscription id of storage account", - "type": "string" - } - } + "x-ms-discriminator-value": "KustoDatabase" }, - "BlobContainerDataSet": { - "description": "An Azure storage blob container data set.", + "KustoDatabaseDataSetMapping": { + "description": "A Kusto database data set mapping", "required": [ "properties", "kind" @@ -4975,80 +4869,74 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSet" + "$ref": "#/definitions/DataSetMapping" } ], "properties": { "properties": { - "$ref": "#/definitions/BlobContainerProperties", - "description": "Blob container data set properties.", + "$ref": "#/definitions/KustoDatabaseDataSetMappingProperties", + "description": "Kusto database data set mapping properties.", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "Container" + "x-ms-discriminator-value": "KustoDatabase" }, - "BlobContainerProperties": { - "description": "Properties of the BLOB container data set.", + "KustoDatabaseDataSetMappingProperties": { + "description": "Properties of the Kusto database data set mapping", "required": [ - "containerName", - "subscriptionId", - "resourceGroup", - "storageAccountName" + "kustoClusterResourceId", + "dataSetId" ], "type": "object", "properties": { - "containerName": { - "description": "BLOB Container name.", + "dataSetId": { + "description": "The id of the source data set.", "type": "string" }, - "dataSetId": { - "description": "Unique id for identifying a data set resource", + "dataSetMappingStatus": { + "description": "Gets the status of the data set mapping.", + "enum": [ + "Ok", + "Broken" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "dataSetMappingStatus", + "modelAsString": true + } }, - "resourceGroup": { - "description": "Resource group of storage account", + "kustoClusterResourceId": { + "description": "Resource id of the sink kusto cluster.", "type": "string" }, - "storageAccountName": { - "description": "Storage account name of the source data set", - "type": "string" + "location": { + "description": "Location of the sink kusto cluster.", + "type": "string", + "readOnly": true }, - "subscriptionId": { - "description": "Subscription id of storage account", - "type": "string" + "provisioningState": { + "description": "Provisioning state of the data set mapping.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } } } }, - "ADLSGen2FileDataSet": { - "description": "An ADLS Gen 2 file data set.", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen2FileProperties", - "description": "ADLS Gen 2 file data set properties.", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "AdlsGen2File" - }, - "ADLSGen2FileProperties": { - "description": "Properties of the ADLS Gen2 file data set.", + "KustoDatabaseDataSetProperties": { + "description": "Properties of the kusto database data set.", "required": [ - "fileSystem", - "filePath", - "subscriptionId", - "resourceGroup", - "storageAccountName" + "kustoDatabaseResourceId" ], "type": "object", "properties": { @@ -5057,482 +4945,492 @@ "type": "string", "readOnly": true }, - "filePath": { - "description": "File path within the file system.", - "type": "string" - }, - "fileSystem": { - "description": "File system to which the file belongs.", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of storage account", + "kustoDatabaseResourceId": { + "description": "Resource id of the kusto database.", "type": "string" }, - "storageAccountName": { - "description": "Storage account name of the source data set", - "type": "string" + "location": { + "description": "Location of the kusto cluster.", + "type": "string", + "readOnly": true }, - "subscriptionId": { - "description": "Subscription id of storage account", - "type": "string" + "provisioningState": { + "description": "Provisioning state of the kusto database data set.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } } } }, - "ADLSGen2FolderDataSet": { - "description": "An ADLS Gen 2 folder data set.", + "OperationList": { + "description": "List response for get operations.", "required": [ - "properties", - "kind" + "value" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationModel" + } } - ], + } + }, + "OperationMetaLogSpecification": { + "description": "log specifications for operation api", + "type": "object", "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen2FolderProperties", - "description": "ADLS Gen 2 folder data set properties.", - "x-ms-client-flatten": true + "blobDuration": { + "description": "blob duration of the log", + "type": "string" + }, + "displayName": { + "description": "localized name of the log category", + "type": "string" + }, + "name": { + "description": "name of the log category", + "type": "string" } - }, - "x-ms-discriminator-value": "AdlsGen2Folder" + } }, - "ADLSGen2FolderProperties": { - "description": "Properties of the ADLS Gen2 folder data set.", - "required": [ - "fileSystem", - "folderPath", - "subscriptionId", - "resourceGroup", - "storageAccountName" - ], + "OperationMetaMetricSpecification": { + "description": "metric specifications for the operation", "type": "object", "properties": { - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true + "aggregationType": { + "description": "aggregation type of metric", + "type": "string" }, - "fileSystem": { - "description": "File system to which the folder belongs.", + "dimensions": { + "description": "properties for dimension", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "displayDescription": { + "description": "description of the metric", "type": "string" }, - "folderPath": { - "description": "Folder path within the file system.", + "displayName": { + "description": "localized name of the metric", "type": "string" }, - "resourceGroup": { - "description": "Resource group of storage account", + "enableRegionalMdmAccount": { + "description": "enable regional mdm account", "type": "string" }, - "storageAccountName": { - "description": "Storage account name of the source data set", + "internalMetricName": { + "description": "internal metric name", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of storage account", + "name": { + "description": "name of the metric", + "type": "string" + }, + "resourceIdDimensionNameOverride": { + "description": "dimension name use to replace resource id if specified", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "supported aggregation types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "description": "supported time grain types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "unit": { + "description": "units for the metric", "type": "string" } } }, - "ADLSGen2FileSystemDataSet": { - "description": "An ADLS Gen 2 file system data set.", - "required": [ - "properties", - "kind" - ], + "OperationMetaPropertyInfo": { + "description": "properties on meta info", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen2FileSystemProperties", - "description": "ADLS Gen 2 file system data set properties.", - "x-ms-client-flatten": true + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification", + "description": "meta service specification" } - }, - "x-ms-discriminator-value": "AdlsGen2FileSystem" + } }, - "ADLSGen2FileSystemProperties": { - "description": "Properties of the ADLS Gen2 file system data set.", - "required": [ - "fileSystem", - "subscriptionId", - "resourceGroup", - "storageAccountName" - ], + "OperationMetaServiceSpecification": { + "description": "The operation meta service specification", "type": "object", "properties": { - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true - }, - "fileSystem": { - "description": "The file system name.", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of storage account", - "type": "string" - }, - "storageAccountName": { - "description": "Storage account name of the source data set", - "type": "string" + "logSpecifications": { + "description": "log specifications for the operation", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + } }, - "subscriptionId": { - "description": "Subscription id of storage account", - "type": "string" + "metricSpecifications": { + "description": "metric specifications for the operation", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + } } } }, - "ADLSGen1FolderDataSet": { - "description": "An ADLS Gen 1 folder data set.", - "required": [ - "properties", - "kind" - ], + "OperationModel": { + "description": "The response model for get operations", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], "properties": { + "display": { + "$ref": "#/definitions/OperationModelProperties", + "description": "Properties on the operation" + }, + "name": { + "description": "Operation name for display purposes", + "type": "string" + }, + "origin": { + "description": "origin of the operation", + "type": "string" + }, "properties": { - "$ref": "#/definitions/ADLSGen1FolderProperties", - "description": "ADLS Gen 1 folder data set properties.", + "$ref": "#/definitions/OperationMetaPropertyInfo", + "description": "properties for the operation meta info", "x-ms-client-flatten": true } - }, - "x-ms-discriminator-value": "AdlsGen1Folder" + } }, - "ADLSGen1FolderProperties": { - "description": "Properties of the ADLS Gen1 folder data set.", - "required": [ - "subscriptionId", - "resourceGroup", - "accountName", - "folderPath" - ], + "OperationModelProperties": { + "description": "Properties on operations", "type": "object", "properties": { - "accountName": { - "description": "The ADLS account name.", + "description": { + "description": "Description of the operation for display purposes", "type": "string" }, - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true - }, - "folderPath": { - "description": "The folder path within the ADLS account.", + "operation": { + "description": "Name of the operation for display purposes", "type": "string" }, - "resourceGroup": { - "description": "Resource group of ADLS account.", + "provider": { + "description": "Name of the provider for display purposes", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of ADLS account.", + "resource": { + "description": "Name of the resource type for display purposes", "type": "string" } } }, - "ADLSGen1FileDataSet": { - "description": "An ADLS Gen 1 file data set.", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen1FileProperties", - "description": "ADLS Gen 1 file data set properties.", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "AdlsGen1File" - }, - "ADLSGen1FileProperties": { - "description": "Properties of the ADLS Gen1 file data set.", + "OperationResponse": { + "description": "Response for long running operation", "required": [ - "subscriptionId", - "resourceGroup", - "accountName", - "folderPath", - "fileName" + "status" ], "type": "object", "properties": { - "accountName": { - "description": "The ADLS account name.", - "type": "string" - }, - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true - }, - "fileName": { - "description": "The file name in the ADLS account.", + "endTime": { + "format": "date-time", + "description": "start time", "type": "string" }, - "folderPath": { - "description": "The folder path within the ADLS account.", - "type": "string" + "error": { + "$ref": "#/definitions/DataShareErrorInfo", + "description": "The error property when status is failed." }, - "resourceGroup": { - "description": "Resource group of ADLS account.", + "startTime": { + "format": "date-time", + "description": "start time", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of ADLS account.", - "type": "string" + "status": { + "description": "Operation state of the long running operation.", + "enum": [ + "Accepted", + "InProgress", + "TransientFailure", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } } } }, - "KustoClusterDataSet": { - "description": "A kusto cluster data set.", - "required": [ - "properties", - "kind" - ], + "ProviderShareSubscription": { + "description": "A provider side share subscription data transfer object.", "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSet" + "$ref": "#/definitions/ProxyDto" } ], "properties": { "properties": { - "$ref": "#/definitions/KustoClusterDataSetProperties", - "description": "Kusto cluster data set properties.", + "$ref": "#/definitions/ProviderShareSubscriptionProperties", + "description": "properties of providerShareSubscription", "x-ms-client-flatten": true } - }, - "x-ms-discriminator-value": "KustoCluster" + } }, - "KustoClusterDataSetProperties": { - "description": "Properties of the kusto cluster data set.", + "ProviderShareSubscriptionList": { + "description": "List response for get ShareSubscription.", "required": [ - "kustoClusterResourceId" + "value" ], "type": "object", "properties": { - "dataSetId": { - "description": "Unique id for identifying a data set resource", + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProviderShareSubscription" + } + } + } + }, + "ProviderShareSubscriptionProperties": { + "description": "Provider share subscription properties", + "type": "object", + "properties": { + "consumerEmail": { + "description": "Email of the consumer who created the share subscription", "type": "string", "readOnly": true }, - "kustoClusterResourceId": { - "description": "Resource id of the kusto cluster.", - "type": "string" + "consumerName": { + "description": "Name of the consumer who created the share subscription", + "type": "string", + "readOnly": true }, - "location": { - "description": "Location of the kusto cluster.", + "consumerTenantName": { + "description": "Tenant name of the consumer who created the share subscription", "type": "string", "readOnly": true }, - "provisioningState": { - "description": "Provisioning state of the kusto cluster data set.", + "createdAt": { + "format": "date-time", + "description": "created at", + "type": "string", + "readOnly": true + }, + "providerEmail": { + "description": "Email of the provider who created the share", + "type": "string", + "readOnly": true + }, + "providerName": { + "description": "Name of the provider who created the share", + "type": "string", + "readOnly": true + }, + "sharedAt": { + "format": "date-time", + "description": "Shared at", + "type": "string", + "readOnly": true + }, + "shareSubscriptionObjectId": { + "description": "share Subscription Object Id", + "type": "string", + "readOnly": true + }, + "shareSubscriptionStatus": { + "description": "Gets the status of share subscription", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Active", + "Revoked", + "SourceDeleted", + "Revoking" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "shareSubscriptionStatus", "modelAsString": true } } } }, - "KustoDatabaseDataSet": { - "description": "A kusto database data set.", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSet" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/KustoDatabaseDataSetProperties", - "description": "Kusto database data set properties.", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "KustoDatabase" - }, - "KustoDatabaseDataSetProperties": { - "description": "Properties of the kusto database data set.", - "required": [ - "kustoDatabaseResourceId" - ], + "ProxyDto": { + "description": "Base data transfer object implementation for proxy resources.", "type": "object", "properties": { - "dataSetId": { - "description": "Unique id for identifying a data set resource", + "id": { + "description": "The resource id of the azure resource", "type": "string", "readOnly": true }, - "kustoDatabaseResourceId": { - "description": "Resource id of the kusto database.", - "type": "string" - }, - "location": { - "description": "Location of the kusto cluster.", + "name": { + "description": "Name of the azure resource", "type": "string", "readOnly": true }, - "provisioningState": { - "description": "Provisioning state of the kusto database data set.", + "type": { + "description": "Type of the azure resource", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ScheduledSourceShareSynchronizationSettingProperties": { + "description": "A Scheduled source synchronization setting data transfer object.", + "type": "object", + "properties": { + "recurrenceInterval": { + "description": "Recurrence Interval", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Hour", + "Day" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "recurrenceInterval", "modelAsString": true } + }, + "synchronizationTime": { + "format": "date-time", + "description": "Synchronization time", + "type": "string" } } }, - "SqlDWTableDataSet": { - "description": "A SQL DW table data set.", + "ScheduledSourceSynchronizationSetting": { + "description": "A type of synchronization setting based on schedule", "required": [ "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSet" + "$ref": "#/definitions/SourceShareSynchronizationSetting" } ], "properties": { "properties": { - "$ref": "#/definitions/SqlDWTableProperties", - "description": "SQL DW table data set properties.", + "$ref": "#/definitions/ScheduledSourceShareSynchronizationSettingProperties", + "description": "Properties of scheduled synchronization", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "SqlDWTable" - }, - "SqlDWTableProperties": { - "description": "Properties of the SQL DW table data set.", - "required": [ - "dataWarehouseName", - "tableName", - "schemaName", - "sqlServerResourceId" - ], - "type": "object", - "properties": { - "dataSetId": { - "description": "Unique id for identifying a data set resource", - "type": "string", - "readOnly": true - }, - "dataWarehouseName": { - "description": "DataWarehouse name of the source data set", - "type": "string" - }, - "schemaName": { - "description": "Schema of the table. Default value is dbo.", - "type": "string" - }, - "sqlServerResourceId": { - "description": "Resource id of SQL server", - "type": "string" - }, - "tableName": { - "description": "SQL DW table name.", - "type": "string" - } - } + "x-ms-discriminator-value": "ScheduleBased" }, - "SqlDBTableDataSet": { - "description": "A SQL DB table data set.", + "ScheduledSynchronizationSetting": { + "description": "A type of synchronization setting based on schedule", "required": [ + "properties", "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSet" + "$ref": "#/definitions/SynchronizationSetting" } ], "properties": { "properties": { - "$ref": "#/definitions/SqlDBTableProperties", - "description": "SQL DB table data set properties.", + "$ref": "#/definitions/ScheduledSynchronizationSettingProperties", + "description": "Properties of scheduled synchronization", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "SqlDBTable" + "x-ms-discriminator-value": "ScheduleBased" }, - "SqlDBTableProperties": { - "description": "Properties of the SQL DB table data set.", + "ScheduledSynchronizationSettingProperties": { + "description": "A Scheduled synchronization setting data transfer object.", "required": [ - "databaseName", - "tableName", - "schemaName", - "sqlServerResourceId" + "recurrenceInterval", + "synchronizationTime" ], "type": "object", "properties": { - "databaseName": { - "description": "Database name of the source data set", - "type": "string" - }, - "dataSetId": { - "description": "Unique id for identifying a data set resource", + "createdAt": { + "format": "date-time", + "description": "Time at which the synchronization setting was created.", "type": "string", "readOnly": true }, - "schemaName": { - "description": "Schema of the table. Default value is dbo.", - "type": "string" + "provisioningState": { + "description": "Gets or sets the provisioning state", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } }, - "sqlServerResourceId": { - "description": "Resource id of SQL server", - "type": "string" + "recurrenceInterval": { + "description": "Recurrence Interval", + "enum": [ + "Hour", + "Day" + ], + "type": "string", + "x-ms-enum": { + "name": "recurrenceInterval", + "modelAsString": true + } }, - "tableName": { - "description": "SQL DB table name.", + "synchronizationTime": { + "format": "date-time", + "description": "Synchronization time", "type": "string" + }, + "userName": { + "description": "Name of the user who created the synchronization setting.", + "type": "string", + "readOnly": true } } }, - "BlobDataSetMapping": { - "description": "A Blob data set mapping.", + "ScheduledTrigger": { + "description": "A type of trigger based on schedule", "required": [ "properties", "kind" @@ -5540,157 +5438,151 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSetMapping" + "$ref": "#/definitions/Trigger" } ], "properties": { "properties": { - "$ref": "#/definitions/BlobMappingProperties", - "description": "Blob data set mapping properties.", + "$ref": "#/definitions/ScheduledTriggerProperties", + "description": "Properties of scheduled synchronization", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "Blob" + "x-ms-discriminator-value": "ScheduleBased" }, - "BlobMappingProperties": { - "description": "Azure storage Blob data set mapping property bag.", + "ScheduledTriggerProperties": { + "description": "A Scheduled trigger data transfer object.", "required": [ - "containerName", - "filePath", - "subscriptionId", - "resourceGroup", - "storageAccountName", - "dataSetId" + "recurrenceInterval", + "synchronizationTime" ], "type": "object", "properties": { - "containerName": { - "description": "Container that has the file path.", - "type": "string" - }, - "dataSetId": { - "description": "The id of the source data set.", - "type": "string" + "createdAt": { + "format": "date-time", + "description": "Time at which the trigger was created.", + "type": "string", + "readOnly": true }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", + "provisioningState": { + "description": "Gets the provisioning state", "enum": [ - "Ok", - "Broken" + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "dataSetMappingStatus", + "name": "provisioningState", "modelAsString": true } }, - "filePath": { - "description": "File path within the source data set", - "type": "string" - }, - "outputType": { - "description": "File output type", + "recurrenceInterval": { + "description": "Recurrence Interval", "enum": [ - "Csv", - "Parquet" + "Hour", + "Day" ], "type": "string", "x-ms-enum": { - "name": "outputType", + "name": "recurrenceInterval", "modelAsString": true } }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", + "synchronizationMode": { + "description": "Synchronization mode", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Incremental", + "FullSync" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "synchronizationMode", "modelAsString": true } }, - "resourceGroup": { - "description": "Resource group of storage account.", + "synchronizationTime": { + "format": "date-time", + "description": "Synchronization time", "type": "string" }, - "storageAccountName": { - "description": "Storage account name of the source data set.", - "type": "string" + "triggerStatus": { + "description": "Gets the trigger state", + "enum": [ + "Active", + "Inactive", + "SourceSynchronizationSettingDeleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "triggerStatus", + "modelAsString": true + } }, - "subscriptionId": { - "description": "Subscription id of storage account.", - "type": "string" + "userName": { + "description": "Name of the user who created the trigger.", + "type": "string", + "readOnly": true } } }, - "BlobFolderDataSetMapping": { - "description": "A Blob folder data set mapping.", - "required": [ - "properties", - "kind" - ], + "Share": { + "description": "A share data transfer object.", "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSetMapping" + "$ref": "#/definitions/ProxyDto" } ], "properties": { "properties": { - "$ref": "#/definitions/BlobFolderMappingProperties", - "description": "Blob folder data set mapping properties.", + "$ref": "#/definitions/ShareProperties", + "description": "Properties on the share", "x-ms-client-flatten": true } - }, - "x-ms-discriminator-value": "BlobFolder" + } }, - "BlobFolderMappingProperties": { - "description": "Azure storage Blob folder data set mapping property bag.", + "ShareList": { + "description": "List response for get Shares.", "required": [ - "containerName", - "prefix", - "subscriptionId", - "resourceGroup", - "storageAccountName", - "dataSetId" + "value" ], "type": "object", "properties": { - "containerName": { - "description": "Container that has the file path.", - "type": "string" - }, - "dataSetId": { - "description": "The id of the source data set.", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", - "enum": [ - "Ok", - "Broken" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetMappingStatus", - "modelAsString": true + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Share" } + } + } + }, + "ShareProperties": { + "description": "Share property bag.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "Time at which the share was created.", + "type": "string", + "readOnly": true }, - "prefix": { - "description": "Prefix for blob folder", + "description": { + "description": "Share description.", "type": "string" }, "provisioningState": { - "description": "Provisioning state of the data set mapping.", + "description": "Gets or sets the provisioning state", "enum": [ "Succeeded", "Creating", @@ -5705,75 +5597,109 @@ "modelAsString": true } }, - "resourceGroup": { - "description": "Resource group of storage account.", - "type": "string" + "shareKind": { + "description": "Share kind.", + "enum": [ + "CopyBased", + "InPlace" + ], + "type": "string", + "x-ms-enum": { + "name": "shareKind", + "modelAsString": true + } }, - "storageAccountName": { - "description": "Storage account name of the source data set.", + "terms": { + "description": "Share terms.", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of storage account.", - "type": "string" + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Name of the user who created the resource", + "type": "string", + "readOnly": true } } }, - "BlobContainerDataSetMapping": { - "description": "A Blob container data set mapping.", + "ShareSubscription": { + "description": "A share subscription data transfer object.", "required": [ - "properties", - "kind" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSetMapping" + "$ref": "#/definitions/ProxyDto" } ], "properties": { "properties": { - "$ref": "#/definitions/BlobContainerMappingProperties", - "description": "Blob container data set mapping properties.", + "$ref": "#/definitions/ShareSubscriptionProperties", + "description": "Properties on the share subscription", "x-ms-client-flatten": true } - }, - "x-ms-discriminator-value": "Container" + } }, - "BlobContainerMappingProperties": { - "description": "Azure storage Blob container data set mapping property bag.", + "ShareSubscriptionList": { + "description": "List response for get ShareSubscription.", "required": [ - "containerName", - "subscriptionId", - "resourceGroup", - "storageAccountName", - "dataSetId" + "value" ], "type": "object", "properties": { - "containerName": { - "description": "BLOB Container name.", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "dataSetId": { - "description": "The id of the source data set.", + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSubscription" + } + } + } + }, + "ShareSubscriptionProperties": { + "description": "Share subscription property bag.", + "required": [ + "invitationId", + "sourceShareLocation" + ], + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "Time at which the share subscription was created.", + "type": "string", + "readOnly": true + }, + "invitationId": { + "description": "The invitation id.", "type": "string" }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", - "enum": [ - "Ok", - "Broken" - ], + "providerEmail": { + "description": "Email of the provider who created the resource", "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetMappingStatus", - "modelAsString": true - } + "readOnly": true + }, + "providerName": { + "description": "Name of the provider who created the resource", + "type": "string", + "readOnly": true + }, + "providerTenantName": { + "description": "Tenant name of the provider who created the resource", + "type": "string", + "readOnly": true }, "provisioningState": { - "description": "Provisioning state of the data set mapping.", + "description": "Provisioning state of the share subscription", "enum": [ "Succeeded", "Creating", @@ -5788,210 +5714,283 @@ "modelAsString": true } }, - "resourceGroup": { - "description": "Resource group of storage account.", - "type": "string" + "shareDescription": { + "description": "Description of share", + "type": "string", + "readOnly": true }, - "storageAccountName": { - "description": "Storage account name of the source data set.", - "type": "string" + "shareKind": { + "description": "Kind of share", + "enum": [ + "CopyBased", + "InPlace" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "shareKind", + "modelAsString": true + } }, - "subscriptionId": { - "description": "Subscription id of storage account.", + "shareName": { + "description": "Name of the share", + "type": "string", + "readOnly": true + }, + "shareSubscriptionStatus": { + "description": "Gets the current status of share subscription.", + "enum": [ + "Active", + "Revoked", + "SourceDeleted", + "Revoking" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "shareSubscriptionStatus", + "modelAsString": true + } + }, + "shareTerms": { + "description": "Terms of a share", + "type": "string", + "readOnly": true + }, + "sourceShareLocation": { + "description": "Source share location.", "type": "string" + }, + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Name of the user who created the resource", + "type": "string", + "readOnly": true } } }, - "ADLSGen2FileDataSetMapping": { - "description": "An ADLS Gen2 file data set mapping.", + "ShareSubscriptionSynchronization": { + "description": "A ShareSubscriptionSynchronization data transfer object.", "required": [ - "properties", - "kind" + "synchronizationId" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSetMapping" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen2FileDataSetMappingProperties", - "description": "ADLS Gen2 file data set mapping properties.", - "x-ms-client-flatten": true + "durationMs": { + "format": "int32", + "description": "Synchronization duration", + "type": "integer", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "End time of synchronization", + "type": "string", + "readOnly": true + }, + "message": { + "description": "message of Synchronization", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "start time of synchronization", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Raw Status", + "type": "string", + "readOnly": true + }, + "synchronizationId": { + "description": "Synchronization id", + "type": "string" + }, + "synchronizationMode": { + "description": "Synchronization Mode", + "enum": [ + "Incremental", + "FullSync" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "synchronizationMode", + "modelAsString": true + } } - }, - "x-ms-discriminator-value": "AdlsGen2File" + } }, - "ADLSGen2FileDataSetMappingProperties": { - "description": "ADLS Gen 2 file data set mapping property bag.", + "ShareSubscriptionSynchronizationList": { + "description": "A consumer side list of share subscription synchronizations", "required": [ - "fileSystem", - "filePath", - "subscriptionId", - "resourceGroup", - "storageAccountName", - "dataSetId" + "value" ], "type": "object", "properties": { - "dataSetId": { - "description": "The id of the source data set.", + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSubscriptionSynchronization" + } + } + } + }, + "ShareSynchronization": { + "description": "A ShareSynchronization data transfer object.", + "type": "object", + "properties": { + "consumerEmail": { + "description": "Email of the user who created the synchronization", + "type": "string" + }, + "consumerName": { + "description": "Name of the user who created the synchronization", + "type": "string" + }, + "consumerTenantName": { + "description": "Tenant name of the consumer who created the synchronization", + "type": "string" + }, + "durationMs": { + "format": "int32", + "description": "synchronization duration", + "type": "integer" + }, + "endTime": { + "format": "date-time", + "description": "End time of synchronization", "type": "string" }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", - "enum": [ - "Ok", - "Broken" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetMappingStatus", - "modelAsString": true - } + "message": { + "description": "message of synchronization", + "type": "string" }, - "filePath": { - "description": "File path within the file system.", + "startTime": { + "format": "date-time", + "description": "start time of synchronization", "type": "string" }, - "fileSystem": { - "description": "File system to which the file belongs.", + "status": { + "description": "Raw Status", "type": "string" }, - "outputType": { - "description": "Type of output file", - "enum": [ - "Csv", - "Parquet" - ], - "type": "string", - "x-ms-enum": { - "name": "outputType", - "modelAsString": true - } + "synchronizationId": { + "description": "Synchronization id", + "type": "string" }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", + "synchronizationMode": { + "description": "Synchronization mode", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Incremental", + "FullSync" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "synchronizationMode", "modelAsString": true } - }, - "resourceGroup": { - "description": "Resource group of storage account.", - "type": "string" - }, - "storageAccountName": { - "description": "Storage account name of the source data set.", - "type": "string" - }, - "subscriptionId": { - "description": "Subscription id of storage account.", - "type": "string" } } }, - "ADLSGen2FolderDataSetMapping": { - "description": "An ADLS Gen2 folder data set mapping.", + "ShareSynchronizationList": { + "description": "List response for get ShareSynchronization.", "required": [ - "properties", - "kind" + "value" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSetMapping" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/ADLSGen2FolderDataSetMappingProperties", - "description": "ADLS Gen2 folder data set mapping properties.", - "x-ms-client-flatten": true + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSynchronization" + } } - }, - "x-ms-discriminator-value": "AdlsGen2Folder" + } }, - "ADLSGen2FolderDataSetMappingProperties": { - "description": "ADLS Gen 2 folder data set mapping property bag.", + "SourceShareSynchronizationSetting": { + "description": "A view of synchronization setting added by the provider", "required": [ - "fileSystem", - "folderPath", - "subscriptionId", - "resourceGroup", - "storageAccountName", - "dataSetId" + "kind" ], "type": "object", "properties": { - "dataSetId": { - "description": "The id of the source data set.", - "type": "string" - }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", + "kind": { + "description": "Kind of synchronization", "enum": [ - "Ok", - "Broken" + "ScheduleBased" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "dataSetMappingStatus", + "name": "kind", "modelAsString": true } - }, - "fileSystem": { - "description": "File system to which the folder belongs.", - "type": "string" - }, - "folderPath": { - "description": "Folder path within the file system.", + } + }, + "discriminator": "kind" + }, + "SourceShareSynchronizationSettingList": { + "description": "List response for get source share Synchronization settings", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SourceShareSynchronizationSetting" } - }, - "resourceGroup": { - "description": "Resource group of storage account.", - "type": "string" - }, - "storageAccountName": { - "description": "Storage account name of the source data set.", - "type": "string" - }, - "subscriptionId": { - "description": "Subscription id of storage account.", - "type": "string" } } }, - "ADLSGen2FileSystemDataSetMapping": { - "description": "An ADLS Gen2 file system data set mapping.", + "SqlDBTableDataSet": { + "description": "A SQL DB table data set.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlDBTableProperties", + "description": "SQL DB table data set properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "SqlDBTable" + }, + "SqlDBTableDataSetMapping": { + "description": "A SQL DB Table data set mapping.", "required": [ "properties", "kind" @@ -6004,24 +6003,28 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ADLSGen2FileSystemDataSetMappingProperties", - "description": "ADLS Gen2 file system data set mapping properties.", + "$ref": "#/definitions/SqlDBTableDataSetMappingProperties", + "description": "Sql DB data set mapping properties.", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "AdlsGen2FileSystem" + "x-ms-discriminator-value": "SqlDBTable" }, - "ADLSGen2FileSystemDataSetMappingProperties": { - "description": "ADLS Gen 2 file system data set mapping property bag.", + "SqlDBTableDataSetMappingProperties": { + "description": "Properties of the SQL DB table data set mapping.", "required": [ - "fileSystem", - "subscriptionId", - "resourceGroup", - "storageAccountName", + "databaseName", + "tableName", + "schemaName", + "sqlServerResourceId", "dataSetId" ], "type": "object", "properties": { + "databaseName": { + "description": "DatabaseName name of the sink data set", + "type": "string" + }, "dataSetId": { "description": "The id of the source data set.", "type": "string" @@ -6039,10 +6042,6 @@ "modelAsString": true } }, - "fileSystem": { - "description": "The file system name.", - "type": "string" - }, "provisioningState": { "description": "Provisioning state of the data set mapping.", "enum": [ @@ -6059,22 +6058,75 @@ "modelAsString": true } }, - "resourceGroup": { - "description": "Resource group of storage account.", + "schemaName": { + "description": "Schema of the table. Default value is dbo.", + "type": "string" + }, + "sqlServerResourceId": { + "description": "Resource id of SQL server", + "type": "string" + }, + "tableName": { + "description": "SQL DB table name.", + "type": "string" + } + } + }, + "SqlDBTableProperties": { + "description": "Properties of the SQL DB table data set.", + "required": [ + "databaseName", + "tableName", + "schemaName", + "sqlServerResourceId" + ], + "type": "object", + "properties": { + "databaseName": { + "description": "Database name of the source data set", + "type": "string" + }, + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true + }, + "schemaName": { + "description": "Schema of the table. Default value is dbo.", "type": "string" }, - "storageAccountName": { - "description": "Storage account name of the source data set.", + "sqlServerResourceId": { + "description": "Resource id of SQL server", "type": "string" }, - "subscriptionId": { - "description": "Subscription id of storage account.", + "tableName": { + "description": "SQL DB table name.", "type": "string" } } }, - "KustoClusterDataSetMapping": { - "description": "A Kusto cluster data set mapping", + "SqlDWTableDataSet": { + "description": "A SQL DW table data set.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSet" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlDWTableProperties", + "description": "SQL DW table data set properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "SqlDWTable" + }, + "SqlDWTableDataSetMapping": { + "description": "A SQL DW Table data set mapping.", "required": [ "properties", "kind" @@ -6087,17 +6139,20 @@ ], "properties": { "properties": { - "$ref": "#/definitions/KustoClusterDataSetMappingProperties", - "description": "Kusto cluster data set mapping properties.", + "$ref": "#/definitions/SqlDWTableDataSetMappingProperties", + "description": "Sql DW data set mapping properties.", "x-ms-client-flatten": true } }, - "x-ms-discriminator-value": "KustoCluster" + "x-ms-discriminator-value": "SqlDWTable" }, - "KustoClusterDataSetMappingProperties": { - "description": "Properties of the Kusto cluster data set mapping", + "SqlDWTableDataSetMappingProperties": { + "description": "Properties of the SQL DW table data set mapping.", "required": [ - "kustoClusterResourceId", + "dataWarehouseName", + "tableName", + "schemaName", + "sqlServerResourceId", "dataSetId" ], "type": "object", @@ -6119,15 +6174,10 @@ "modelAsString": true } }, - "kustoClusterResourceId": { - "description": "Resource id of the sink kusto cluster.", + "dataWarehouseName": { + "description": "DataWarehouse name of the source data set", "type": "string" }, - "location": { - "description": "Location of the sink kusto cluster.", - "type": "string", - "readOnly": true - }, "provisioningState": { "description": "Provisioning state of the data set mapping.", "enum": [ @@ -6143,345 +6193,295 @@ "name": "provisioningState", "modelAsString": true } + }, + "schemaName": { + "description": "Schema of the table. Default value is dbo.", + "type": "string" + }, + "sqlServerResourceId": { + "description": "Resource id of SQL server", + "type": "string" + }, + "tableName": { + "description": "SQL DW table name.", + "type": "string" } } }, - "KustoDatabaseDataSetMapping": { - "description": "A Kusto database data set mapping", + "SqlDWTableProperties": { + "description": "Properties of the SQL DW table data set.", "required": [ - "properties", - "kind" + "dataWarehouseName", + "tableName", + "schemaName", + "sqlServerResourceId" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSetMapping" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/KustoDatabaseDataSetMappingProperties", - "description": "Kusto database data set mapping properties.", - "x-ms-client-flatten": true + "dataSetId": { + "description": "Unique id for identifying a data set resource", + "type": "string", + "readOnly": true + }, + "dataWarehouseName": { + "description": "DataWarehouse name of the source data set", + "type": "string" + }, + "schemaName": { + "description": "Schema of the table. Default value is dbo.", + "type": "string" + }, + "sqlServerResourceId": { + "description": "Resource id of SQL server", + "type": "string" + }, + "tableName": { + "description": "SQL DW table name.", + "type": "string" } - }, - "x-ms-discriminator-value": "KustoDatabase" + } }, - "KustoDatabaseDataSetMappingProperties": { - "description": "Properties of the Kusto database data set mapping", - "required": [ - "kustoClusterResourceId", - "dataSetId" - ], + "SynchronizationDetails": { + "description": "Synchronization details at data set level", "type": "object", "properties": { "dataSetId": { - "description": "The id of the source data set.", - "type": "string" + "description": "Id of data set", + "type": "string", + "readOnly": true }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", + "dataSetType": { + "description": "Type of the data set", "enum": [ - "Ok", - "Broken" + "Blob", + "Container", + "BlobFolder", + "AdlsGen2FileSystem", + "AdlsGen2Folder", + "AdlsGen2File", + "AdlsGen1Folder", + "AdlsGen1File", + "KustoCluster", + "KustoDatabase", + "SqlDBTable", + "SqlDWTable" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "dataSetMappingStatus", + "name": "dataSetType", "modelAsString": true } }, - "kustoClusterResourceId": { - "description": "Resource id of the sink kusto cluster.", - "type": "string" + "durationMs": { + "format": "int32", + "description": "Duration of data set level copy", + "type": "integer", + "readOnly": true }, - "location": { - "description": "Location of the sink kusto cluster.", + "endTime": { + "format": "date-time", + "description": "End time of data set level copy", "type": "string", "readOnly": true }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], + "filesRead": { + "format": "int64", + "description": "The number of files read from the source data set", + "type": "integer", + "readOnly": true + }, + "filesWritten": { + "format": "int64", + "description": "The number of files written into the sink data set", + "type": "integer", + "readOnly": true + }, + "message": { + "description": "Error message if any", "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - } - } - }, - "SqlDWTableDataSetMapping": { - "description": "A SQL DW Table data set mapping.", - "required": [ - "properties", - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataSetMapping" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlDWTableDataSetMappingProperties", - "description": "Sql DW data set mapping properties.", - "x-ms-client-flatten": true + "readOnly": true + }, + "name": { + "description": "Name of the data set", + "type": "string", + "readOnly": true + }, + "rowsCopied": { + "format": "int64", + "description": "The number of files copied into the sink data set", + "type": "integer", + "readOnly": true + }, + "rowsRead": { + "format": "int64", + "description": "The number of rows read from the source data set.", + "type": "integer", + "readOnly": true + }, + "sizeRead": { + "format": "int64", + "description": "The size of the data read from the source data set in bytes", + "type": "integer", + "readOnly": true + }, + "sizeWritten": { + "format": "int64", + "description": "The size of the data written into the sink data set in bytes", + "type": "integer", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Start time of data set level copy", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Raw Status", + "type": "string", + "readOnly": true + }, + "vCore": { + "format": "int64", + "description": "The vCore units consumed for the data set synchronization", + "type": "integer", + "readOnly": true } - }, - "x-ms-discriminator-value": "SqlDWTable" + } }, - "SqlDWTableDataSetMappingProperties": { - "description": "Properties of the SQL DW table data set mapping.", + "SynchronizationDetailsList": { + "description": "details of synchronization", "required": [ - "dataWarehouseName", - "tableName", - "schemaName", - "sqlServerResourceId", - "dataSetId" + "value" ], "type": "object", "properties": { - "dataSetId": { - "description": "The id of the source data set.", - "type": "string" - }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", - "enum": [ - "Ok", - "Broken" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetMappingStatus", - "modelAsString": true - } - }, - "dataWarehouseName": { - "description": "DataWarehouse name of the source data set", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SynchronizationDetails" } - }, - "schemaName": { - "description": "Schema of the table. Default value is dbo.", - "type": "string" - }, - "sqlServerResourceId": { - "description": "Resource id of SQL server", - "type": "string" - }, - "tableName": { - "description": "SQL DW table name.", - "type": "string" } } }, - "SqlDBTableDataSetMapping": { - "description": "A SQL DB Table data set mapping.", + "SynchronizationSetting": { + "description": "A Synchronization Setting data transfer object.", "required": [ - "properties", "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DataSetMapping" + "$ref": "#/definitions/ProxyDto" } ], "properties": { - "properties": { - "$ref": "#/definitions/SqlDBTableDataSetMappingProperties", - "description": "Sql DB data set mapping properties.", - "x-ms-client-flatten": true + "kind": { + "description": "Kind of synchronization", + "enum": [ + "ScheduleBased" + ], + "type": "string", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + } } }, - "x-ms-discriminator-value": "SqlDBTable" + "discriminator": "kind" }, - "SqlDBTableDataSetMappingProperties": { - "description": "Properties of the SQL DB table data set mapping.", + "SynchronizationSettingList": { + "description": "List response for get Synchronization settings", "required": [ - "databaseName", - "tableName", - "schemaName", - "sqlServerResourceId", - "dataSetId" + "value" ], "type": "object", "properties": { - "databaseName": { - "description": "DatabaseName name of the sink data set", - "type": "string" - }, - "dataSetId": { - "description": "The id of the source data set.", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "dataSetMappingStatus": { - "description": "Gets the status of the data set mapping.", - "enum": [ - "Ok", - "Broken" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "dataSetMappingStatus", - "modelAsString": true + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SynchronizationSetting" } - }, - "provisioningState": { - "description": "Provisioning state of the data set mapping.", + } + } + }, + "Synchronize": { + "description": "Payload for the synchronizing the data.", + "type": "object", + "properties": { + "synchronizationMode": { + "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" + "Incremental", + "FullSync" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "provisioningState", + "name": "synchronizationMode", "modelAsString": true } - }, - "schemaName": { - "description": "Schema of the table. Default value is dbo.", - "type": "string" - }, - "sqlServerResourceId": { - "description": "Resource id of SQL server", - "type": "string" - }, - "tableName": { - "description": "SQL DB table name.", - "type": "string" } } }, - "ScheduledSourceSynchronizationSetting": { - "description": "A type of synchronization setting based on schedule", + "Trigger": { + "description": "A Trigger data transfer object.", "required": [ "kind" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/SourceShareSynchronizationSetting" + "$ref": "#/definitions/ProxyDto" } ], "properties": { - "properties": { - "$ref": "#/definitions/ScheduledSourceShareSynchronizationSettingProperties", - "description": "Properties of scheduled synchronization", - "x-ms-client-flatten": true - } - }, - "x-ms-discriminator-value": "ScheduleBased" - }, - "ScheduledSourceShareSynchronizationSettingProperties": { - "description": "A Scheduled source synchronization setting data transfer object.", - "type": "object", - "properties": { - "recurrenceInterval": { - "description": "Recurrence Interval", + "kind": { + "description": "Kind of synchronization", "enum": [ - "Hour", - "Day" + "ScheduleBased" ], "type": "string", "x-ms-enum": { - "name": "recurrenceInterval", + "name": "kind", "modelAsString": true } - }, - "synchronizationTime": { - "format": "date-time", - "description": "Synchronization time", - "type": "string" } - } + }, + "discriminator": "kind" }, - "DefaultDto": { - "description": "Base data transfer object implementation for default resources.", + "TriggerList": { + "description": "List response for get triggers", + "required": [ + "value" + ], "type": "object", "properties": { - "id": { - "description": "The resource id of the azure resource", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Location of the azure resource.", + "nextLink": { + "description": "The Url of next result page.", "type": "string" }, - "name": { - "description": "Name of the azure resource", - "type": "string", - "readOnly": true - }, - "tags": { - "description": "Tags on the azure resource.", - "type": "object", - "additionalProperties": { - "type": "string" + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Trigger" } - }, - "type": { - "description": "Type of the azure resource", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyDto": { - "description": "Base data transfer object implementation for proxy resources.", - "type": "object", - "properties": { - "id": { - "description": "The resource id of the azure resource", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the azure resource", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the azure resource", - "type": "string", - "readOnly": true } - }, - "x-ms-azure-resource": true + } } }, "parameters": { From db9c9abbdd15de19e8219d3cc8ab89b2cca079db Mon Sep 17 00:00:00 2001 From: Aditya Vutukuri Date: Thu, 30 Jul 2020 05:40:53 -0700 Subject: [PATCH 2/3] sort definitions in the 2019 version --- .../Microsoft.DataShare/stable/2019-11-01/DataShare.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json index 52cb2b83c073..60c5dcefddf7 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json @@ -6069,8 +6069,7 @@ "tableName": { "description": "SQL DB table name.", "type": "string" - } - } + }} }, "SqlDBTableProperties": { "description": "Properties of the SQL DB table data set.", @@ -6535,4 +6534,4 @@ } ], "tags": [] -} +} \ No newline at end of file From 230e1797a6f1cc31dab6d4fa1eeb81bdc2ce80c2 Mon Sep 17 00:00:00 2001 From: Aditya Vutukuri Date: Fri, 31 Jul 2020 14:30:46 -0700 Subject: [PATCH 3/3] run prettier --- .../Microsoft.DataShare/stable/2019-11-01/DataShare.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json index 60c5dcefddf7..52cb2b83c073 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json @@ -6069,7 +6069,8 @@ "tableName": { "description": "SQL DB table name.", "type": "string" - }} + } + } }, "SqlDBTableProperties": { "description": "Properties of the SQL DB table data set.", @@ -6534,4 +6535,4 @@ } ], "tags": [] -} \ No newline at end of file +}