azure.mgmt.datashare.models module¶

class azure.mgmt.datashare.models.ADLSGen1FileDataSet(*, account_name: str, file_name: str, folder_path: str, resource_group: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
account_name (str) – The ADLS account name. Required.
data_set_id (str) – Unique id for identifying a data set resource.
file_name (str) – The file name in the ADLS account. Required.
folder_path (str) – The folder path within the ADLS account. Required.
resource_group (str) – Resource group of ADLS account. Required.
subscription_id (str) – Subscription id of ADLS account. Required.

Keyword Arguments

account_name (str) – The ADLS account name. Required.
file_name (str) – The file name in the ADLS account. Required.
folder_path (str) – The folder path within the ADLS account. Required.
resource_group (str) – Resource group of ADLS account. Required.
subscription_id (str) – Subscription id of ADLS account. Required.

class azure.mgmt.datashare.models.ADLSGen1FolderDataSet(*, account_name: str, folder_path: str, resource_group: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
account_name (str) – The ADLS account name. Required.
data_set_id (str) – Unique id for identifying a data set resource.
folder_path (str) – The folder path within the ADLS account. Required.
resource_group (str) – Resource group of ADLS account. Required.
subscription_id (str) – Subscription id of ADLS account. Required.

Keyword Arguments

account_name (str) – The ADLS account name. Required.
folder_path (str) – The folder path within the ADLS account. Required.
resource_group (str) – Resource group of ADLS account. Required.
subscription_id (str) – Subscription id of ADLS account. Required.

class azure.mgmt.datashare.models.ADLSGen2FileDataSet(*, file_path: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
file_path (str) – File path within the file system. Required.
file_system (str) – File system to which the file belongs. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

file_path (str) – File path within the file system. Required.
file_system (str) – File system to which the file belongs. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ADLSGen2FileDataSetMapping(*, data_set_id: str, file_path: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, output_type: Optional[Union[str, _models.OutputType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
file_path (str) – File path within the file system. Required.
file_system (str) – File system to which the file belongs. Required.
output_type (str or OutputType) – Type of output file. Known values are: “Csv” and “Parquet”.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
file_path (str) – File path within the file system. Required.
file_system (str) – File system to which the file belongs. Required.
output_type (str or OutputType) – Type of output file. Known values are: “Csv” and “Parquet”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ADLSGen2FileSystemDataSet(*, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
file_system (str) – The file system name. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

file_system (str) – The file system name. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ADLSGen2FileSystemDataSetMapping(*, data_set_id: str, file_system: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
file_system (str) – The file system name. Required.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
file_system (str) – The file system name. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ADLSGen2FolderDataSet(*, file_system: str, folder_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
file_system (str) – File system to which the folder belongs. Required.
folder_path (str) – Folder path within the file system. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

file_system (str) – File system to which the folder belongs. Required.
folder_path (str) – Folder path within the file system. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ADLSGen2FolderDataSetMapping(*, data_set_id: str, file_system: str, folder_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
file_system (str) – File system to which the folder belongs. Required.
folder_path (str) – Folder path within the file system. Required.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
file_system (str) – File system to which the folder belongs. Required.
folder_path (str) – Folder path within the file system. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.Account(*, identity: _models.Identity, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
location (str) – Location of the azure resource.
tags (dict[str, str]) – Tags on the azure resource.
identity (Identity) – Identity Info on the Account. Required.
created_at (datetime) – Time at which the account was created.
provisioning_state (str or ProvisioningState) – Provisioning state of the Account. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
user_email (str) – Email of the user who created the resource.
user_name (str) – Name of the user who created the resource.

Keyword Arguments

location (str) – Location of the azure resource.
tags (dict[str, str]) – Tags on the azure resource.
identity (Identity) – Identity Info on the Account. Required.

class azure.mgmt.datashare.models.AccountList(*, value: List[_models.Account], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get Accounts.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[Account]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[Account]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.AccountUpdateParameters(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Update parameters for accounts.

Variables: tags (dict[str, str]) – Tags on the azure resource.
Keyword Arguments: tags (dict[str, str]) – Tags on the azure resource.

class azure.mgmt.datashare.models.BlobContainerDataSet(*, container_name: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – BLOB Container name. Required.
data_set_id (str) – Unique id for identifying a data set resource.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – BLOB Container name. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.BlobContainerDataSetMapping(*, container_name: str, data_set_id: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – BLOB Container name. Required.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – BLOB Container name. Required.
data_set_id (str) – The id of the source data set. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.BlobDataSet(*, container_name: str, file_path: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – Container that has the file path. Required.
data_set_id (str) – Unique id for identifying a data set resource.
file_path (str) – File path within the source data set. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – Container that has the file path. Required.
file_path (str) – File path within the source data set. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.BlobDataSetMapping(*, container_name: str, data_set_id: str, file_path: str, resource_group: str, storage_account_name: str, subscription_id: str, output_type: Optional[Union[str, _models.OutputType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – Container that has the file path. Required.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
file_path (str) – File path within the source data set. Required.
output_type (str or OutputType) – File output type. Known values are: “Csv” and “Parquet”.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – Container that has the file path. Required.
data_set_id (str) – The id of the source data set. Required.
file_path (str) – File path within the source data set. Required.
output_type (str or OutputType) – File output type. Known values are: “Csv” and “Parquet”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.BlobFolderDataSet(*, container_name: str, prefix: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – Container that has the file path. Required.
data_set_id (str) – Unique id for identifying a data set resource.
prefix (str) – Prefix for blob folder. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – Container that has the file path. Required.
prefix (str) – Prefix for blob folder. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.BlobFolderDataSetMapping(*, container_name: str, data_set_id: str, prefix: str, resource_group: str, storage_account_name: str, subscription_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
container_name (str) – Container that has the file path. Required.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
prefix (str) – Prefix for blob folder. Required.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

Keyword Arguments

container_name (str) – Container that has the file path. Required.
data_set_id (str) – The id of the source data set. Required.
prefix (str) – Prefix for blob folder. Required.
resource_group (str) – Resource group of storage account. Required.
storage_account_name (str) – Storage account name of the source data set. Required.
subscription_id (str) – Subscription id of storage account. Required.

class azure.mgmt.datashare.models.ConsumerInvitation(*, invitation_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
data_set_count (int) – Number of data sets in a share.
description (str) – Description shared when the invitation was created.
expiration_date (datetime) – The expiration date for the share subscription created by accepting the invitation.
invitation_id (str) – Unique id of the invitation. Required.
invitation_status (str or InvitationStatus) – The status of the invitation. Known values are: “Pending”, “Accepted”, “Rejected”, and “Withdrawn”.
location (str) – invitation location.
provider_email (str) – Email of the provider who created the resource.
provider_name (str) – Name of the provider who created the resource.
provider_tenant_name (str) – Tenant name of the provider who created the resource.
responded_at (datetime) – The time the recipient responded to the invitation.
sent_at (datetime) – Gets the time at which the invitation was sent.
share_name (str) – Gets the source share Name.
terms_of_use (str) – Terms of use shared when the invitation was created.
user_email (str) – Email of the user who created the resource.
user_name (str) – Name of the user who created the resource.

Keyword Arguments

invitation_id (str) – Unique id of the invitation. Required.

class azure.mgmt.datashare.models.ConsumerInvitationList(*, value: List[_models.ConsumerInvitation], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get InvitationList.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ConsumerInvitation]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ConsumerInvitation]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.ConsumerSourceDataSet(**kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

A consumer side dataSet data transfer object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
data_set_id (str) – DataSet Id.
data_set_location (str) – Location of the data set.
data_set_name (str) – DataSet name.
data_set_path (str) – DataSet path.
data_set_type (str or DataSetType) – Type of data set. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.

class azure.mgmt.datashare.models.ConsumerSourceDataSetList(*, value: List[_models.ConsumerSourceDataSet], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

A consumer side list of source dataSets.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ConsumerSourceDataSet]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ConsumerSourceDataSet]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.datashare.models.DataSet(**kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

A DataSet data transfer object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ADLSGen1FileDataSet, ADLSGen1FolderDataSet, ADLSGen2FileDataSet, ADLSGen2FileSystemDataSet, ADLSGen2FolderDataSet, BlobDataSet, BlobFolderDataSet, BlobContainerDataSet, KustoClusterDataSet, KustoDatabaseDataSet, SqlDBTableDataSet, SqlDWTableDataSet, SynapseWorkspaceSqlPoolTableDataSet

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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.

class azure.mgmt.datashare.models.DataSetKind(value)[source]¶

Bases: str, enum.Enum

Kind of data set.

ADLS_GEN1_FILE = 'AdlsGen1File'¶

ADLS_GEN1_FOLDER = 'AdlsGen1Folder'¶

ADLS_GEN2_FILE = 'AdlsGen2File'¶

ADLS_GEN2_FILE_SYSTEM = 'AdlsGen2FileSystem'¶

ADLS_GEN2_FOLDER = 'AdlsGen2Folder'¶

BLOB = 'Blob'¶

BLOB_FOLDER = 'BlobFolder'¶

CONTAINER = 'Container'¶

KUSTO_CLUSTER = 'KustoCluster'¶

KUSTO_DATABASE = 'KustoDatabase'¶

SQL_DB_TABLE = 'SqlDBTable'¶

SQL_DW_TABLE = 'SqlDWTable'¶

SYNAPSE_WORKSPACE_SQL_POOL_TABLE = 'SynapseWorkspaceSqlPoolTable'¶

class azure.mgmt.datashare.models.DataSetList(*, value: List[_models.DataSet], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get DataSets.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[DataSet]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[DataSet]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.DataSetMapping(**kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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: ADLSGen2FileDataSetMapping, ADLSGen2FileSystemDataSetMapping, ADLSGen2FolderDataSetMapping, BlobDataSetMapping, BlobFolderDataSetMapping, BlobContainerDataSetMapping, KustoClusterDataSetMapping, KustoDatabaseDataSetMapping, SqlDBTableDataSetMapping, SqlDWTableDataSetMapping, SynapseWorkspaceSqlPoolTableDataSetMapping

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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.

class azure.mgmt.datashare.models.DataSetMappingKind(value)[source]¶

Bases: str, enum.Enum

Kind of data set mapping.

ADLS_GEN2_FILE = 'AdlsGen2File'¶

ADLS_GEN2_FILE_SYSTEM = 'AdlsGen2FileSystem'¶

ADLS_GEN2_FOLDER = 'AdlsGen2Folder'¶

BLOB = 'Blob'¶

BLOB_FOLDER = 'BlobFolder'¶

CONTAINER = 'Container'¶

KUSTO_CLUSTER = 'KustoCluster'¶

KUSTO_DATABASE = 'KustoDatabase'¶

SQL_DB_TABLE = 'SqlDBTable'¶

SQL_DW_TABLE = 'SqlDWTable'¶

SYNAPSE_WORKSPACE_SQL_POOL_TABLE = 'SynapseWorkspaceSqlPoolTable'¶

class azure.mgmt.datashare.models.DataSetMappingList(*, value: List[_models.DataSetMapping], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get DataSetMappings.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[DataSetMapping]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[DataSetMapping]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.DataSetMappingStatus(value)[source]¶

Bases: str, enum.Enum

Gets the status of the data set mapping.

BROKEN = 'Broken'¶

OK = 'Ok'¶

class azure.mgmt.datashare.models.DataSetType(value)[source]¶

Bases: str, enum.Enum

Type of data set.

ADLS_GEN1_FILE = 'AdlsGen1File'¶

ADLS_GEN1_FOLDER = 'AdlsGen1Folder'¶

ADLS_GEN2_FILE = 'AdlsGen2File'¶

ADLS_GEN2_FILE_SYSTEM = 'AdlsGen2FileSystem'¶

ADLS_GEN2_FOLDER = 'AdlsGen2Folder'¶

BLOB = 'Blob'¶

BLOB_FOLDER = 'BlobFolder'¶

CONTAINER = 'Container'¶

KUSTO_CLUSTER = 'KustoCluster'¶

KUSTO_DATABASE = 'KustoDatabase'¶

SQL_DB_TABLE = 'SqlDBTable'¶

SQL_DW_TABLE = 'SqlDWTable'¶

SYNAPSE_WORKSPACE_SQL_POOL_TABLE = 'SynapseWorkspaceSqlPoolTable'¶

class azure.mgmt.datashare.models.DataShareError(*, error: _models.DataShareErrorInfo, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

The data share error model.

All required parameters must be populated in order to send to Azure.

Variables: error (DataShareErrorInfo) – The data share error body. Required.
Keyword Arguments: error (DataShareErrorInfo) – The data share error body. Required.

class azure.mgmt.datashare.models.DataShareErrorInfo(*, code: str, message: str, details: Optional[List[_models.DataShareErrorInfo]] = None, target: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

The data share error body model.

All required parameters must be populated in order to send to Azure.

Variables

code (str) – Code of the error. Required.
details (list[DataShareErrorInfo]) – Nested details of the error model.
message (str) – Message of the error. Required.
target (str) – Target of the error.

Keyword Arguments

code (str) – Code of the error. Required.
details (list[DataShareErrorInfo]) – Nested details of the error model.
message (str) – Message of the error. Required.
target (str) – Target of the error.

class azure.mgmt.datashare.models.DefaultDto(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

Base data transfer object implementation for default resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
location (str) – Location of the azure resource.
tags (dict[str, str]) – Tags on the azure resource.

Keyword Arguments

location (str) – Location of the azure resource.
tags (dict[str, str]) – Tags on the azure resource.

class azure.mgmt.datashare.models.DimensionProperties(*, display_name: Optional[str] = None, name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

properties for dimension.

Variables

display_name (str) – localized display name of the dimension to customer.
name (str) – dimension name.

Keyword Arguments

display_name (str) – localized display name of the dimension to customer.
name (str) – dimension name.

class azure.mgmt.datashare.models.EmailRegistration(*, activation_code: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Dto for tenant domain registration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

activation_code (str) – Activation code for the registration.
activation_expiration_date (datetime) – Date of the activation expiration.
email (str) – The email to register.
registration_status (str or RegistrationStatus) – Registration status. Known values are: “ActivationPending”, “Activated”, and “ActivationAttemptsExhausted”.
tenant_id (str) – The tenant to register.

Keyword Arguments

activation_code (str) – Activation code for the registration.

class azure.mgmt.datashare.models.Identity(*, type: Optional[Union[str, _models.Type]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Identity of resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – service principal Id.
tenant_id (str) – Tenant Id.
type (str or Type) – Identity Type. “SystemAssigned”

Keyword Arguments

type (str or Type) – Identity Type. “SystemAssigned”

class azure.mgmt.datashare.models.Invitation(*, expiration_date: Optional[datetime.datetime] = None, target_active_directory_id: Optional[str] = None, target_email: Optional[str] = None, target_object_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

A Invitation data transfer object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
expiration_date (datetime) – The expiration date for the invitation and share subscription.
invitation_id (str) – unique invitation id.
invitation_status (str or InvitationStatus) – The status of the invitation. Known values are: “Pending”, “Accepted”, “Rejected”, and “Withdrawn”.
responded_at (datetime) – The time the recipient responded to the invitation.
sent_at (datetime) – Gets the time at which the invitation was sent.
target_active_directory_id (str) – The target Azure AD Id. Can’t be combined with email.
target_email (str) – The email the invitation is directed to.
target_object_id (str) – 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.
user_email (str) – Email of the user who created the resource.
user_name (str) – Name of the user who created the resource.

Keyword Arguments

expiration_date (datetime) – The expiration date for the invitation and share subscription.
target_active_directory_id (str) – The target Azure AD Id. Can’t be combined with email.
target_email (str) – The email the invitation is directed to.
target_object_id (str) – 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.

class azure.mgmt.datashare.models.InvitationList(*, value: List[_models.Invitation], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get InvitationList.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[Invitation]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[Invitation]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.InvitationStatus(value)[source]¶

Bases: str, enum.Enum

The status of the invitation.

ACCEPTED = 'Accepted'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

WITHDRAWN = 'Withdrawn'¶

class azure.mgmt.datashare.models.KustoClusterDataSet(*, kusto_cluster_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
kusto_cluster_resource_id (str) – Resource id of the kusto cluster. Required.
location (str) – Location of the kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the kusto cluster data set. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.

Keyword Arguments

kusto_cluster_resource_id (str) – Resource id of the kusto cluster. Required.

class azure.mgmt.datashare.models.KustoClusterDataSetMapping(*, data_set_id: str, kusto_cluster_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
kusto_cluster_resource_id (str) – Resource id of the sink kusto cluster. Required.
location (str) – Location of the sink kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
kusto_cluster_resource_id (str) – Resource id of the sink kusto cluster. Required.

class azure.mgmt.datashare.models.KustoDatabaseDataSet(*, kusto_database_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
kusto_database_resource_id (str) – Resource id of the kusto database. Required.
location (str) – Location of the kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the kusto database data set. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.

Keyword Arguments

kusto_database_resource_id (str) – Resource id of the kusto database. Required.

class azure.mgmt.datashare.models.KustoDatabaseDataSetMapping(*, data_set_id: str, kusto_cluster_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
kusto_cluster_resource_id (str) – Resource id of the sink kusto cluster. Required.
location (str) – Location of the sink kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
kusto_cluster_resource_id (str) – Resource id of the sink kusto cluster. Required.

class azure.mgmt.datashare.models.LastModifiedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that last modified the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.datashare.models.OperationList(*, value: List[_models.OperationModel], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get operations.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[OperationModel]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[OperationModel]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.OperationMetaLogSpecification(*, blob_duration: Optional[str] = None, display_name: Optional[str] = None, name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

log specifications for operation api.

Variables

blob_duration (str) – blob duration of the log.
display_name (str) – localized name of the log category.
name (str) – name of the log category.

Keyword Arguments

blob_duration (str) – blob duration of the log.
display_name (str) – localized name of the log category.
name (str) – name of the log category.

class azure.mgmt.datashare.models.OperationMetaMetricSpecification(*, aggregation_type: Optional[str] = None, dimensions: Optional[List[_models.DimensionProperties]] = None, display_description: Optional[str] = None, display_name: Optional[str] = None, enable_regional_mdm_account: Optional[str] = None, fill_gap_with_zero: Optional[bool] = None, internal_metric_name: Optional[str] = None, name: Optional[str] = None, resource_id_dimension_name_override: Optional[str] = None, supported_aggregation_types: Optional[List[str]] = None, supported_time_grain_types: Optional[List[str]] = None, unit: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

metric specifications for the operation.

Variables

aggregation_type (str) – aggregation type of metric.
dimensions (list[DimensionProperties]) – properties for dimension.
display_description (str) – description of the metric.
display_name (str) – localized name of the metric.
enable_regional_mdm_account (str) – enable regional mdm account.
fill_gap_with_zero (bool) – fill gap with zero.
internal_metric_name (str) – internal metric name.
name (str) – name of the metric.
resource_id_dimension_name_override (str) – dimension name use to replace resource id if specified.
supported_aggregation_types (list[str]) – supported aggregation types.
supported_time_grain_types (list[str]) – supported time grain types.
unit (str) – units for the metric.

Keyword Arguments

aggregation_type (str) – aggregation type of metric.
dimensions (list[DimensionProperties]) – properties for dimension.
display_description (str) – description of the metric.
display_name (str) – localized name of the metric.
enable_regional_mdm_account (str) – enable regional mdm account.
fill_gap_with_zero (bool) – fill gap with zero.
internal_metric_name (str) – internal metric name.
name (str) – name of the metric.
resource_id_dimension_name_override (str) – dimension name use to replace resource id if specified.
supported_aggregation_types (list[str]) – supported aggregation types.
supported_time_grain_types (list[str]) – supported time grain types.
unit (str) – units for the metric.

class azure.mgmt.datashare.models.OperationMetaServiceSpecification(*, log_specifications: Optional[List[_models.OperationMetaLogSpecification]] = None, metric_specifications: Optional[List[_models.OperationMetaMetricSpecification]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

The operation meta service specification.

Variables

log_specifications (list[OperationMetaLogSpecification]) – log specifications for the operation.
metric_specifications (list[OperationMetaMetricSpecification]) – metric specifications for the operation.

Keyword Arguments

log_specifications (list[OperationMetaLogSpecification]) – log specifications for the operation.
metric_specifications (list[OperationMetaMetricSpecification]) – metric specifications for the operation.

class azure.mgmt.datashare.models.OperationModel(*, display: Optional[_models.OperationModelProperties] = None, name: Optional[str] = None, origin: Optional[str] = None, service_specification: Optional[_models.OperationMetaServiceSpecification] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

The response model for get operations.

Variables

display (OperationModelProperties) – Properties on the operation.
name (str) – Operation name for display purposes.
origin (str) – origin of the operation.
service_specification (OperationMetaServiceSpecification) – meta service specification.

Keyword Arguments

display (OperationModelProperties) – Properties on the operation.
name (str) – Operation name for display purposes.
origin (str) – origin of the operation.
service_specification (OperationMetaServiceSpecification) – meta service specification.

class azure.mgmt.datashare.models.OperationModelProperties(*, description: Optional[str] = None, operation: Optional[str] = None, provider: Optional[str] = None, resource: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Properties on operations.

Variables

description (str) – Description of the operation for display purposes.
operation (str) – Name of the operation for display purposes.
provider (str) – Name of the provider for display purposes.
resource (str) – Name of the resource type for display purposes.

Keyword Arguments

description (str) – Description of the operation for display purposes.
operation (str) – Name of the operation for display purposes.
provider (str) – Name of the provider for display purposes.
resource (str) – Name of the resource type for display purposes.

class azure.mgmt.datashare.models.OperationResponse(*, status: Union[str, _models.Status], end_time: Optional[datetime.datetime] = None, error: Optional[_models.DataShareErrorInfo] = None, start_time: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Response for long running operation.

All required parameters must be populated in order to send to Azure.

Variables

end_time (datetime) – start time.
error (DataShareErrorInfo) – The error property when status is failed.
start_time (datetime) – start time.
status (str or Status) – Operation state of the long running operation. Required. Known values are: “Accepted”, “InProgress”, “TransientFailure”, “Succeeded”, “Failed”, and “Canceled”.

Keyword Arguments

end_time (datetime) – start time.
error (DataShareErrorInfo) – The error property when status is failed.
start_time (datetime) – start time.
status (str or Status) – Operation state of the long running operation. Required. Known values are: “Accepted”, “InProgress”, “TransientFailure”, “Succeeded”, “Failed”, and “Canceled”.

class azure.mgmt.datashare.models.OutputType(value)[source]¶

Bases: str, enum.Enum

Type of output file.

CSV = 'Csv'¶

PARQUET = 'Parquet'¶

class azure.mgmt.datashare.models.ProviderShareSubscription(*, expiration_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

A provider side share subscription data transfer object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
consumer_email (str) – Email of the consumer who created the share subscription.
consumer_name (str) – Name of the consumer who created the share subscription.
consumer_tenant_name (str) – Tenant name of the consumer who created the share subscription.
created_at (datetime) – created at.
expiration_date (datetime) – Expiration date of the share subscription in UTC format.
provider_email (str) – Email of the provider who created the share.
provider_name (str) – Name of the provider who created the share.
shared_at (datetime) – Shared at.
share_subscription_object_id (str) – share Subscription Object Id.
share_subscription_status (str or ShareSubscriptionStatus) – Gets the status of share subscription. Known values are: “Active”, “Revoked”, “SourceDeleted”, and “Revoking”.

Keyword Arguments

expiration_date (datetime) – Expiration date of the share subscription in UTC format.

class azure.mgmt.datashare.models.ProviderShareSubscriptionList(*, value: List[_models.ProviderShareSubscription], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get ShareSubscription.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ProviderShareSubscription]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ProviderShareSubscription]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning state of the Account.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.datashare.models.ProxyDto(**kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Base data transfer object implementation for proxy resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.

class azure.mgmt.datashare.models.RecurrenceInterval(value)[source]¶

Bases: str, enum.Enum

Recurrence Interval.

DAY = 'Day'¶

HOUR = 'Hour'¶

class azure.mgmt.datashare.models.RegistrationStatus(value)[source]¶

Bases: str, enum.Enum

Registration status.

ACTIVATED = 'Activated'¶

ACTIVATION_ATTEMPTS_EXHAUSTED = 'ActivationAttemptsExhausted'¶

ACTIVATION_PENDING = 'ActivationPending'¶

class azure.mgmt.datashare.models.ScheduledSourceSynchronizationSetting(*, recurrence_interval: Optional[Union[str, _models.RecurrenceInterval]] = None, synchronization_time: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.SourceShareSynchronizationSetting

A type of synchronization setting based on schedule.

All required parameters must be populated in order to send to Azure.

Variables

kind (str or SourceShareSynchronizationSettingKind) – Kind of synchronization setting on share. Required. “ScheduleBased”
recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Known values are: “Hour” and “Day”.
synchronization_time (datetime) – Synchronization time.

Keyword Arguments

recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Known values are: “Hour” and “Day”.
synchronization_time (datetime) – Synchronization time.

class azure.mgmt.datashare.models.ScheduledSynchronizationSetting(*, recurrence_interval: Union[str, _models.RecurrenceInterval], synchronization_time: datetime.datetime, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or SynchronizationSettingKind) – Kind of synchronization setting. Required. “ScheduleBased”
created_at (datetime) – Time at which the synchronization setting was created.
provisioning_state (str or ProvisioningState) – Gets or sets the provisioning state. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Required. Known values are: “Hour” and “Day”.
synchronization_time (datetime) – Synchronization time. Required.
user_name (str) – Name of the user who created the synchronization setting.

Keyword Arguments

recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Required. Known values are: “Hour” and “Day”.
synchronization_time (datetime) – Synchronization time. Required.

class azure.mgmt.datashare.models.ScheduledTrigger(*, recurrence_interval: Union[str, _models.RecurrenceInterval], synchronization_time: datetime.datetime, synchronization_mode: Optional[Union[str, _models.SynchronizationMode]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or TriggerKind) – Kind of synchronization on trigger. Required. “ScheduleBased”
created_at (datetime) – Time at which the trigger was created.
provisioning_state (str or ProvisioningState) – Gets the provisioning state. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Required. Known values are: “Hour” and “Day”.
synchronization_mode (str or SynchronizationMode) – Synchronization mode. Known values are: “Incremental” and “FullSync”.
synchronization_time (datetime) – Synchronization time. Required.
trigger_status (str or TriggerStatus) – Gets the trigger state. Known values are: “Active”, “Inactive”, and “SourceSynchronizationSettingDeleted”.
user_name (str) – Name of the user who created the trigger.

Keyword Arguments

recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Required. Known values are: “Hour” and “Day”.
synchronization_mode (str or SynchronizationMode) – Synchronization mode. Known values are: “Incremental” and “FullSync”.
synchronization_time (datetime) – Synchronization time. Required.

class azure.mgmt.datashare.models.Share(*, description: Optional[str] = None, share_kind: Optional[Union[str, _models.ShareKind]] = None, terms: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.ProxyDto

A share data transfer object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
created_at (datetime) – Time at which the share was created.
description (str) – Share description.
provisioning_state (str or ProvisioningState) – Gets or sets the provisioning state. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
share_kind (str or ShareKind) – Share kind. Known values are: “CopyBased” and “InPlace”.
terms (str) – Share terms.
user_email (str) – Email of the user who created the resource.
user_name (str) – Name of the user who created the resource.

Keyword Arguments

description (str) – Share description.
share_kind (str or ShareKind) – Share kind. Known values are: “CopyBased” and “InPlace”.
terms (str) – Share terms.

class azure.mgmt.datashare.models.ShareKind(value)[source]¶

Bases: str, enum.Enum

Share kind.

COPY_BASED = 'CopyBased'¶

IN_PLACE = 'InPlace'¶

class azure.mgmt.datashare.models.ShareList(*, value: List[_models.Share], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get Shares.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[Share]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[Share]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.ShareSubscription(*, invitation_id: str, source_share_location: str, expiration_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
created_at (datetime) – Time at which the share subscription was created.
expiration_date (datetime) – The expiration date of the share subscription.
invitation_id (str) – The invitation id. Required.
provider_email (str) – Email of the provider who created the resource.
provider_name (str) – Name of the provider who created the resource.
provider_tenant_name (str) – Tenant name of the provider who created the resource.
provisioning_state (str or ProvisioningState) – Provisioning state of the share subscription. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
share_description (str) – Description of share.
share_kind (str or ShareKind) – Kind of share. Known values are: “CopyBased” and “InPlace”.
share_name (str) – Name of the share.
share_subscription_status (str or ShareSubscriptionStatus) – Gets the current status of share subscription. Known values are: “Active”, “Revoked”, “SourceDeleted”, and “Revoking”.
share_terms (str) – Terms of a share.
source_share_location (str) – Source share location. Required.
user_email (str) – Email of the user who created the resource.
user_name (str) – Name of the user who created the resource.

Keyword Arguments

expiration_date (datetime) – The expiration date of the share subscription.
invitation_id (str) – The invitation id. Required.
source_share_location (str) – Source share location. Required.

class azure.mgmt.datashare.models.ShareSubscriptionList(*, value: List[_models.ShareSubscription], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get ShareSubscription.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ShareSubscription]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ShareSubscription]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.ShareSubscriptionStatus(value)[source]¶

Bases: str, enum.Enum

Gets the status of share subscription.

ACTIVE = 'Active'¶

REVOKED = 'Revoked'¶

REVOKING = 'Revoking'¶

SOURCE_DELETED = 'SourceDeleted'¶

class azure.mgmt.datashare.models.ShareSubscriptionSynchronization(*, synchronization_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.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.

Variables

duration_ms (int) – Synchronization duration.
end_time (datetime) – End time of synchronization.
message (str) – message of Synchronization.
start_time (datetime) – start time of synchronization.
status (str) – Raw Status.
synchronization_id (str) – Synchronization id. Required.
synchronization_mode (str or SynchronizationMode) – Synchronization Mode. Known values are: “Incremental” and “FullSync”.

Keyword Arguments

synchronization_id (str) – Synchronization id. Required.

class azure.mgmt.datashare.models.ShareSubscriptionSynchronizationList(*, value: List[_models.ShareSubscriptionSynchronization], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

A consumer side list of share subscription synchronizations.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ShareSubscriptionSynchronization]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ShareSubscriptionSynchronization]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.ShareSynchronization(*, consumer_email: Optional[str] = None, consumer_name: Optional[str] = None, consumer_tenant_name: Optional[str] = None, duration_ms: Optional[int] = None, end_time: Optional[datetime.datetime] = None, message: Optional[str] = None, start_time: Optional[datetime.datetime] = None, status: Optional[str] = None, synchronization_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

A ShareSynchronization data transfer object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

consumer_email (str) – Email of the user who created the synchronization.
consumer_name (str) – Name of the user who created the synchronization.
consumer_tenant_name (str) – Tenant name of the consumer who created the synchronization.
duration_ms (int) – synchronization duration.
end_time (datetime) – End time of synchronization.
message (str) – message of synchronization.
start_time (datetime) – start time of synchronization.
status (str) – Raw Status.
synchronization_id (str) – Synchronization id.
synchronization_mode (str or SynchronizationMode) – Synchronization mode. Known values are: “Incremental” and “FullSync”.

Keyword Arguments

consumer_email (str) – Email of the user who created the synchronization.
consumer_name (str) – Name of the user who created the synchronization.
consumer_tenant_name (str) – Tenant name of the consumer who created the synchronization.
duration_ms (int) – synchronization duration.
end_time (datetime) – End time of synchronization.
message (str) – message of synchronization.
start_time (datetime) – start time of synchronization.
status (str) – Raw Status.
synchronization_id (str) – Synchronization id.

class azure.mgmt.datashare.models.ShareSynchronizationList(*, value: List[_models.ShareSynchronization], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get ShareSynchronization.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[ShareSynchronization]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[ShareSynchronization]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.SourceShareSynchronizationSetting(**kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.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.

Variables: kind (str or SourceShareSynchronizationSettingKind) – Kind of synchronization setting on share. Required. “ScheduleBased”

class azure.mgmt.datashare.models.SourceShareSynchronizationSettingKind(value)[source]¶

Bases: str, enum.Enum

Kind of synchronization setting on share.

SCHEDULE_BASED = 'ScheduleBased'¶

class azure.mgmt.datashare.models.SourceShareSynchronizationSettingList(*, value: List[_models.SourceShareSynchronizationSetting], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get source share Synchronization settings.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[SourceShareSynchronizationSetting]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[SourceShareSynchronizationSetting]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.SqlDBTableDataSet(*, database_name: Optional[str] = None, schema_name: Optional[str] = None, sql_server_resource_id: Optional[str] = None, table_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
database_name (str) – Database name of the source data set.
data_set_id (str) – Unique id for identifying a data set resource.
schema_name (str) – Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Resource id of SQL server.
table_name (str) – SQL DB table name.

Keyword Arguments

database_name (str) – Database name of the source data set.
schema_name (str) – Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Resource id of SQL server.
table_name (str) – SQL DB table name.

class azure.mgmt.datashare.models.SqlDBTableDataSetMapping(*, database_name: str, data_set_id: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
database_name (str) – DatabaseName name of the sink data set. Required.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
schema_name (str) – Schema of the table. Default value is dbo. Required.
sql_server_resource_id (str) – Resource id of SQL server. Required.
table_name (str) – SQL DB table name. Required.

Keyword Arguments

database_name (str) – DatabaseName name of the sink data set. Required.
data_set_id (str) – The id of the source data set. Required.
schema_name (str) – Schema of the table. Default value is dbo. Required.
sql_server_resource_id (str) – Resource id of SQL server. Required.
table_name (str) – SQL DB table name. Required.

class azure.mgmt.datashare.models.SqlDWTableDataSet(*, data_warehouse_name: Optional[str] = None, schema_name: Optional[str] = None, sql_server_resource_id: Optional[str] = None, table_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
data_warehouse_name (str) – DataWarehouse name of the source data set.
schema_name (str) – Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Resource id of SQL server.
table_name (str) – SQL DW table name.

Keyword Arguments

data_warehouse_name (str) – DataWarehouse name of the source data set.
schema_name (str) – Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Resource id of SQL server.
table_name (str) – SQL DW table name.

class azure.mgmt.datashare.models.SqlDWTableDataSetMapping(*, data_set_id: str, data_warehouse_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
data_warehouse_name (str) – DataWarehouse name of the source data set. Required.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
schema_name (str) – Schema of the table. Default value is dbo. Required.
sql_server_resource_id (str) – Resource id of SQL server. Required.
table_name (str) – SQL DW table name. Required.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
data_warehouse_name (str) – DataWarehouse name of the source data set. Required.
schema_name (str) – Schema of the table. Default value is dbo. Required.
sql_server_resource_id (str) – Resource id of SQL server. Required.
table_name (str) – SQL DW table name. Required.

class azure.mgmt.datashare.models.Status(value)[source]¶

Bases: str, enum.Enum

Operation state of the long running operation.

ACCEPTED = 'Accepted'¶

CANCELED = 'Canceled'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SUCCEEDED = 'Succeeded'¶

TRANSIENT_FAILURE = 'TransientFailure'¶

class azure.mgmt.datashare.models.SynapseWorkspaceSqlPoolTableDataSet(*, synapse_workspace_sql_pool_table_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.DataSet

A Synapse Workspace Sql Pool 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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetKind) – Kind of data set. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – Unique id for identifying a data set resource.
synapse_workspace_sql_pool_table_resource_id (str) – Resource id of the Synapse Workspace SQL Pool Table. Required.

Keyword Arguments

synapse_workspace_sql_pool_table_resource_id (str) – Resource id of the Synapse Workspace SQL Pool Table. Required.

class azure.mgmt.datashare.models.SynapseWorkspaceSqlPoolTableDataSetMapping(*, data_set_id: str, synapse_workspace_sql_pool_table_resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.DataSetMapping

A Synapse Workspace Sql Pool 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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or DataSetMappingKind) – Kind of data set mapping. Required. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
data_set_id (str) – The id of the source data set. Required.
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Known values are: “Ok” and “Broken”.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Known values are: “Succeeded”, “Creating”, “Deleting”, “Moving”, and “Failed”.
synapse_workspace_sql_pool_table_resource_id (str) – Resource id of the Synapse Workspace SQL Pool Table. Required.

Keyword Arguments

data_set_id (str) – The id of the source data set. Required.
synapse_workspace_sql_pool_table_resource_id (str) – Resource id of the Synapse Workspace SQL Pool Table. Required.

class azure.mgmt.datashare.models.SynchronizationDetails(**kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Synchronization details at data set level.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

data_set_id (str) – Id of data set.
data_set_type (str or DataSetType) – Type of the data set. Known values are: “Blob”, “Container”, “BlobFolder”, “AdlsGen2FileSystem”, “AdlsGen2Folder”, “AdlsGen2File”, “AdlsGen1Folder”, “AdlsGen1File”, “KustoCluster”, “KustoDatabase”, “SqlDBTable”, “SqlDWTable”, and “SynapseWorkspaceSqlPoolTable”.
duration_ms (int) – Duration of data set level copy.
end_time (datetime) – End time of data set level copy.
files_read (int) – The number of files read from the source data set.
files_written (int) – The number of files written into the sink data set.
message (str) – Error message if any.
name (str) – Name of the data set.
rows_copied (int) – The number of files copied into the sink data set.
rows_read (int) – The number of rows read from the source data set.
size_read (int) – The size of the data read from the source data set in bytes.
size_written (int) – The size of the data written into the sink data set in bytes.
start_time (datetime) – Start time of data set level copy.
status (str) – Raw Status.
v_core (int) – The vCore units consumed for the data set synchronization.

class azure.mgmt.datashare.models.SynchronizationDetailsList(*, value: List[_models.SynchronizationDetails], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

details of synchronization.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[SynchronizationDetails]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[SynchronizationDetails]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.SynchronizationMode(value)[source]¶

Bases: str, enum.Enum

Synchronization mode.

FULL_SYNC = 'FullSync'¶

INCREMENTAL = 'Incremental'¶

class azure.mgmt.datashare.models.SynchronizationSetting(**kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or SynchronizationSettingKind) – Kind of synchronization setting. Required. “ScheduleBased”

class azure.mgmt.datashare.models.SynchronizationSettingKind(value)[source]¶

Bases: str, enum.Enum

Kind of synchronization setting.

SCHEDULE_BASED = 'ScheduleBased'¶

class azure.mgmt.datashare.models.SynchronizationSettingList(*, value: List[_models.SynchronizationSetting], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get Synchronization settings.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[SynchronizationSetting]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[SynchronizationSetting]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.Synchronize(*, synchronization_mode: Optional[Union[str, _models.SynchronizationMode]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Payload for the synchronizing the data.

Variables: synchronization_mode (str or SynchronizationMode) – Mode of synchronization used in triggers and snapshot sync. Incremental by default. Known values are: “Incremental” and “FullSync”.
Keyword Arguments: synchronization_mode (str or SynchronizationMode) – Mode of synchronization used in triggers and snapshot sync. Incremental by default. Known values are: “Incremental” and “FullSync”.

class azure.mgmt.datashare.models.SystemData(*, created_at: Optional[datetime.datetime] = None, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.LastModifiedByType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_at (datetime) – The timestamp of resource creation (UTC).
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The type of identity that last modified the resource.
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or LastModifiedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

Keyword Arguments

created_at (datetime) – The timestamp of resource creation (UTC).
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The type of identity that last modified the resource.
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or LastModifiedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

class azure.mgmt.datashare.models.Trigger(**kwargs)[source]¶

Bases: azure.mgmt.datashare.models._models_py3.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.

Variables

id (str) – The resource id of the azure resource.
name (str) – Name of the azure resource.
system_data (SystemData) – System Data of the Azure resource.
type (str) – Type of the azure resource.
kind (str or TriggerKind) – Kind of synchronization on trigger. Required. “ScheduleBased”

class azure.mgmt.datashare.models.TriggerKind(value)[source]¶

Bases: str, enum.Enum

Kind of synchronization on trigger.

SCHEDULE_BASED = 'ScheduleBased'¶

class azure.mgmt.datashare.models.TriggerList(*, value: List[_models.Trigger], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.datashare._serialization.Model

List response for get triggers.

All required parameters must be populated in order to send to Azure.

Variables

next_link (str) – The Url of next result page.
value (list[Trigger]) – Collection of items of type DataTransferObjects. Required.

Keyword Arguments

next_link (str) – The Url of next result page.
value (list[Trigger]) – Collection of items of type DataTransferObjects. Required.

class azure.mgmt.datashare.models.TriggerStatus(value)[source]¶

Bases: str, enum.Enum

Gets the trigger state.

ACTIVE = 'Active'¶

INACTIVE = 'Inactive'¶

SOURCE_SYNCHRONIZATION_SETTING_DELETED = 'SourceSynchronizationSettingDeleted'¶

class azure.mgmt.datashare.models.Type(value)[source]¶

Bases: str, enum.Enum

Identity Type.

SYSTEM_ASSIGNED = 'SystemAssigned'¶