azure.mgmt.datashare.models module¶
-
exception
azure.mgmt.datashare.models.
DataShareErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘DataShareError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
class
azure.mgmt.datashare.models.
Account
(*, identity, location: str = None, tags=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
name (str) – Name of the azure resource
created_at (datetime) – Time at which the account was created.
provisioning_state (str or ProvisioningState) – Provisioning state of the Account. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
user_email (str) – Email of the user who created the resource
user_name (str) – Name of the user who created the resource
- Parameters
-
class
azure.mgmt.datashare.models.
AccountUpdateParameters
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Update parameters for accounts.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
account_name (str) – Required. The ADLS account name.
file_name (str) – Required. The file name in the ADLS account.
folder_path (str) – Required. The folder path within the ADLS account.
resource_group (str) – Required. Resource group of ADLS account.
subscription_id (str) – Required. Subscription id of ADLS account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
account_name (str) – Required. The ADLS account name.
folder_path (str) – Required. The folder path within the ADLS account.
resource_group (str) – Required. Resource group of ADLS account.
subscription_id (str) – Required. Subscription id of ADLS account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
file_path (str) – Required. File path within the file system.
file_system (str) – Required. File system to which the file belongs.
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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=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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
data_set_id (str) – Required. The id of the source data set.
file_path (str) – Required. File path within the file system.
file_system (str) – Required. File system to which the file belongs.
output_type (str or OutputType) – Type of output file. Possible values include: ‘Csv’, ‘Parquet’
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
file_system (str) – Required. The file system name.
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
data_set_id (str) – Required. The id of the source data set.
file_system (str) – Required. The file system name.
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
file_system (str) – Required. File system to which the folder belongs.
folder_path (str) – Required. Folder path within the file system.
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
data_set_id (str) – Required. The id of the source data set.
file_system (str) – Required. File system to which the folder belongs.
folder_path (str) – Required. Folder path within the file system.
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. BLOB Container name.
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. BLOB Container name.
data_set_id (str) – Required. The id of the source data set.
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. Container that has the file path.
file_path (str) – Required. File path within the source data set
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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=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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. Container that has the file path.
data_set_id (str) – Required. The id of the source data set.
file_path (str) – Required. File path within the source data set
output_type (str or OutputType) – File output type. Possible values include: ‘Csv’, ‘Parquet’
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. Container that has the file path.
prefix (str) – Required. Prefix for blob folder
resource_group (str) – Required. Resource group of storage account
storage_account_name (str) – Required. Storage account name of the source data set
subscription_id (str) – Required. Subscription id of storage account
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
container_name (str) – Required. Container that has the file path.
data_set_id (str) – Required. The id of the source data set.
prefix (str) – Required. Prefix for blob folder
resource_group (str) – Required. Resource group of storage account.
storage_account_name (str) – Required. Storage account name of the source data set.
subscription_id (str) – Required. Subscription id of storage account.
-
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
name (str) – Name of the azure resource
data_set_count (int) – Number of data sets in a share
description (str) – Description shared when the invitation was created
invitation_status (str or InvitationStatus) – The status of the invitation. Possible values include: ‘Pending’, ‘Accepted’, ‘Rejected’, ‘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
- Parameters
invitation_id (str) – Required. Unique id of the invitation.
-
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
name (str) – Name 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. Possible values include: ‘Blob’, ‘Container’, ‘BlobFolder’, ‘AdlsGen2FileSystem’, ‘AdlsGen2Folder’, ‘AdlsGen2File’, ‘AdlsGen1Folder’, ‘AdlsGen1File’, ‘KustoCluster’, ‘KustoDatabase’, ‘SqlDBTable’, ‘SqlDWTable’
-
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: BlobDataSet, BlobFolderDataSet, BlobContainerDataSet, ADLSGen2FileDataSet, ADLSGen2FolderDataSet, ADLSGen2FileSystemDataSet, ADLSGen1FolderDataSet, ADLSGen1FileDataSet, KustoClusterDataSet, KustoDatabaseDataSet, SqlDWTableDataSet, SqlDBTableDataSet
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
-
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: BlobDataSetMapping, BlobFolderDataSetMapping, BlobContainerDataSetMapping, ADLSGen2FileDataSetMapping, ADLSGen2FolderDataSetMapping, ADLSGen2FileSystemDataSetMapping, KustoClusterDataSetMapping, KustoDatabaseDataSetMapping, SqlDWTableDataSetMapping, SqlDBTableDataSetMapping
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.datashare.models.
DataShareError
(*, error, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The data share error model.
All required parameters must be populated in order to send to Azure.
- Parameters
error (DataShareErrorInfo) – Required. The data share error body
-
class
azure.mgmt.datashare.models.
DataShareErrorInfo
(*, code: str, message: str, details=None, target: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The data share error body model.
All required parameters must be populated in order to send to Azure.
- Parameters
code (str) – Required. Code of the error
details (list[DataShareErrorInfo]) – Nested details of the error model
message (str) – Required. Message of the error
target (str) – Target of the error
-
class
azure.mgmt.datashare.models.
DefaultDto
(*, location: str = None, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Base data transfer object implementation for default resources.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datashare.models.
DimensionProperties
(*, display_name: str = None, name: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
properties for dimension.
-
class
azure.mgmt.datashare.models.
Identity
(*, type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Identity of resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datashare.models.
Invitation
(*, target_active_directory_id: str = None, target_email: str = None, target_object_id: 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
name (str) – Name of the azure resource
invitation_id (str) – unique invitation id
invitation_status (str or InvitationStatus) – The status of the invitation. Possible values include: ‘Pending’, ‘Accepted’, ‘Rejected’, ‘Withdrawn’
responded_at (datetime) – The time the recipient responded to the invitation.
sent_at (datetime) – Gets the time at which the invitation was sent.
user_email (str) – Email of the user who created the resource
user_name (str) – Name of the user who created the resource
- Parameters
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.
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
name (str) – Name of the azure resource
data_set_id (str) – Unique id for identifying a data set resource
location (str) – Location of the kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the kusto cluster data set. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
location (str) – Location of the sink kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
-
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
name (str) – Name of the azure resource
data_set_id (str) – Unique id for identifying a data set resource
location (str) – Location of the kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the kusto database data set. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
-
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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
location (str) – Location of the sink kusto cluster.
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
-
class
azure.mgmt.datashare.models.
OperationMetaLogSpecification
(*, blob_duration: str = None, display_name: str = None, name: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
log specifications for operation api.
-
class
azure.mgmt.datashare.models.
OperationMetaMetricSpecification
(*, aggregation_type: str = None, dimensions=None, display_description: str = None, display_name: str = None, enable_regional_mdm_account: str = None, internal_metric_name: str = None, name: str = None, resource_id_dimension_name_override: str = None, supported_aggregation_types=None, supported_time_grain_types=None, unit: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
metric specifications for the operation.
- Parameters
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
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=None, metric_specifications=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The operation meta service specification.
- Parameters
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=None, name: str = None, origin: str = None, service_specification=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response model for get operations.
- Parameters
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: str = None, operation: str = None, provider: str = None, resource: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties on operations.
-
class
azure.mgmt.datashare.models.
OperationResponse
(*, status, end_time=None, error=None, start_time=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Response for long running operation.
All required parameters must be populated in order to send to Azure.
- Parameters
end_time (datetime) – start time
error (DataShareErrorInfo) – The error property when status is failed.
start_time (datetime) – start time
status (str or Status) – Required. Operation state of the long running operation. Possible values include: ‘Accepted’, ‘InProgress’, ‘TransientFailure’, ‘Succeeded’, ‘Failed’, ‘Canceled’
-
class
azure.mgmt.datashare.models.
ProviderShareSubscription
(**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
name (str) – Name 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
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. Possible values include: ‘Active’, ‘Revoked’, ‘SourceDeleted’, ‘Revoking’
-
class
azure.mgmt.datashare.models.
ProxyDto
(**kwargs)[source]¶ Bases:
msrest.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.
-
class
azure.mgmt.datashare.models.
ScheduledSourceSynchronizationSetting
(*, recurrence_interval=None, synchronization_time=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.
- Parameters
kind (str) – Required. Constant filled by server.
recurrence_interval (str or RecurrenceInterval) – Recurrence Interval. Possible values include: ‘Hour’, ‘Day’
synchronization_time (datetime) – Synchronization time
-
class
azure.mgmt.datashare.models.
ScheduledSynchronizationSetting
(*, recurrence_interval, synchronization_time, **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
name (str) – Name of the azure resource
created_at (datetime) – Time at which the synchronization setting was created.
provisioning_state (str or ProvisioningState) – Gets or sets the provisioning state. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
user_name (str) – Name of the user who created the synchronization setting.
- Parameters
kind (str) – Required. Constant filled by server.
recurrence_interval (str or RecurrenceInterval) – Required. Recurrence Interval. Possible values include: ‘Hour’, ‘Day’
synchronization_time (datetime) – Required. Synchronization time
-
class
azure.mgmt.datashare.models.
ScheduledTrigger
(*, recurrence_interval, synchronization_time, synchronization_mode=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
name (str) – Name of the azure resource
created_at (datetime) – Time at which the trigger was created.
provisioning_state (str or ProvisioningState) – Gets the provisioning state. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
trigger_status (str or TriggerStatus) – Gets the trigger state. Possible values include: ‘Active’, ‘Inactive’, ‘SourceSynchronizationSettingDeleted’
user_name (str) – Name of the user who created the trigger.
- Parameters
kind (str) – Required. Constant filled by server.
recurrence_interval (str or RecurrenceInterval) – Required. Recurrence Interval. Possible values include: ‘Hour’, ‘Day’
synchronization_mode (str or SynchronizationMode) – Synchronization mode. Possible values include: ‘Incremental’, ‘FullSync’
synchronization_time (datetime) – Required. Synchronization time
-
class
azure.mgmt.datashare.models.
Share
(*, description: str = None, share_kind=None, terms: 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
name (str) – Name of the azure resource
created_at (datetime) – Time at which the share was created.
provisioning_state (str or ProvisioningState) – Gets or sets the provisioning state. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
user_email (str) – Email of the user who created the resource
user_name (str) – Name of the user who created the resource
- Parameters
-
class
azure.mgmt.datashare.models.
ShareSubscription
(*, invitation_id: str, source_share_location: str, **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
name (str) – Name of the azure resource
created_at (datetime) – Time at which the share subscription was created.
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. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
share_description (str) – Description of share
share_kind (str or ShareKind) – Kind of share. Possible values include: ‘CopyBased’, ‘InPlace’
share_name (str) – Name of the share
share_subscription_status (str or ShareSubscriptionStatus) – Gets the current status of share subscription. Possible values include: ‘Active’, ‘Revoked’, ‘SourceDeleted’, ‘Revoking’
share_terms (str) – Terms of a share
user_email (str) – Email of the user who created the resource
user_name (str) – Name of the user who created the resource
- Parameters
-
class
azure.mgmt.datashare.models.
ShareSubscriptionSynchronization
(*, synchronization_id: str, **kwargs)[source]¶ Bases:
msrest.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_mode (str or SynchronizationMode) – Synchronization Mode. Possible values include: ‘Incremental’, ‘FullSync’
- Parameters
synchronization_id (str) – Required. Synchronization id
-
class
azure.mgmt.datashare.models.
ShareSynchronization
(*, consumer_email: str = None, consumer_name: str = None, consumer_tenant_name: str = None, duration_ms: int = None, end_time=None, message: str = None, start_time=None, status: str = None, synchronization_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A ShareSynchronization data transfer object.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
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
- Variables
synchronization_mode (str or SynchronizationMode) – Synchronization mode. Possible values include: ‘Incremental’, ‘FullSync’
-
class
azure.mgmt.datashare.models.
SourceShareSynchronizationSetting
(**kwargs)[source]¶ Bases:
msrest.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.
- Parameters
kind (str) – Required. Constant filled by server.
-
class
azure.mgmt.datashare.models.
SqlDBTableDataSet
(*, database_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **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
- Parameters
kind (str) – Required. Constant filled by server.
database_name (str) – Required. Database name of the source data set
schema_name (str) – Required. Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Required. Resource id of SQL server
table_name (str) – Required. 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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
database_name (str) – Required. DatabaseName name of the sink data set
data_set_id (str) – Required. The id of the source data set.
schema_name (str) – Required. Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Required. Resource id of SQL server
table_name (str) – Required. SQL DB table name.
-
class
azure.mgmt.datashare.models.
SqlDWTableDataSet
(*, data_warehouse_name: str, schema_name: str, sql_server_resource_id: str, table_name: str, **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
- Parameters
kind (str) – Required. Constant filled by server.
data_warehouse_name (str) – Required. DataWarehouse name of the source data set
schema_name (str) – Required. Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Required. Resource id of SQL server
table_name (str) – Required. 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
name (str) – Name of the azure resource
data_set_mapping_status (str or DataSetMappingStatus) – Gets the status of the data set mapping. Possible values include: ‘Ok’, ‘Broken’
provisioning_state (str or ProvisioningState) – Provisioning state of the data set mapping. Possible values include: ‘Succeeded’, ‘Creating’, ‘Deleting’, ‘Moving’, ‘Failed’
- Parameters
kind (str) – Required. Constant filled by server.
data_set_id (str) – Required. The id of the source data set.
data_warehouse_name (str) – Required. DataWarehouse name of the source data set
schema_name (str) – Required. Schema of the table. Default value is dbo.
sql_server_resource_id (str) – Required. Resource id of SQL server
table_name (str) – Required. SQL DW table name.
-
class
azure.mgmt.datashare.models.
SynchronizationDetails
(**kwargs)[source]¶ Bases:
msrest.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. Possible values include: ‘Blob’, ‘Container’, ‘BlobFolder’, ‘AdlsGen2FileSystem’, ‘AdlsGen2Folder’, ‘AdlsGen2File’, ‘AdlsGen1Folder’, ‘AdlsGen1File’, ‘KustoCluster’, ‘KustoDatabase’, ‘SqlDBTable’, ‘SqlDWTable’
duration_ms (int) – Duration of data set level copy
end_time (datetime) – End time of data set level copy
files_read (long) – The number of files read from the source data set
files_written (long) – 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 (long) – The number of files copied into the sink data set
rows_read (long) – The number of rows read from the source data set.
size_read (long) – The size of the data read from the source data set in bytes
size_written (long) – 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 (long) – The vCore units consumed for the data set synchronization
-
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.
-
class
azure.mgmt.datashare.models.
Synchronize
(*, synchronization_mode=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Payload for the synchronizing the data.
- Parameters
synchronization_mode (str or SynchronizationMode) – Mode of synchronization used in triggers and snapshot sync. Incremental by default. Possible values include: ‘Incremental’, ‘FullSync’
-
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.
-
class
azure.mgmt.datashare.models.
AccountPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Account
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ConsumerInvitationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ConsumerInvitation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
DataSetPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DataSet
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
DataSetMappingPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DataSetMapping
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
InvitationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Invitation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
OperationModelPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
OperationModel
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
SharePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Share
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ShareSynchronizationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ShareSynchronization
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
SynchronizationDetailsPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SynchronizationDetails
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ProviderShareSubscriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ProviderShareSubscription
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ShareSubscriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ShareSubscription
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
SourceShareSynchronizationSettingPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SourceShareSynchronizationSetting
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ShareSubscriptionSynchronizationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ShareSubscriptionSynchronization
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ConsumerSourceDataSetPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ConsumerSourceDataSet
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
SynchronizationSettingPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SynchronizationSetting
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
TriggerPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Trigger
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.datashare.models.
ProvisioningState
[source]¶ -
An enumeration.
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
moving
= 'Moving'¶
-
succeeded
= 'Succeeded'¶
-
-
class
azure.mgmt.datashare.models.
Status
[source]¶ -
An enumeration.
-
accepted
= 'Accepted'¶
-
canceled
= 'Canceled'¶
-
failed
= 'Failed'¶
-
in_progress
= 'InProgress'¶
-
succeeded
= 'Succeeded'¶
-
transient_failure
= 'TransientFailure'¶
-
-
class
azure.mgmt.datashare.models.
InvitationStatus
[source]¶ -
An enumeration.
-
accepted
= 'Accepted'¶
-
pending
= 'Pending'¶
-
rejected
= 'Rejected'¶
-
withdrawn
= 'Withdrawn'¶
-
-
class
azure.mgmt.datashare.models.
ShareKind
[source]¶ -
An enumeration.
-
copy_based
= 'CopyBased'¶
-
in_place
= 'InPlace'¶
-
-
class
azure.mgmt.datashare.models.
SynchronizationMode
[source]¶ -
An enumeration.
-
full_sync
= 'FullSync'¶
-
incremental
= 'Incremental'¶
-
-
class
azure.mgmt.datashare.models.
DataSetType
[source]¶ -
An enumeration.
-
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'¶
-
-
class
azure.mgmt.datashare.models.
ShareSubscriptionStatus
[source]¶ -
An enumeration.
-
active
= 'Active'¶
-
revoked
= 'Revoked'¶
-
revoking
= 'Revoking'¶
-
source_deleted
= 'SourceDeleted'¶
-
-
class
azure.mgmt.datashare.models.
RecurrenceInterval
[source]¶ -
An enumeration.
-
day
= 'Day'¶
-
hour
= 'Hour'¶
-
-
class
azure.mgmt.datashare.models.
TriggerStatus
[source]¶ -
An enumeration.
-
active
= 'Active'¶
-
inactive
= 'Inactive'¶
-
source_synchronization_setting_deleted
= 'SourceSynchronizationSettingDeleted'¶
-