# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from msrest.serialization import Model
from msrest.exceptions import HttpOperationError
[docs]class DefaultDto(Model):
"""Base data transfer object implementation for default resources.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:param location: Location of the azure resource.
:type location: str
:ivar name: Name of the azure resource
:vartype name: str
:param tags: Tags on the azure resource.
:type tags: dict[str, str]
:ivar type: Type of the azure resource
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, **kwargs) -> None:
super(DefaultDto, self).__init__(**kwargs)
self.id = None
self.location = location
self.name = None
self.tags = tags
self.type = None
[docs]class Account(DefaultDto):
"""An account data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:param location: Location of the azure resource.
:type location: str
:ivar name: Name of the azure resource
:vartype name: str
:param tags: Tags on the azure resource.
:type tags: dict[str, str]
:ivar type: Type of the azure resource
:vartype type: str
:param identity: Required. Identity Info on the Account
:type identity: ~azure.mgmt.datashare.models.Identity
:ivar created_at: Time at which the account was created.
:vartype created_at: datetime
:ivar provisioning_state: Provisioning state of the Account. Possible
values include: 'Succeeded', 'Creating', 'Deleting', 'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:ivar user_email: Email of the user who created the resource
:vartype user_email: str
:ivar user_name: Name of the user who created the resource
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'identity': {'required': True},
'created_at': {'readonly': True},
'provisioning_state': {'readonly': True},
'user_email': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'type': {'key': 'type', 'type': 'str'},
'identity': {'key': 'identity', 'type': 'Identity'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'user_email': {'key': 'properties.userEmail', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, identity, location: str=None, tags=None, **kwargs) -> None:
super(Account, self).__init__(location=location, tags=tags, **kwargs)
self.identity = identity
self.created_at = None
self.provisioning_state = None
self.user_email = None
self.user_name = None
[docs]class AccountUpdateParameters(Model):
"""Update parameters for accounts.
:param tags: Tags on the azure resource.
:type tags: dict[str, str]
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, tags=None, **kwargs) -> None:
super(AccountUpdateParameters, self).__init__(**kwargs)
self.tags = tags
[docs]class ProxyDto(Model):
"""Base data transfer object implementation for proxy resources.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ProxyDto, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class DataSet(ProxyDto):
"""A DataSet data transfer object.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: BlobDataSet, BlobFolderDataSet, BlobContainerDataSet,
ADLSGen2FileDataSet, ADLSGen2FolderDataSet, ADLSGen2FileSystemDataSet,
ADLSGen1FolderDataSet, ADLSGen1FileDataSet, KustoClusterDataSet,
KustoDatabaseDataSet, SqlDWTableDataSet, SqlDBTableDataSet
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
}
_subtype_map = {
'kind': {'Blob': 'BlobDataSet', 'BlobFolder': 'BlobFolderDataSet', 'Container': 'BlobContainerDataSet', 'AdlsGen2File': 'ADLSGen2FileDataSet', 'AdlsGen2Folder': 'ADLSGen2FolderDataSet', 'AdlsGen2FileSystem': 'ADLSGen2FileSystemDataSet', 'AdlsGen1Folder': 'ADLSGen1FolderDataSet', 'AdlsGen1File': 'ADLSGen1FileDataSet', 'KustoCluster': 'KustoClusterDataSet', 'KustoDatabase': 'KustoDatabaseDataSet', 'SqlDWTable': 'SqlDWTableDataSet', 'SqlDBTable': 'SqlDBTableDataSet'}
}
def __init__(self, **kwargs) -> None:
super(DataSet, self).__init__(**kwargs)
self.kind = None
self.kind = 'DataSet'
[docs]class ADLSGen1FileDataSet(DataSet):
"""An ADLS Gen 1 file data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param account_name: Required. The ADLS account name.
:type account_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param file_name: Required. The file name in the ADLS account.
:type file_name: str
:param folder_path: Required. The folder path within the ADLS account.
:type folder_path: str
:param resource_group: Required. Resource group of ADLS account.
:type resource_group: str
:param subscription_id: Required. Subscription id of ADLS account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'account_name': {'required': True},
'data_set_id': {'readonly': True},
'file_name': {'required': True},
'folder_path': {'required': True},
'resource_group': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'account_name': {'key': 'properties.accountName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'file_name': {'key': 'properties.fileName', 'type': 'str'},
'folder_path': {'key': 'properties.folderPath', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, account_name: str, file_name: str, folder_path: str, resource_group: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen1FileDataSet, self).__init__(**kwargs)
self.account_name = account_name
self.data_set_id = None
self.file_name = file_name
self.folder_path = folder_path
self.resource_group = resource_group
self.subscription_id = subscription_id
self.kind = 'AdlsGen1File'
[docs]class ADLSGen1FolderDataSet(DataSet):
"""An ADLS Gen 1 folder data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param account_name: Required. The ADLS account name.
:type account_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param folder_path: Required. The folder path within the ADLS account.
:type folder_path: str
:param resource_group: Required. Resource group of ADLS account.
:type resource_group: str
:param subscription_id: Required. Subscription id of ADLS account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'account_name': {'required': True},
'data_set_id': {'readonly': True},
'folder_path': {'required': True},
'resource_group': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'account_name': {'key': 'properties.accountName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'folder_path': {'key': 'properties.folderPath', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, account_name: str, folder_path: str, resource_group: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen1FolderDataSet, self).__init__(**kwargs)
self.account_name = account_name
self.data_set_id = None
self.folder_path = folder_path
self.resource_group = resource_group
self.subscription_id = subscription_id
self.kind = 'AdlsGen1Folder'
[docs]class ADLSGen2FileDataSet(DataSet):
"""An ADLS Gen 2 file data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param file_path: Required. File path within the file system.
:type file_path: str
:param file_system: Required. File system to which the file belongs.
:type file_system: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'file_path': {'required': True},
'file_system': {'required': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'file_path': {'key': 'properties.filePath', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, file_path: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen2FileDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.file_path = file_path
self.file_system = file_system
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2File'
[docs]class DataSetMapping(ProxyDto):
"""A data set mapping data transfer object.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: BlobDataSetMapping, BlobFolderDataSetMapping,
BlobContainerDataSetMapping, ADLSGen2FileDataSetMapping,
ADLSGen2FolderDataSetMapping, ADLSGen2FileSystemDataSetMapping,
KustoClusterDataSetMapping, KustoDatabaseDataSetMapping,
SqlDWTableDataSetMapping, SqlDBTableDataSetMapping
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
}
_subtype_map = {
'kind': {'Blob': 'BlobDataSetMapping', 'BlobFolder': 'BlobFolderDataSetMapping', 'Container': 'BlobContainerDataSetMapping', 'AdlsGen2File': 'ADLSGen2FileDataSetMapping', 'AdlsGen2Folder': 'ADLSGen2FolderDataSetMapping', 'AdlsGen2FileSystem': 'ADLSGen2FileSystemDataSetMapping', 'KustoCluster': 'KustoClusterDataSetMapping', 'KustoDatabase': 'KustoDatabaseDataSetMapping', 'SqlDWTable': 'SqlDWTableDataSetMapping', 'SqlDBTable': 'SqlDBTableDataSetMapping'}
}
def __init__(self, **kwargs) -> None:
super(DataSetMapping, self).__init__(**kwargs)
self.kind = None
self.kind = 'DataSetMapping'
[docs]class ADLSGen2FileDataSetMapping(DataSetMapping):
"""An ADLS Gen2 file data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param file_path: Required. File path within the file system.
:type file_path: str
:param file_system: Required. File system to which the file belongs.
:type file_system: str
:param output_type: Type of output file. Possible values include: 'Csv',
'Parquet'
:type output_type: str or ~azure.mgmt.datashare.models.OutputType
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'file_path': {'required': True},
'file_system': {'required': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'file_path': {'key': 'properties.filePath', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'output_type': {'key': 'properties.outputType', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, file_path: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, output_type=None, **kwargs) -> None:
super(ADLSGen2FileDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.file_path = file_path
self.file_system = file_system
self.output_type = output_type
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2File'
[docs]class ADLSGen2FileSystemDataSet(DataSet):
"""An ADLS Gen 2 file system data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param file_system: Required. The file system name.
:type file_system: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'file_system': {'required': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen2FileSystemDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.file_system = file_system
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2FileSystem'
[docs]class ADLSGen2FileSystemDataSetMapping(DataSetMapping):
"""An ADLS Gen2 file system data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param file_system: Required. The file system name.
:type file_system: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'file_system': {'required': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen2FileSystemDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.file_system = file_system
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2FileSystem'
[docs]class ADLSGen2FolderDataSet(DataSet):
"""An ADLS Gen 2 folder data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param file_system: Required. File system to which the folder belongs.
:type file_system: str
:param folder_path: Required. Folder path within the file system.
:type folder_path: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'file_system': {'required': True},
'folder_path': {'required': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'folder_path': {'key': 'properties.folderPath', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, file_system: str, folder_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen2FolderDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.file_system = file_system
self.folder_path = folder_path
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2Folder'
[docs]class ADLSGen2FolderDataSetMapping(DataSetMapping):
"""An ADLS Gen2 folder data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param file_system: Required. File system to which the folder belongs.
:type file_system: str
:param folder_path: Required. Folder path within the file system.
:type folder_path: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'file_system': {'required': True},
'folder_path': {'required': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'file_system': {'key': 'properties.fileSystem', 'type': 'str'},
'folder_path': {'key': 'properties.folderPath', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, file_system: str, folder_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(ADLSGen2FolderDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.file_system = file_system
self.folder_path = folder_path
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'AdlsGen2Folder'
[docs]class BlobContainerDataSet(DataSet):
"""An Azure storage blob container data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. BLOB Container name.
:type container_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(BlobContainerDataSet, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'Container'
[docs]class BlobContainerDataSetMapping(DataSetMapping):
"""A Blob container data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. BLOB Container name.
:type container_name: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, data_set_id: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(BlobContainerDataSetMapping, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'Container'
[docs]class BlobDataSet(DataSet):
"""An Azure storage blob data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. Container that has the file path.
:type container_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param file_path: Required. File path within the source data set
:type file_path: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'readonly': True},
'file_path': {'required': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'file_path': {'key': 'properties.filePath', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, file_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(BlobDataSet, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = None
self.file_path = file_path
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'Blob'
[docs]class BlobDataSetMapping(DataSetMapping):
"""A Blob data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. Container that has the file path.
:type container_name: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param file_path: Required. File path within the source data set
:type file_path: str
:param output_type: File output type. Possible values include: 'Csv',
'Parquet'
:type output_type: str or ~azure.mgmt.datashare.models.OutputType
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'file_path': {'required': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'file_path': {'key': 'properties.filePath', 'type': 'str'},
'output_type': {'key': 'properties.outputType', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, data_set_id: str, file_path: str, resource_group: str, storage_account_name: str, subscription_id: str, output_type=None, **kwargs) -> None:
super(BlobDataSetMapping, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.file_path = file_path
self.output_type = output_type
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'Blob'
[docs]class BlobFolderDataSet(DataSet):
"""An Azure storage blob folder data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. Container that has the file path.
:type container_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param prefix: Required. Prefix for blob folder
:type prefix: str
:param resource_group: Required. Resource group of storage account
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'readonly': True},
'prefix': {'required': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'prefix': {'key': 'properties.prefix', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, prefix: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(BlobFolderDataSet, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = None
self.prefix = prefix
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'BlobFolder'
[docs]class BlobFolderDataSetMapping(DataSetMapping):
"""A Blob folder data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param container_name: Required. Container that has the file path.
:type container_name: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param prefix: Required. Prefix for blob folder
:type prefix: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param resource_group: Required. Resource group of storage account.
:type resource_group: str
:param storage_account_name: Required. Storage account name of the source
data set.
:type storage_account_name: str
:param subscription_id: Required. Subscription id of storage account.
:type subscription_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'container_name': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'prefix': {'required': True},
'provisioning_state': {'readonly': True},
'resource_group': {'required': True},
'storage_account_name': {'required': True},
'subscription_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'container_name': {'key': 'properties.containerName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'prefix': {'key': 'properties.prefix', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'resource_group': {'key': 'properties.resourceGroup', 'type': 'str'},
'storage_account_name': {'key': 'properties.storageAccountName', 'type': 'str'},
'subscription_id': {'key': 'properties.subscriptionId', 'type': 'str'},
}
def __init__(self, *, container_name: str, data_set_id: str, prefix: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs) -> None:
super(BlobFolderDataSetMapping, self).__init__(**kwargs)
self.container_name = container_name
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.prefix = prefix
self.provisioning_state = None
self.resource_group = resource_group
self.storage_account_name = storage_account_name
self.subscription_id = subscription_id
self.kind = 'BlobFolder'
class CloudError(Model):
"""CloudError.
"""
_attribute_map = {
}
[docs]class ConsumerInvitation(ProxyDto):
"""A consumer Invitation data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar data_set_count: Number of data sets in a share
:vartype data_set_count: int
:ivar description: Description shared when the invitation was created
:vartype description: str
:param invitation_id: Required. Unique id of the invitation.
:type invitation_id: str
:ivar invitation_status: The status of the invitation. Possible values
include: 'Pending', 'Accepted', 'Rejected', 'Withdrawn'
:vartype invitation_status: str or
~azure.mgmt.datashare.models.InvitationStatus
:ivar location: invitation location
:vartype location: str
:ivar provider_email: Email of the provider who created the resource
:vartype provider_email: str
:ivar provider_name: Name of the provider who created the resource
:vartype provider_name: str
:ivar provider_tenant_name: Tenant name of the provider who created the
resource
:vartype provider_tenant_name: str
:ivar responded_at: The time the recipient responded to the invitation.
:vartype responded_at: datetime
:ivar sent_at: Gets the time at which the invitation was sent.
:vartype sent_at: datetime
:ivar share_name: Gets the source share Name.
:vartype share_name: str
:ivar terms_of_use: Terms of use shared when the invitation was created
:vartype terms_of_use: str
:ivar user_email: Email of the user who created the resource
:vartype user_email: str
:ivar user_name: Name of the user who created the resource
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'data_set_count': {'readonly': True},
'description': {'readonly': True},
'invitation_id': {'required': True},
'invitation_status': {'readonly': True},
'location': {'readonly': True},
'provider_email': {'readonly': True},
'provider_name': {'readonly': True},
'provider_tenant_name': {'readonly': True},
'responded_at': {'readonly': True},
'sent_at': {'readonly': True},
'share_name': {'readonly': True},
'terms_of_use': {'readonly': True},
'user_email': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'data_set_count': {'key': 'properties.dataSetCount', 'type': 'int'},
'description': {'key': 'properties.description', 'type': 'str'},
'invitation_id': {'key': 'properties.invitationId', 'type': 'str'},
'invitation_status': {'key': 'properties.invitationStatus', 'type': 'str'},
'location': {'key': 'properties.location', 'type': 'str'},
'provider_email': {'key': 'properties.providerEmail', 'type': 'str'},
'provider_name': {'key': 'properties.providerName', 'type': 'str'},
'provider_tenant_name': {'key': 'properties.providerTenantName', 'type': 'str'},
'responded_at': {'key': 'properties.respondedAt', 'type': 'iso-8601'},
'sent_at': {'key': 'properties.sentAt', 'type': 'iso-8601'},
'share_name': {'key': 'properties.shareName', 'type': 'str'},
'terms_of_use': {'key': 'properties.termsOfUse', 'type': 'str'},
'user_email': {'key': 'properties.userEmail', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, invitation_id: str, **kwargs) -> None:
super(ConsumerInvitation, self).__init__(**kwargs)
self.data_set_count = None
self.description = None
self.invitation_id = invitation_id
self.invitation_status = None
self.location = None
self.provider_email = None
self.provider_name = None
self.provider_tenant_name = None
self.responded_at = None
self.sent_at = None
self.share_name = None
self.terms_of_use = None
self.user_email = None
self.user_name = None
[docs]class ConsumerSourceDataSet(ProxyDto):
"""A consumer side dataSet data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar data_set_id: DataSet Id
:vartype data_set_id: str
:ivar data_set_location: Location of the data set.
:vartype data_set_location: str
:ivar data_set_name: DataSet name
:vartype data_set_name: str
:ivar data_set_path: DataSet path
:vartype data_set_path: str
:ivar data_set_type: Type of data set. Possible values include: 'Blob',
'Container', 'BlobFolder', 'AdlsGen2FileSystem', 'AdlsGen2Folder',
'AdlsGen2File', 'AdlsGen1Folder', 'AdlsGen1File', 'KustoCluster',
'KustoDatabase', 'SqlDBTable', 'SqlDWTable'
:vartype data_set_type: str or ~azure.mgmt.datashare.models.DataSetType
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'data_set_id': {'readonly': True},
'data_set_location': {'readonly': True},
'data_set_name': {'readonly': True},
'data_set_path': {'readonly': True},
'data_set_type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_location': {'key': 'properties.dataSetLocation', 'type': 'str'},
'data_set_name': {'key': 'properties.dataSetName', 'type': 'str'},
'data_set_path': {'key': 'properties.dataSetPath', 'type': 'str'},
'data_set_type': {'key': 'properties.dataSetType', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ConsumerSourceDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.data_set_location = None
self.data_set_name = None
self.data_set_path = None
self.data_set_type = None
[docs]class DataShareError(Model):
"""The data share error model.
All required parameters must be populated in order to send to Azure.
:param error: Required. The data share error body
:type error: ~azure.mgmt.datashare.models.DataShareErrorInfo
"""
_validation = {
'error': {'required': True},
}
_attribute_map = {
'error': {'key': 'error', 'type': 'DataShareErrorInfo'},
}
def __init__(self, *, error, **kwargs) -> None:
super(DataShareError, self).__init__(**kwargs)
self.error = error
[docs]class DataShareErrorException(HttpOperationError):
"""Server responsed with exception of type: 'DataShareError'.
:param deserialize: A deserializer
:param response: Server response to be deserialized.
"""
def __init__(self, deserialize, response, *args):
super(DataShareErrorException, self).__init__(deserialize, response, 'DataShareError', *args)
[docs]class DataShareErrorInfo(Model):
"""The data share error body model.
All required parameters must be populated in order to send to Azure.
:param code: Required. Code of the error
:type code: str
:param details: Nested details of the error model
:type details: list[~azure.mgmt.datashare.models.DataShareErrorInfo]
:param message: Required. Message of the error
:type message: str
:param target: Target of the error
:type target: str
"""
_validation = {
'code': {'required': True},
'message': {'required': True},
}
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'details': {'key': 'details', 'type': '[DataShareErrorInfo]'},
'message': {'key': 'message', 'type': 'str'},
'target': {'key': 'target', 'type': 'str'},
}
def __init__(self, *, code: str, message: str, details=None, target: str=None, **kwargs) -> None:
super(DataShareErrorInfo, self).__init__(**kwargs)
self.code = code
self.details = details
self.message = message
self.target = target
[docs]class DimensionProperties(Model):
"""properties for dimension.
:param display_name: localized display name of the dimension to customer
:type display_name: str
:param name: dimension name
:type name: str
"""
_attribute_map = {
'display_name': {'key': 'displayName', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
}
def __init__(self, *, display_name: str=None, name: str=None, **kwargs) -> None:
super(DimensionProperties, self).__init__(**kwargs)
self.display_name = display_name
self.name = name
[docs]class Identity(Model):
"""Identity of resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar principal_id: service principal Id
:vartype principal_id: str
:ivar tenant_id: Tenant Id
:vartype tenant_id: str
:param type: Identity Type. Possible values include: 'SystemAssigned'
:type type: str or ~azure.mgmt.datashare.models.Type
"""
_validation = {
'principal_id': {'readonly': True},
'tenant_id': {'readonly': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, type=None, **kwargs) -> None:
super(Identity, self).__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
[docs]class Invitation(ProxyDto):
"""A Invitation data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar invitation_id: unique invitation id
:vartype invitation_id: str
:ivar invitation_status: The status of the invitation. Possible values
include: 'Pending', 'Accepted', 'Rejected', 'Withdrawn'
:vartype invitation_status: str or
~azure.mgmt.datashare.models.InvitationStatus
:ivar responded_at: The time the recipient responded to the invitation.
:vartype responded_at: datetime
:ivar sent_at: Gets the time at which the invitation was sent.
:vartype sent_at: datetime
:param target_active_directory_id: The target Azure AD Id. Can't be
combined with email.
:type target_active_directory_id: str
:param target_email: The email the invitation is directed to.
:type target_email: str
:param target_object_id: The target user or application Id that invitation
is being sent to.
Must be specified along TargetActiveDirectoryId. This enables sending
invitations to specific users or applications in an AD tenant.
:type target_object_id: str
:ivar user_email: Email of the user who created the resource
:vartype user_email: str
:ivar user_name: Name of the user who created the resource
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'invitation_id': {'readonly': True},
'invitation_status': {'readonly': True},
'responded_at': {'readonly': True},
'sent_at': {'readonly': True},
'user_email': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'invitation_id': {'key': 'properties.invitationId', 'type': 'str'},
'invitation_status': {'key': 'properties.invitationStatus', 'type': 'str'},
'responded_at': {'key': 'properties.respondedAt', 'type': 'iso-8601'},
'sent_at': {'key': 'properties.sentAt', 'type': 'iso-8601'},
'target_active_directory_id': {'key': 'properties.targetActiveDirectoryId', 'type': 'str'},
'target_email': {'key': 'properties.targetEmail', 'type': 'str'},
'target_object_id': {'key': 'properties.targetObjectId', 'type': 'str'},
'user_email': {'key': 'properties.userEmail', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, target_active_directory_id: str=None, target_email: str=None, target_object_id: str=None, **kwargs) -> None:
super(Invitation, self).__init__(**kwargs)
self.invitation_id = None
self.invitation_status = None
self.responded_at = None
self.sent_at = None
self.target_active_directory_id = target_active_directory_id
self.target_email = target_email
self.target_object_id = target_object_id
self.user_email = None
self.user_name = None
[docs]class KustoClusterDataSet(DataSet):
"""A kusto cluster data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param kusto_cluster_resource_id: Required. Resource id of the kusto
cluster.
:type kusto_cluster_resource_id: str
:ivar location: Location of the kusto cluster.
:vartype location: str
:ivar provisioning_state: Provisioning state of the kusto cluster data
set. Possible values include: 'Succeeded', 'Creating', 'Deleting',
'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'kusto_cluster_resource_id': {'required': True},
'location': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'kusto_cluster_resource_id': {'key': 'properties.kustoClusterResourceId', 'type': 'str'},
'location': {'key': 'properties.location', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, kusto_cluster_resource_id: str, **kwargs) -> None:
super(KustoClusterDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.kusto_cluster_resource_id = kusto_cluster_resource_id
self.location = None
self.provisioning_state = None
self.kind = 'KustoCluster'
[docs]class KustoClusterDataSetMapping(DataSetMapping):
"""A Kusto cluster data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param kusto_cluster_resource_id: Required. Resource id of the sink kusto
cluster.
:type kusto_cluster_resource_id: str
:ivar location: Location of the sink kusto cluster.
:vartype location: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'kusto_cluster_resource_id': {'required': True},
'location': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'kusto_cluster_resource_id': {'key': 'properties.kustoClusterResourceId', 'type': 'str'},
'location': {'key': 'properties.location', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, kusto_cluster_resource_id: str, **kwargs) -> None:
super(KustoClusterDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.kusto_cluster_resource_id = kusto_cluster_resource_id
self.location = None
self.provisioning_state = None
self.kind = 'KustoCluster'
[docs]class KustoDatabaseDataSet(DataSet):
"""A kusto database data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param kusto_database_resource_id: Required. Resource id of the kusto
database.
:type kusto_database_resource_id: str
:ivar location: Location of the kusto cluster.
:vartype location: str
:ivar provisioning_state: Provisioning state of the kusto database data
set. Possible values include: 'Succeeded', 'Creating', 'Deleting',
'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'kusto_database_resource_id': {'required': True},
'location': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'kusto_database_resource_id': {'key': 'properties.kustoDatabaseResourceId', 'type': 'str'},
'location': {'key': 'properties.location', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, kusto_database_resource_id: str, **kwargs) -> None:
super(KustoDatabaseDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.kusto_database_resource_id = kusto_database_resource_id
self.location = None
self.provisioning_state = None
self.kind = 'KustoDatabase'
[docs]class KustoDatabaseDataSetMapping(DataSetMapping):
"""A Kusto database data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param kusto_cluster_resource_id: Required. Resource id of the sink kusto
cluster.
:type kusto_cluster_resource_id: str
:ivar location: Location of the sink kusto cluster.
:vartype location: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'kusto_cluster_resource_id': {'required': True},
'location': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'kusto_cluster_resource_id': {'key': 'properties.kustoClusterResourceId', 'type': 'str'},
'location': {'key': 'properties.location', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, kusto_cluster_resource_id: str, **kwargs) -> None:
super(KustoDatabaseDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.kusto_cluster_resource_id = kusto_cluster_resource_id
self.location = None
self.provisioning_state = None
self.kind = 'KustoDatabase'
[docs]class OperationModel(Model):
"""The response model for get operations.
:param display: Properties on the operation
:type display: ~azure.mgmt.datashare.models.OperationModelProperties
:param name: Operation name for display purposes
:type name: str
:param origin: origin of the operation
:type origin: str
:param service_specification: meta service specification
:type service_specification:
~azure.mgmt.datashare.models.OperationMetaServiceSpecification
"""
_attribute_map = {
'display': {'key': 'display', 'type': 'OperationModelProperties'},
'name': {'key': 'name', 'type': 'str'},
'origin': {'key': 'origin', 'type': 'str'},
'service_specification': {'key': 'properties.serviceSpecification', 'type': 'OperationMetaServiceSpecification'},
}
def __init__(self, *, display=None, name: str=None, origin: str=None, service_specification=None, **kwargs) -> None:
super(OperationModel, self).__init__(**kwargs)
self.display = display
self.name = name
self.origin = origin
self.service_specification = service_specification
[docs]class OperationModelProperties(Model):
"""Properties on operations.
:param description: Description of the operation for display purposes
:type description: str
:param operation: Name of the operation for display purposes
:type operation: str
:param provider: Name of the provider for display purposes
:type provider: str
:param resource: Name of the resource type for display purposes
:type resource: str
"""
_attribute_map = {
'description': {'key': 'description', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
}
def __init__(self, *, description: str=None, operation: str=None, provider: str=None, resource: str=None, **kwargs) -> None:
super(OperationModelProperties, self).__init__(**kwargs)
self.description = description
self.operation = operation
self.provider = provider
self.resource = resource
[docs]class OperationResponse(Model):
"""Response for long running operation.
All required parameters must be populated in order to send to Azure.
:param end_time: start time
:type end_time: datetime
:param error: The error property when status is failed.
:type error: ~azure.mgmt.datashare.models.DataShareErrorInfo
:param start_time: start time
:type start_time: datetime
:param status: Required. Operation state of the long running operation.
Possible values include: 'Accepted', 'InProgress', 'TransientFailure',
'Succeeded', 'Failed', 'Canceled'
:type status: str or ~azure.mgmt.datashare.models.Status
"""
_validation = {
'status': {'required': True},
}
_attribute_map = {
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'error': {'key': 'error', 'type': 'DataShareErrorInfo'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
}
def __init__(self, *, status, end_time=None, error=None, start_time=None, **kwargs) -> None:
super(OperationResponse, self).__init__(**kwargs)
self.end_time = end_time
self.error = error
self.start_time = start_time
self.status = status
[docs]class ProviderShareSubscription(ProxyDto):
"""A provider side share subscription data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar consumer_email: Email of the consumer who created the share
subscription
:vartype consumer_email: str
:ivar consumer_name: Name of the consumer who created the share
subscription
:vartype consumer_name: str
:ivar consumer_tenant_name: Tenant name of the consumer who created the
share subscription
:vartype consumer_tenant_name: str
:ivar created_at: created at
:vartype created_at: datetime
:ivar provider_email: Email of the provider who created the share
:vartype provider_email: str
:ivar provider_name: Name of the provider who created the share
:vartype provider_name: str
:ivar shared_at: Shared at
:vartype shared_at: datetime
:ivar share_subscription_object_id: share Subscription Object Id
:vartype share_subscription_object_id: str
:ivar share_subscription_status: Gets the status of share subscription.
Possible values include: 'Active', 'Revoked', 'SourceDeleted', 'Revoking'
:vartype share_subscription_status: str or
~azure.mgmt.datashare.models.ShareSubscriptionStatus
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'consumer_email': {'readonly': True},
'consumer_name': {'readonly': True},
'consumer_tenant_name': {'readonly': True},
'created_at': {'readonly': True},
'provider_email': {'readonly': True},
'provider_name': {'readonly': True},
'shared_at': {'readonly': True},
'share_subscription_object_id': {'readonly': True},
'share_subscription_status': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'consumer_email': {'key': 'properties.consumerEmail', 'type': 'str'},
'consumer_name': {'key': 'properties.consumerName', 'type': 'str'},
'consumer_tenant_name': {'key': 'properties.consumerTenantName', 'type': 'str'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'provider_email': {'key': 'properties.providerEmail', 'type': 'str'},
'provider_name': {'key': 'properties.providerName', 'type': 'str'},
'shared_at': {'key': 'properties.sharedAt', 'type': 'iso-8601'},
'share_subscription_object_id': {'key': 'properties.shareSubscriptionObjectId', 'type': 'str'},
'share_subscription_status': {'key': 'properties.shareSubscriptionStatus', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ProviderShareSubscription, self).__init__(**kwargs)
self.consumer_email = None
self.consumer_name = None
self.consumer_tenant_name = None
self.created_at = None
self.provider_email = None
self.provider_name = None
self.shared_at = None
self.share_subscription_object_id = None
self.share_subscription_status = None
[docs]class SourceShareSynchronizationSetting(Model):
"""A view of synchronization setting added by the provider.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: ScheduledSourceSynchronizationSetting
All required parameters must be populated in order to send to Azure.
:param kind: Required. Constant filled by server.
:type kind: str
"""
_validation = {
'kind': {'required': True},
}
_attribute_map = {
'kind': {'key': 'kind', 'type': 'str'},
}
_subtype_map = {
'kind': {'ScheduleBased': 'ScheduledSourceSynchronizationSetting'}
}
def __init__(self, **kwargs) -> None:
super(SourceShareSynchronizationSetting, self).__init__(**kwargs)
self.kind = None
[docs]class ScheduledSourceSynchronizationSetting(SourceShareSynchronizationSetting):
"""A type of synchronization setting based on schedule.
All required parameters must be populated in order to send to Azure.
:param kind: Required. Constant filled by server.
:type kind: str
:param recurrence_interval: Recurrence Interval. Possible values include:
'Hour', 'Day'
:type recurrence_interval: str or
~azure.mgmt.datashare.models.RecurrenceInterval
:param synchronization_time: Synchronization time
:type synchronization_time: datetime
"""
_validation = {
'kind': {'required': True},
}
_attribute_map = {
'kind': {'key': 'kind', 'type': 'str'},
'recurrence_interval': {'key': 'properties.recurrenceInterval', 'type': 'str'},
'synchronization_time': {'key': 'properties.synchronizationTime', 'type': 'iso-8601'},
}
def __init__(self, *, recurrence_interval=None, synchronization_time=None, **kwargs) -> None:
super(ScheduledSourceSynchronizationSetting, self).__init__(**kwargs)
self.recurrence_interval = recurrence_interval
self.synchronization_time = synchronization_time
self.kind = 'ScheduleBased'
[docs]class SynchronizationSetting(ProxyDto):
"""A Synchronization Setting data transfer object.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: ScheduledSynchronizationSetting
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
}
_subtype_map = {
'kind': {'ScheduleBased': 'ScheduledSynchronizationSetting'}
}
def __init__(self, **kwargs) -> None:
super(SynchronizationSetting, self).__init__(**kwargs)
self.kind = None
self.kind = 'SynchronizationSetting'
[docs]class ScheduledSynchronizationSetting(SynchronizationSetting):
"""A type of synchronization setting based on schedule.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar created_at: Time at which the synchronization setting was created.
:vartype created_at: datetime
:ivar provisioning_state: Gets or sets the provisioning state. Possible
values include: 'Succeeded', 'Creating', 'Deleting', 'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param recurrence_interval: Required. Recurrence Interval. Possible values
include: 'Hour', 'Day'
:type recurrence_interval: str or
~azure.mgmt.datashare.models.RecurrenceInterval
:param synchronization_time: Required. Synchronization time
:type synchronization_time: datetime
:ivar user_name: Name of the user who created the synchronization setting.
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'created_at': {'readonly': True},
'provisioning_state': {'readonly': True},
'recurrence_interval': {'required': True},
'synchronization_time': {'required': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'recurrence_interval': {'key': 'properties.recurrenceInterval', 'type': 'str'},
'synchronization_time': {'key': 'properties.synchronizationTime', 'type': 'iso-8601'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, recurrence_interval, synchronization_time, **kwargs) -> None:
super(ScheduledSynchronizationSetting, self).__init__(**kwargs)
self.created_at = None
self.provisioning_state = None
self.recurrence_interval = recurrence_interval
self.synchronization_time = synchronization_time
self.user_name = None
self.kind = 'ScheduleBased'
[docs]class Trigger(ProxyDto):
"""A Trigger data transfer object.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: ScheduledTrigger
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
}
_subtype_map = {
'kind': {'ScheduleBased': 'ScheduledTrigger'}
}
def __init__(self, **kwargs) -> None:
super(Trigger, self).__init__(**kwargs)
self.kind = None
self.kind = 'Trigger'
[docs]class ScheduledTrigger(Trigger):
"""A type of trigger based on schedule.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar created_at: Time at which the trigger was created.
:vartype created_at: datetime
:ivar provisioning_state: Gets the provisioning state. Possible values
include: 'Succeeded', 'Creating', 'Deleting', 'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param recurrence_interval: Required. Recurrence Interval. Possible values
include: 'Hour', 'Day'
:type recurrence_interval: str or
~azure.mgmt.datashare.models.RecurrenceInterval
:param synchronization_mode: Synchronization mode. Possible values
include: 'Incremental', 'FullSync'
:type synchronization_mode: str or
~azure.mgmt.datashare.models.SynchronizationMode
:param synchronization_time: Required. Synchronization time
:type synchronization_time: datetime
:ivar trigger_status: Gets the trigger state. Possible values include:
'Active', 'Inactive', 'SourceSynchronizationSettingDeleted'
:vartype trigger_status: str or ~azure.mgmt.datashare.models.TriggerStatus
:ivar user_name: Name of the user who created the trigger.
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'created_at': {'readonly': True},
'provisioning_state': {'readonly': True},
'recurrence_interval': {'required': True},
'synchronization_time': {'required': True},
'trigger_status': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'recurrence_interval': {'key': 'properties.recurrenceInterval', 'type': 'str'},
'synchronization_mode': {'key': 'properties.synchronizationMode', 'type': 'str'},
'synchronization_time': {'key': 'properties.synchronizationTime', 'type': 'iso-8601'},
'trigger_status': {'key': 'properties.triggerStatus', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, recurrence_interval, synchronization_time, synchronization_mode=None, **kwargs) -> None:
super(ScheduledTrigger, self).__init__(**kwargs)
self.created_at = None
self.provisioning_state = None
self.recurrence_interval = recurrence_interval
self.synchronization_mode = synchronization_mode
self.synchronization_time = synchronization_time
self.trigger_status = None
self.user_name = None
self.kind = 'ScheduleBased'
[docs]class Share(ProxyDto):
"""A share data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar created_at: Time at which the share was created.
:vartype created_at: datetime
:param description: Share description.
:type description: str
:ivar provisioning_state: Gets or sets the provisioning state. Possible
values include: 'Succeeded', 'Creating', 'Deleting', 'Moving', 'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param share_kind: Share kind. Possible values include: 'CopyBased',
'InPlace'
:type share_kind: str or ~azure.mgmt.datashare.models.ShareKind
:param terms: Share terms.
:type terms: str
:ivar user_email: Email of the user who created the resource
:vartype user_email: str
:ivar user_name: Name of the user who created the resource
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'created_at': {'readonly': True},
'provisioning_state': {'readonly': True},
'user_email': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'description': {'key': 'properties.description', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'share_kind': {'key': 'properties.shareKind', 'type': 'str'},
'terms': {'key': 'properties.terms', 'type': 'str'},
'user_email': {'key': 'properties.userEmail', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, description: str=None, share_kind=None, terms: str=None, **kwargs) -> None:
super(Share, self).__init__(**kwargs)
self.created_at = None
self.description = description
self.provisioning_state = None
self.share_kind = share_kind
self.terms = terms
self.user_email = None
self.user_name = None
[docs]class ShareSubscription(ProxyDto):
"""A share subscription data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:ivar created_at: Time at which the share subscription was created.
:vartype created_at: datetime
:param invitation_id: Required. The invitation id.
:type invitation_id: str
:ivar provider_email: Email of the provider who created the resource
:vartype provider_email: str
:ivar provider_name: Name of the provider who created the resource
:vartype provider_name: str
:ivar provider_tenant_name: Tenant name of the provider who created the
resource
:vartype provider_tenant_name: str
:ivar provisioning_state: Provisioning state of the share subscription.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:ivar share_description: Description of share
:vartype share_description: str
:ivar share_kind: Kind of share. Possible values include: 'CopyBased',
'InPlace'
:vartype share_kind: str or ~azure.mgmt.datashare.models.ShareKind
:ivar share_name: Name of the share
:vartype share_name: str
:ivar share_subscription_status: Gets the current status of share
subscription. Possible values include: 'Active', 'Revoked',
'SourceDeleted', 'Revoking'
:vartype share_subscription_status: str or
~azure.mgmt.datashare.models.ShareSubscriptionStatus
:ivar share_terms: Terms of a share
:vartype share_terms: str
:param source_share_location: Required. Source share location.
:type source_share_location: str
:ivar user_email: Email of the user who created the resource
:vartype user_email: str
:ivar user_name: Name of the user who created the resource
:vartype user_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'created_at': {'readonly': True},
'invitation_id': {'required': True},
'provider_email': {'readonly': True},
'provider_name': {'readonly': True},
'provider_tenant_name': {'readonly': True},
'provisioning_state': {'readonly': True},
'share_description': {'readonly': True},
'share_kind': {'readonly': True},
'share_name': {'readonly': True},
'share_subscription_status': {'readonly': True},
'share_terms': {'readonly': True},
'source_share_location': {'required': True},
'user_email': {'readonly': True},
'user_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'created_at': {'key': 'properties.createdAt', 'type': 'iso-8601'},
'invitation_id': {'key': 'properties.invitationId', 'type': 'str'},
'provider_email': {'key': 'properties.providerEmail', 'type': 'str'},
'provider_name': {'key': 'properties.providerName', 'type': 'str'},
'provider_tenant_name': {'key': 'properties.providerTenantName', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'share_description': {'key': 'properties.shareDescription', 'type': 'str'},
'share_kind': {'key': 'properties.shareKind', 'type': 'str'},
'share_name': {'key': 'properties.shareName', 'type': 'str'},
'share_subscription_status': {'key': 'properties.shareSubscriptionStatus', 'type': 'str'},
'share_terms': {'key': 'properties.shareTerms', 'type': 'str'},
'source_share_location': {'key': 'properties.sourceShareLocation', 'type': 'str'},
'user_email': {'key': 'properties.userEmail', 'type': 'str'},
'user_name': {'key': 'properties.userName', 'type': 'str'},
}
def __init__(self, *, invitation_id: str, source_share_location: str, **kwargs) -> None:
super(ShareSubscription, self).__init__(**kwargs)
self.created_at = None
self.invitation_id = invitation_id
self.provider_email = None
self.provider_name = None
self.provider_tenant_name = None
self.provisioning_state = None
self.share_description = None
self.share_kind = None
self.share_name = None
self.share_subscription_status = None
self.share_terms = None
self.source_share_location = source_share_location
self.user_email = None
self.user_name = None
[docs]class ShareSubscriptionSynchronization(Model):
"""A ShareSubscriptionSynchronization data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar duration_ms: Synchronization duration
:vartype duration_ms: int
:ivar end_time: End time of synchronization
:vartype end_time: datetime
:ivar message: message of Synchronization
:vartype message: str
:ivar start_time: start time of synchronization
:vartype start_time: datetime
:ivar status: Raw Status
:vartype status: str
:param synchronization_id: Required. Synchronization id
:type synchronization_id: str
:ivar synchronization_mode: Synchronization Mode. Possible values include:
'Incremental', 'FullSync'
:vartype synchronization_mode: str or
~azure.mgmt.datashare.models.SynchronizationMode
"""
_validation = {
'duration_ms': {'readonly': True},
'end_time': {'readonly': True},
'message': {'readonly': True},
'start_time': {'readonly': True},
'status': {'readonly': True},
'synchronization_id': {'required': True},
'synchronization_mode': {'readonly': True},
}
_attribute_map = {
'duration_ms': {'key': 'durationMs', 'type': 'int'},
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'synchronization_id': {'key': 'synchronizationId', 'type': 'str'},
'synchronization_mode': {'key': 'synchronizationMode', 'type': 'str'},
}
def __init__(self, *, synchronization_id: str, **kwargs) -> None:
super(ShareSubscriptionSynchronization, self).__init__(**kwargs)
self.duration_ms = None
self.end_time = None
self.message = None
self.start_time = None
self.status = None
self.synchronization_id = synchronization_id
self.synchronization_mode = None
[docs]class ShareSynchronization(Model):
"""A ShareSynchronization data transfer object.
Variables are only populated by the server, and will be ignored when
sending a request.
:param consumer_email: Email of the user who created the synchronization
:type consumer_email: str
:param consumer_name: Name of the user who created the synchronization
:type consumer_name: str
:param consumer_tenant_name: Tenant name of the consumer who created the
synchronization
:type consumer_tenant_name: str
:param duration_ms: synchronization duration
:type duration_ms: int
:param end_time: End time of synchronization
:type end_time: datetime
:param message: message of synchronization
:type message: str
:param start_time: start time of synchronization
:type start_time: datetime
:param status: Raw Status
:type status: str
:param synchronization_id: Synchronization id
:type synchronization_id: str
:ivar synchronization_mode: Synchronization mode. Possible values include:
'Incremental', 'FullSync'
:vartype synchronization_mode: str or
~azure.mgmt.datashare.models.SynchronizationMode
"""
_validation = {
'synchronization_mode': {'readonly': True},
}
_attribute_map = {
'consumer_email': {'key': 'consumerEmail', 'type': 'str'},
'consumer_name': {'key': 'consumerName', 'type': 'str'},
'consumer_tenant_name': {'key': 'consumerTenantName', 'type': 'str'},
'duration_ms': {'key': 'durationMs', 'type': 'int'},
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'synchronization_id': {'key': 'synchronizationId', 'type': 'str'},
'synchronization_mode': {'key': 'synchronizationMode', 'type': 'str'},
}
def __init__(self, *, consumer_email: str=None, consumer_name: str=None, consumer_tenant_name: str=None, duration_ms: int=None, end_time=None, message: str=None, start_time=None, status: str=None, synchronization_id: str=None, **kwargs) -> None:
super(ShareSynchronization, self).__init__(**kwargs)
self.consumer_email = consumer_email
self.consumer_name = consumer_name
self.consumer_tenant_name = consumer_tenant_name
self.duration_ms = duration_ms
self.end_time = end_time
self.message = message
self.start_time = start_time
self.status = status
self.synchronization_id = synchronization_id
self.synchronization_mode = None
[docs]class SqlDBTableDataSet(DataSet):
"""A SQL DB table data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param database_name: Required. Database name of the source data set
:type database_name: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param schema_name: Required. Schema of the table. Default value is dbo.
:type schema_name: str
:param sql_server_resource_id: Required. Resource id of SQL server
:type sql_server_resource_id: str
:param table_name: Required. SQL DB table name.
:type table_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'database_name': {'required': True},
'data_set_id': {'readonly': True},
'schema_name': {'required': True},
'sql_server_resource_id': {'required': True},
'table_name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'database_name': {'key': 'properties.databaseName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'schema_name': {'key': 'properties.schemaName', 'type': 'str'},
'sql_server_resource_id': {'key': 'properties.sqlServerResourceId', 'type': 'str'},
'table_name': {'key': 'properties.tableName', 'type': 'str'},
}
def __init__(self, *, database_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs) -> None:
super(SqlDBTableDataSet, self).__init__(**kwargs)
self.database_name = database_name
self.data_set_id = None
self.schema_name = schema_name
self.sql_server_resource_id = sql_server_resource_id
self.table_name = table_name
self.kind = 'SqlDBTable'
[docs]class SqlDBTableDataSetMapping(DataSetMapping):
"""A SQL DB Table data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param database_name: Required. DatabaseName name of the sink data set
:type database_name: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param schema_name: Required. Schema of the table. Default value is dbo.
:type schema_name: str
:param sql_server_resource_id: Required. Resource id of SQL server
:type sql_server_resource_id: str
:param table_name: Required. SQL DB table name.
:type table_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'database_name': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'provisioning_state': {'readonly': True},
'schema_name': {'required': True},
'sql_server_resource_id': {'required': True},
'table_name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'database_name': {'key': 'properties.databaseName', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'schema_name': {'key': 'properties.schemaName', 'type': 'str'},
'sql_server_resource_id': {'key': 'properties.sqlServerResourceId', 'type': 'str'},
'table_name': {'key': 'properties.tableName', 'type': 'str'},
}
def __init__(self, *, database_name: str, data_set_id: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs) -> None:
super(SqlDBTableDataSetMapping, self).__init__(**kwargs)
self.database_name = database_name
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.provisioning_state = None
self.schema_name = schema_name
self.sql_server_resource_id = sql_server_resource_id
self.table_name = table_name
self.kind = 'SqlDBTable'
[docs]class SqlDWTableDataSet(DataSet):
"""A SQL DW table data set.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:ivar data_set_id: Unique id for identifying a data set resource
:vartype data_set_id: str
:param data_warehouse_name: Required. DataWarehouse name of the source
data set
:type data_warehouse_name: str
:param schema_name: Required. Schema of the table. Default value is dbo.
:type schema_name: str
:param sql_server_resource_id: Required. Resource id of SQL server
:type sql_server_resource_id: str
:param table_name: Required. SQL DW table name.
:type table_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'readonly': True},
'data_warehouse_name': {'required': True},
'schema_name': {'required': True},
'sql_server_resource_id': {'required': True},
'table_name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_warehouse_name': {'key': 'properties.dataWarehouseName', 'type': 'str'},
'schema_name': {'key': 'properties.schemaName', 'type': 'str'},
'sql_server_resource_id': {'key': 'properties.sqlServerResourceId', 'type': 'str'},
'table_name': {'key': 'properties.tableName', 'type': 'str'},
}
def __init__(self, *, data_warehouse_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs) -> None:
super(SqlDWTableDataSet, self).__init__(**kwargs)
self.data_set_id = None
self.data_warehouse_name = data_warehouse_name
self.schema_name = schema_name
self.sql_server_resource_id = sql_server_resource_id
self.table_name = table_name
self.kind = 'SqlDWTable'
[docs]class SqlDWTableDataSetMapping(DataSetMapping):
"""A SQL DW Table data set mapping.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: The resource id of the azure resource
:vartype id: str
:ivar name: Name of the azure resource
:vartype name: str
:ivar type: Type of the azure resource
:vartype type: str
:param kind: Required. Constant filled by server.
:type kind: str
:param data_set_id: Required. The id of the source data set.
:type data_set_id: str
:ivar data_set_mapping_status: Gets the status of the data set mapping.
Possible values include: 'Ok', 'Broken'
:vartype data_set_mapping_status: str or
~azure.mgmt.datashare.models.DataSetMappingStatus
:param data_warehouse_name: Required. DataWarehouse name of the source
data set
:type data_warehouse_name: str
:ivar provisioning_state: Provisioning state of the data set mapping.
Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Moving',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datashare.models.ProvisioningState
:param schema_name: Required. Schema of the table. Default value is dbo.
:type schema_name: str
:param sql_server_resource_id: Required. Resource id of SQL server
:type sql_server_resource_id: str
:param table_name: Required. SQL DW table name.
:type table_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'kind': {'required': True},
'data_set_id': {'required': True},
'data_set_mapping_status': {'readonly': True},
'data_warehouse_name': {'required': True},
'provisioning_state': {'readonly': True},
'schema_name': {'required': True},
'sql_server_resource_id': {'required': True},
'table_name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'data_set_id': {'key': 'properties.dataSetId', 'type': 'str'},
'data_set_mapping_status': {'key': 'properties.dataSetMappingStatus', 'type': 'str'},
'data_warehouse_name': {'key': 'properties.dataWarehouseName', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'schema_name': {'key': 'properties.schemaName', 'type': 'str'},
'sql_server_resource_id': {'key': 'properties.sqlServerResourceId', 'type': 'str'},
'table_name': {'key': 'properties.tableName', 'type': 'str'},
}
def __init__(self, *, data_set_id: str, data_warehouse_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs) -> None:
super(SqlDWTableDataSetMapping, self).__init__(**kwargs)
self.data_set_id = data_set_id
self.data_set_mapping_status = None
self.data_warehouse_name = data_warehouse_name
self.provisioning_state = None
self.schema_name = schema_name
self.sql_server_resource_id = sql_server_resource_id
self.table_name = table_name
self.kind = 'SqlDWTable'
[docs]class SynchronizationDetails(Model):
"""Synchronization details at data set level.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar data_set_id: Id of data set
:vartype data_set_id: str
:ivar data_set_type: Type of the data set. Possible values include:
'Blob', 'Container', 'BlobFolder', 'AdlsGen2FileSystem', 'AdlsGen2Folder',
'AdlsGen2File', 'AdlsGen1Folder', 'AdlsGen1File', 'KustoCluster',
'KustoDatabase', 'SqlDBTable', 'SqlDWTable'
:vartype data_set_type: str or ~azure.mgmt.datashare.models.DataSetType
:ivar duration_ms: Duration of data set level copy
:vartype duration_ms: int
:ivar end_time: End time of data set level copy
:vartype end_time: datetime
:ivar files_read: The number of files read from the source data set
:vartype files_read: long
:ivar files_written: The number of files written into the sink data set
:vartype files_written: long
:ivar message: Error message if any
:vartype message: str
:ivar name: Name of the data set
:vartype name: str
:ivar rows_copied: The number of files copied into the sink data set
:vartype rows_copied: long
:ivar rows_read: The number of rows read from the source data set.
:vartype rows_read: long
:ivar size_read: The size of the data read from the source data set in
bytes
:vartype size_read: long
:ivar size_written: The size of the data written into the sink data set in
bytes
:vartype size_written: long
:ivar start_time: Start time of data set level copy
:vartype start_time: datetime
:ivar status: Raw Status
:vartype status: str
:ivar v_core: The vCore units consumed for the data set synchronization
:vartype v_core: long
"""
_validation = {
'data_set_id': {'readonly': True},
'data_set_type': {'readonly': True},
'duration_ms': {'readonly': True},
'end_time': {'readonly': True},
'files_read': {'readonly': True},
'files_written': {'readonly': True},
'message': {'readonly': True},
'name': {'readonly': True},
'rows_copied': {'readonly': True},
'rows_read': {'readonly': True},
'size_read': {'readonly': True},
'size_written': {'readonly': True},
'start_time': {'readonly': True},
'status': {'readonly': True},
'v_core': {'readonly': True},
}
_attribute_map = {
'data_set_id': {'key': 'dataSetId', 'type': 'str'},
'data_set_type': {'key': 'dataSetType', 'type': 'str'},
'duration_ms': {'key': 'durationMs', 'type': 'int'},
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'files_read': {'key': 'filesRead', 'type': 'long'},
'files_written': {'key': 'filesWritten', 'type': 'long'},
'message': {'key': 'message', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'rows_copied': {'key': 'rowsCopied', 'type': 'long'},
'rows_read': {'key': 'rowsRead', 'type': 'long'},
'size_read': {'key': 'sizeRead', 'type': 'long'},
'size_written': {'key': 'sizeWritten', 'type': 'long'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'v_core': {'key': 'vCore', 'type': 'long'},
}
def __init__(self, **kwargs) -> None:
super(SynchronizationDetails, self).__init__(**kwargs)
self.data_set_id = None
self.data_set_type = None
self.duration_ms = None
self.end_time = None
self.files_read = None
self.files_written = None
self.message = None
self.name = None
self.rows_copied = None
self.rows_read = None
self.size_read = None
self.size_written = None
self.start_time = None
self.status = None
self.v_core = None
[docs]class Synchronize(Model):
"""Payload for the synchronizing the data.
:param synchronization_mode: Mode of synchronization used in triggers and
snapshot sync. Incremental by default. Possible values include:
'Incremental', 'FullSync'
:type synchronization_mode: str or
~azure.mgmt.datashare.models.SynchronizationMode
"""
_attribute_map = {
'synchronization_mode': {'key': 'synchronizationMode', 'type': 'str'},
}
def __init__(self, *, synchronization_mode=None, **kwargs) -> None:
super(Synchronize, self).__init__(**kwargs)
self.synchronization_mode = synchronization_mode