azure.mgmt.kusto.models module¶

class azure.mgmt.kusto.models.AttachedDatabaseConfiguration(*, database_name: str, cluster_resource_id: str, default_principals_modification_kind, location: str = None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.ProxyResource

Class representing an attached database configuration.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’
attached_database_names (list[str]) – The list of databases from the clusterResourceId which are currently attached to the cluster.

Parameters

location (str) – Resource location.
database_name (str) – Required. The name of the database which you would like to attach, use * if you want to follow all current and future databases.
cluster_resource_id (str) – Required. The resource id of the cluster where the databases you would like to attach reside.
default_principals_modification_kind (str or DefaultPrincipalsModificationKind) – Required. The default principals modification kind. Possible values include: ‘Union’, ‘Replace’, ‘None’

class azure.mgmt.kusto.models.AttachedDatabaseConfigurationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of AttachedDatabaseConfiguration object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.AzureCapacity(*, scale_type, minimum: int, maximum: int, default: int, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure capacity definition.

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

Parameters

scale_type (str or AzureScaleType) – Required. Scale type. Possible values include: ‘automatic’, ‘manual’, ‘none’
minimum (int) – Required. Minimum allowed capacity.
maximum (int) – Required. Maximum allowed capacity.
default (int) – Required. The default capacity that would be used.

class azure.mgmt.kusto.models.AzureEntityResource(**kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Resource

The resource model definition for a Azure Resource Manager resource with an etag.

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

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
etag (str) – Resource Etag.

class azure.mgmt.kusto.models.AzureResourceSku(*, resource_type: str = None, sku=None, capacity=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure resource SKU definition.

Parameters

resource_type (str) – Resource Namespace and Type.
sku (AzureSku) – The SKU details.
capacity (AzureCapacity) – The number of instances of the cluster.

class azure.mgmt.kusto.models.AzureResourceSkuPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of AzureResourceSku object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.AzureScaleType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

automatic = 'automatic'¶

manual = 'manual'¶

none = 'none'¶

class azure.mgmt.kusto.models.AzureSku(*, name, tier, capacity: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure SKU definition.

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

Parameters

name (str or AzureSkuName) – Required. SKU name. Possible values include: ‘Standard_DS13_v2+1TB_PS’, ‘Standard_DS13_v2+2TB_PS’, ‘Standard_DS14_v2+3TB_PS’, ‘Standard_DS14_v2+4TB_PS’, ‘Standard_D13_v2’, ‘Standard_D14_v2’, ‘Standard_L8s’, ‘Standard_L16s’, ‘Standard_D11_v2’, ‘Standard_D12_v2’, ‘Standard_L4s’, ‘Dev(No SLA)_Standard_D11_v2’, ‘Standard_E2a_v4’, ‘Standard_E4a_v4’, ‘Standard_E8a_v4’, ‘Standard_E16a_v4’, ‘Standard_E8as_v4+1TB_PS’, ‘Standard_E8as_v4+2TB_PS’, ‘Standard_E16as_v4+3TB_PS’, ‘Standard_E16as_v4+4TB_PS’, ‘Dev(No SLA)_Standard_E2a_v4’
capacity (int) – The number of instances of the cluster.
tier (str or AzureSkuTier) – Required. SKU tier. Possible values include: ‘Basic’, ‘Standard’

class azure.mgmt.kusto.models.AzureSkuName(value)[source]¶

Bases: str, enum.Enum

An enumeration.

dev_no_sla_standard_d11_v2 = 'Dev(No SLA)_Standard_D11_v2'¶

dev_no_sla_standard_e2a_v4 = 'Dev(No SLA)_Standard_E2a_v4'¶

standard_d11_v2 = 'Standard_D11_v2'¶

standard_d12_v2 = 'Standard_D12_v2'¶

standard_d13_v2 = 'Standard_D13_v2'¶

standard_d14_v2 = 'Standard_D14_v2'¶

standard_ds13_v21_tb_ps = 'Standard_DS13_v2+1TB_PS'¶

standard_ds13_v22_tb_ps = 'Standard_DS13_v2+2TB_PS'¶

standard_ds14_v23_tb_ps = 'Standard_DS14_v2+3TB_PS'¶

standard_ds14_v24_tb_ps = 'Standard_DS14_v2+4TB_PS'¶

standard_e16a_v4 = 'Standard_E16a_v4'¶

standard_e16as_v43_tb_ps = 'Standard_E16as_v4+3TB_PS'¶

standard_e16as_v44_tb_ps = 'Standard_E16as_v4+4TB_PS'¶

standard_e2a_v4 = 'Standard_E2a_v4'¶

standard_e4a_v4 = 'Standard_E4a_v4'¶

standard_e8a_v4 = 'Standard_E8a_v4'¶

standard_e8as_v41_tb_ps = 'Standard_E8as_v4+1TB_PS'¶

standard_e8as_v42_tb_ps = 'Standard_E8as_v4+2TB_PS'¶

standard_l16s = 'Standard_L16s'¶

standard_l4s = 'Standard_L4s'¶

standard_l8s = 'Standard_L8s'¶

class azure.mgmt.kusto.models.AzureSkuTier(value)[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

standard = 'Standard'¶

class azure.mgmt.kusto.models.BlobStorageEventType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

microsoft_storage_blob_created = 'Microsoft.Storage.BlobCreated'¶

microsoft_storage_blob_renamed = 'Microsoft.Storage.BlobRenamed'¶

class azure.mgmt.kusto.models.CheckNameRequest(*, name: str, type, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result returned from a database check name availability request.

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

Parameters

name (str) – Required. Resource name.
type (str or Type) – Required. The type of resource, for instance Microsoft.Kusto/clusters/databases. Possible values include: ‘Microsoft.Kusto/clusters/databases’, ‘Microsoft.Kusto/clusters/attachedDatabaseConfigurations’

class azure.mgmt.kusto.models.CheckNameResult(*, name_available: bool = None, name: str = None, message: str = None, reason=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result returned from a check name availability request.

Parameters

name_available (bool) – Specifies a Boolean value that indicates if the name is available.
name (str) – The name that was checked.
message (str) – Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
reason (str or Reason) – Message providing the reason why the given name is invalid. Possible values include: ‘Invalid’, ‘AlreadyExists’

class azure.mgmt.kusto.models.Cluster(*, location: str, sku, tags=None, zones=None, identity=None, trusted_external_tenants=None, optimized_autoscale=None, enable_disk_encryption: bool = None, enable_streaming_ingest: bool = False, virtual_network_configuration=None, key_vault_properties=None, enable_purge: bool = False, enable_double_encryption: bool = False, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.TrackedResource

Class representing a Kusto cluster.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
state (str or State) – The state of the resource. Possible values include: ‘Creating’, ‘Unavailable’, ‘Running’, ‘Deleting’, ‘Deleted’, ‘Stopping’, ‘Stopped’, ‘Starting’, ‘Updating’
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’
uri (str) – The cluster URI.
data_ingestion_uri (str) – The cluster data ingestion URI.
state_reason (str) – The reason for the cluster’s current state.
language_extensions (LanguageExtensionsList) – List of the cluster’s language extensions.

Parameters

tags (dict[str, str]) – Resource tags.
location (str) – Required. The geo-location where the resource lives
sku (AzureSku) – Required. The SKU of the cluster.
zones (list[str]) – The availability zones of the cluster.
identity (Identity) – The identity of the cluster, if configured.
trusted_external_tenants (list[TrustedExternalTenant]) – The cluster’s external tenants.
optimized_autoscale (OptimizedAutoscale) – Optimized auto scale definition.
enable_disk_encryption (bool) – A boolean value that indicates if the cluster’s disks are encrypted.
enable_streaming_ingest (bool) – A boolean value that indicates if the streaming ingest is enabled. Default value: False .
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network definition.
key_vault_properties (KeyVaultProperties) – KeyVault properties for the cluster encryption.
enable_purge (bool) – A boolean value that indicates if the purge operations are enabled. Default value: False .
enable_double_encryption (bool) – A boolean value that indicates if double encryption is enabled. Default value: False .

class azure.mgmt.kusto.models.ClusterCheckNameRequest(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result returned from a cluster check name availability request.

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.

Parameters: name (str) – Required. Cluster name.
Variables: type (str) – Required. The type of resource, Microsoft.Kusto/clusters. Default value: “Microsoft.Kusto/clusters” .

type = 'Microsoft.Kusto/clusters'¶

class azure.mgmt.kusto.models.ClusterPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Cluster object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.ClusterPrincipalAssignment(*, principal_id: str, role, principal_type, tenant_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.ProxyResource

Class representing a cluster principal assignment.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
tenant_name (str) – The tenant name of the principal
principal_name (str) – The principal name
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’

Parameters

principal_id (str) – Required. The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
role (str or ClusterPrincipalRole) – Required. Cluster principal role. Possible values include: ‘AllDatabasesAdmin’, ‘AllDatabasesViewer’
tenant_id (str) – The tenant id of the principal
principal_type (str or PrincipalType) – Required. Principal type. Possible values include: ‘App’, ‘Group’, ‘User’

class azure.mgmt.kusto.models.ClusterPrincipalAssignmentCheckNameRequest(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A principal assignment check name availability request.

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.

Parameters: name (str) – Required. Principal Assignment resource name.
Variables: type (str) – Required. The type of resource, Microsoft.Kusto/clusters/principalAssignments. Default value: “Microsoft.Kusto/clusters/principalAssignments” .

type = 'Microsoft.Kusto/clusters/principalAssignments'¶

class azure.mgmt.kusto.models.ClusterPrincipalAssignmentPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ClusterPrincipalAssignment object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.ClusterPrincipalRole(value)[source]¶

Bases: str, enum.Enum

An enumeration.

all_databases_admin = 'AllDatabasesAdmin'¶

all_databases_viewer = 'AllDatabasesViewer'¶

class azure.mgmt.kusto.models.ClusterUpdate(*, tags=None, location: str = None, sku=None, identity=None, trusted_external_tenants=None, optimized_autoscale=None, enable_disk_encryption: bool = None, enable_streaming_ingest: bool = False, virtual_network_configuration=None, key_vault_properties=None, enable_purge: bool = False, enable_double_encryption: bool = False, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Resource

Class representing an update to a Kusto cluster.

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

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
state (str or State) – The state of the resource. Possible values include: ‘Creating’, ‘Unavailable’, ‘Running’, ‘Deleting’, ‘Deleted’, ‘Stopping’, ‘Stopped’, ‘Starting’, ‘Updating’
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’
uri (str) – The cluster URI.
data_ingestion_uri (str) – The cluster data ingestion URI.
state_reason (str) – The reason for the cluster’s current state.
language_extensions (LanguageExtensionsList) – List of the cluster’s language extensions.

Parameters

tags (dict[str, str]) – Resource tags.
location (str) – Resource location.
sku (AzureSku) – The SKU of the cluster.
identity (Identity) – The identity of the cluster, if configured.
trusted_external_tenants (list[TrustedExternalTenant]) – The cluster’s external tenants.
optimized_autoscale (OptimizedAutoscale) – Optimized auto scale definition.
enable_disk_encryption (bool) – A boolean value that indicates if the cluster’s disks are encrypted.
enable_streaming_ingest (bool) – A boolean value that indicates if the streaming ingest is enabled. Default value: False .
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network definition.
key_vault_properties (KeyVaultProperties) – KeyVault properties for the cluster encryption.
enable_purge (bool) – A boolean value that indicates if the purge operations are enabled. Default value: False .
enable_double_encryption (bool) – A boolean value that indicates if double encryption is enabled. Default value: False .

class azure.mgmt.kusto.models.Compression(value)[source]¶

Bases: str, enum.Enum

An enumeration.

gzip = 'GZip'¶

none = 'None'¶

class azure.mgmt.kusto.models.DataConnection(*, location: str = None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.ProxyResource

Class representing an data connection.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventHubDataConnection, IotHubDataConnection, EventGridDataConnection

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.

class azure.mgmt.kusto.models.DataConnectionCheckNameRequest(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A data connection check name availability request.

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.

Parameters: name (str) – Required. Data Connection name.
Variables: type (str) – Required. The type of resource, Microsoft.Kusto/clusters/databases/dataConnections. Default value: “Microsoft.Kusto/clusters/databases/dataConnections” .

type = 'Microsoft.Kusto/clusters/databases/dataConnections'¶

class azure.mgmt.kusto.models.DataConnectionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataConnection object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.DataConnectionValidation(*, data_connection_name: str = None, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Class representing an data connection validation.

Parameters

data_connection_name (str) – The name of the data connection.
properties (DataConnection) – The data connection properties to validate.

class azure.mgmt.kusto.models.DataConnectionValidationListResult(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The list Kusto data connection validation result.

Parameters: value (list[DataConnectionValidationResult]) – The list of Kusto data connection validation errors.

class azure.mgmt.kusto.models.DataConnectionValidationResult(*, error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result returned from a data connection validation request.

Parameters: error_message (str) – A message which indicates a problem in data connection validation.

class azure.mgmt.kusto.models.Database(*, location: str = None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.ProxyResource

Class representing a Kusto database.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ReadWriteDatabase, ReadOnlyFollowingDatabase

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.

class azure.mgmt.kusto.models.DatabasePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Database object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.DatabasePrincipal(*, role, name: str, type, fqn: str = None, email: str = None, app_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A class representing database principal entity.

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.

Parameters

role (str or DatabasePrincipalRole) – Required. Database principal role. Possible values include: ‘Admin’, ‘Ingestor’, ‘Monitor’, ‘User’, ‘UnrestrictedViewers’, ‘Viewer’
name (str) – Required. Database principal name.
type (str or DatabasePrincipalType) – Required. Database principal type. Possible values include: ‘App’, ‘Group’, ‘User’
fqn (str) – Database principal fully qualified name.
email (str) – Database principal email if exists.
app_id (str) – Application id - relevant only for application principal type.

Variables

tenant_name (str) – The tenant name of the principal

class azure.mgmt.kusto.models.DatabasePrincipalAssignment(*, principal_id: str, role, principal_type, tenant_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.ProxyResource

Class representing a database principal assignment.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
tenant_name (str) – The tenant name of the principal
principal_name (str) – The principal name
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’

Parameters

principal_id (str) – Required. The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
role (str or DatabasePrincipalRole) – Required. Database principal role. Possible values include: ‘Admin’, ‘Ingestor’, ‘Monitor’, ‘User’, ‘UnrestrictedViewers’, ‘Viewer’
tenant_id (str) – The tenant id of the principal
principal_type (str or PrincipalType) – Required. Principal type. Possible values include: ‘App’, ‘Group’, ‘User’

class azure.mgmt.kusto.models.DatabasePrincipalAssignmentCheckNameRequest(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A principal assignment check name availability request.

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.

Parameters: name (str) – Required. Principal Assignment resource name.
Variables: type (str) – Required. The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments. Default value: “Microsoft.Kusto/clusters/databases/principalAssignments” .

type = 'Microsoft.Kusto/clusters/databases/principalAssignments'¶

class azure.mgmt.kusto.models.DatabasePrincipalAssignmentPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatabasePrincipalAssignment object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.DatabasePrincipalListRequest(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The list Kusto database principals operation request.

Parameters: value (list[DatabasePrincipal]) – The list of Kusto database principals.

class azure.mgmt.kusto.models.DatabasePrincipalListResult(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The list Kusto database principals operation response.

Parameters: value (list[DatabasePrincipal]) – The list of Kusto database principals.

class azure.mgmt.kusto.models.DatabasePrincipalPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatabasePrincipal object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.DatabasePrincipalRole(value)[source]¶

Bases: str, enum.Enum

An enumeration.

admin = 'Admin'¶

ingestor = 'Ingestor'¶

monitor = 'Monitor'¶

unrestricted_viewers = 'UnrestrictedViewers'¶

user = 'User'¶

viewer = 'Viewer'¶

class azure.mgmt.kusto.models.DatabasePrincipalType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

app = 'App'¶

group = 'Group'¶

user = 'User'¶

class azure.mgmt.kusto.models.DatabaseStatistics(*, size: float = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A class that contains database statistics information.

Parameters: size (float) – The database size - the total size of compressed data and index in bytes.

class azure.mgmt.kusto.models.DefaultPrincipalsModificationKind(value)[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

replace = 'Replace'¶

union = 'Union'¶

class azure.mgmt.kusto.models.DiagnoseVirtualNetworkResult(*, findings=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DiagnoseVirtualNetworkResult.

Parameters: findings (list[str]) – The list of network connectivity diagnostic finding

class azure.mgmt.kusto.models.EventGridDataConnection(*, storage_account_resource_id: str, event_hub_resource_id: str, consumer_group: str, location: str = None, table_name: str = None, mapping_rule_name: str = None, data_format=None, ignore_first_record: bool = None, blob_storage_event_type=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.DataConnection

Class representing an Event Grid data connection.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.
storage_account_resource_id (str) – Required. The resource ID of the storage account where the data resides.
event_hub_resource_id (str) – Required. The resource ID where the event grid is configured to send events.
consumer_group (str) – Required. The event hub consumer group.
table_name (str) – The table where the data should be ingested. Optionally the table information can be added to each message.
mapping_rule_name (str) – The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
data_format (str or EventGridDataFormat) – The data format of the message. Optionally the data format can be added to each message. Possible values include: ‘MULTIJSON’, ‘JSON’, ‘CSV’, ‘TSV’, ‘SCSV’, ‘SOHSV’, ‘PSV’, ‘TXT’, ‘RAW’, ‘SINGLEJSON’, ‘AVRO’, ‘TSVE’, ‘PARQUET’, ‘ORC’, ‘APACHEAVRO’, ‘W3CLOGFILE’
ignore_first_record (bool) – A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file
blob_storage_event_type (str or BlobStorageEventType) – The name of blob storage event type to process. Possible values include: ‘Microsoft.Storage.BlobCreated’, ‘Microsoft.Storage.BlobRenamed’

class azure.mgmt.kusto.models.EventGridDataFormat(value)[source]¶

Bases: str, enum.Enum

An enumeration.

apacheavro = 'APACHEAVRO'¶

avro = 'AVRO'¶

csv = 'CSV'¶

json = 'JSON'¶

multijson = 'MULTIJSON'¶

orc = 'ORC'¶

parquet = 'PARQUET'¶

psv = 'PSV'¶

raw = 'RAW'¶

scsv = 'SCSV'¶

singlejson = 'SINGLEJSON'¶

sohsv = 'SOHSV'¶

tsv = 'TSV'¶

tsve = 'TSVE'¶

txt = 'TXT'¶

w3_clogfile = 'W3CLOGFILE'¶

class azure.mgmt.kusto.models.EventHubDataConnection(*, event_hub_resource_id: str, consumer_group: str, location: str = None, table_name: str = None, mapping_rule_name: str = None, data_format=None, event_system_properties=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.DataConnection

Class representing an event hub data connection.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.
event_hub_resource_id (str) – Required. The resource ID of the event hub to be used to create a data connection.
consumer_group (str) – Required. The event hub consumer group.
table_name (str) – The table where the data should be ingested. Optionally the table information can be added to each message.
mapping_rule_name (str) – The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
data_format (str or EventHubDataFormat) – The data format of the message. Optionally the data format can be added to each message. Possible values include: ‘MULTIJSON’, ‘JSON’, ‘CSV’, ‘TSV’, ‘SCSV’, ‘SOHSV’, ‘PSV’, ‘TXT’, ‘RAW’, ‘SINGLEJSON’, ‘AVRO’, ‘TSVE’, ‘PARQUET’, ‘ORC’, ‘APACHEAVRO’, ‘W3CLOGFILE’
event_system_properties (list[str]) – System properties of the event hub
compression (str or Compression) – The event hub messages compression type. Possible values include: ‘None’, ‘GZip’

class azure.mgmt.kusto.models.EventHubDataFormat(value)[source]¶

Bases: str, enum.Enum

An enumeration.

apacheavro = 'APACHEAVRO'¶

avro = 'AVRO'¶

csv = 'CSV'¶

json = 'JSON'¶

multijson = 'MULTIJSON'¶

orc = 'ORC'¶

parquet = 'PARQUET'¶

psv = 'PSV'¶

raw = 'RAW'¶

scsv = 'SCSV'¶

singlejson = 'SINGLEJSON'¶

sohsv = 'SOHSV'¶

tsv = 'TSV'¶

tsve = 'TSVE'¶

txt = 'TXT'¶

w3_clogfile = 'W3CLOGFILE'¶

class azure.mgmt.kusto.models.FollowerDatabaseDefinition(*, cluster_resource_id: str, attached_database_configuration_name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A class representing follower database request.

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.

Parameters

cluster_resource_id (str) – Required. Resource id of the cluster that follows a database owned by this cluster.
attached_database_configuration_name (str) – Required. Resource name of the attached database configuration in the follower cluster.

Variables

database_name (str) – The database name owned by this cluster that was followed. * in case following all databases.

class azure.mgmt.kusto.models.FollowerDatabaseDefinitionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of FollowerDatabaseDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.Identity(*, type, user_assigned_identities=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Identity for the resource.

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

principal_id (str) – The principal ID of resource identity.
tenant_id (str) – The tenant ID of resource.

Parameters

type (str or IdentityType) – Required. The identity type. Possible values include: ‘None’, ‘SystemAssigned’
user_assigned_identities (dict[str, IdentityUserAssignedIdentitiesValue]) – The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

class azure.mgmt.kusto.models.IdentityType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

system_assigned = 'SystemAssigned'¶

class azure.mgmt.kusto.models.IdentityUserAssignedIdentitiesValue(**kwargs)[source]¶

Bases: msrest.serialization.Model

IdentityUserAssignedIdentitiesValue.

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

Variables

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.kusto.models.IotHubDataConnection(*, iot_hub_resource_id: str, consumer_group: str, shared_access_policy_name: str, location: str = None, table_name: str = None, mapping_rule_name: str = None, data_format=None, event_system_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.DataConnection

Class representing an iot hub data connection.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.
iot_hub_resource_id (str) – Required. The resource ID of the Iot hub to be used to create a data connection.
consumer_group (str) – Required. The iot hub consumer group.
table_name (str) – The table where the data should be ingested. Optionally the table information can be added to each message.
mapping_rule_name (str) – The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
data_format (str or IotHubDataFormat) – The data format of the message. Optionally the data format can be added to each message. Possible values include: ‘MULTIJSON’, ‘JSON’, ‘CSV’, ‘TSV’, ‘SCSV’, ‘SOHSV’, ‘PSV’, ‘TXT’, ‘RAW’, ‘SINGLEJSON’, ‘AVRO’, ‘TSVE’, ‘PARQUET’, ‘ORC’, ‘APACHEAVRO’, ‘W3CLOGFILE’
event_system_properties (list[str]) – System properties of the iot hub
shared_access_policy_name (str) – Required. The name of the share access policy

class azure.mgmt.kusto.models.IotHubDataFormat(value)[source]¶

Bases: str, enum.Enum

An enumeration.

apacheavro = 'APACHEAVRO'¶

avro = 'AVRO'¶

csv = 'CSV'¶

json = 'JSON'¶

multijson = 'MULTIJSON'¶

orc = 'ORC'¶

parquet = 'PARQUET'¶

psv = 'PSV'¶

raw = 'RAW'¶

scsv = 'SCSV'¶

singlejson = 'SINGLEJSON'¶

sohsv = 'SOHSV'¶

tsv = 'TSV'¶

tsve = 'TSVE'¶

txt = 'TXT'¶

w3_clogfile = 'W3CLOGFILE'¶

class azure.mgmt.kusto.models.KeyVaultProperties(*, key_name: str, key_version: str, key_vault_uri: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of the key vault.

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

Parameters

key_name (str) – Required. The name of the key vault key.
key_version (str) – Required. The version of the key vault key.
key_vault_uri (str) – Required. The Uri of the key vault.

class azure.mgmt.kusto.models.LanguageExtension(*, language_extension_name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The language extension object.

Parameters: language_extension_name (str or LanguageExtensionName) – The language extension name. Possible values include: ‘PYTHON’, ‘R’

class azure.mgmt.kusto.models.LanguageExtensionName(value)[source]¶

Bases: str, enum.Enum

An enumeration.

python = 'PYTHON'¶

r = 'R'¶

class azure.mgmt.kusto.models.LanguageExtensionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of LanguageExtension object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.LanguageExtensionsList(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The list of language extension objects.

Parameters: value (list[LanguageExtension]) – The list of language extensions.

class azure.mgmt.kusto.models.Operation(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A REST API operation.

Parameters

name (str) – The operation name. This is of the format {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that describes the operation.
origin (str) – The intended executor of the operation.
properties (object) – Properties of the operation.

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

Bases: msrest.serialization.Model

The object that describes the operation.

Parameters

provider (str) – Friendly name of the resource provider.
operation (str) – The operation type. For example: read, write, delete.
resource (str) – The resource type on which the operation is performed.
description (str) – The friendly name of the operation.

class azure.mgmt.kusto.models.OperationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.OptimizedAutoscale(*, version: int, is_enabled: bool, minimum: int, maximum: int, **kwargs)[source]¶

Bases: msrest.serialization.Model

A class that contains the optimized auto scale definition.

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

Parameters

version (int) – Required. The version of the template defined, for instance 1.
is_enabled (bool) – Required. A boolean value that indicate if the optimized autoscale feature is enabled or not.
minimum (int) – Required. Minimum allowed instances count.
maximum (int) – Required. Maximum allowed instances count.

class azure.mgmt.kusto.models.PrincipalType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

app = 'App'¶

group = 'Group'¶

user = 'User'¶

class azure.mgmt.kusto.models.PrincipalsModificationKind(value)[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

replace = 'Replace'¶

union = 'Union'¶

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

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'¶

deleting = 'Deleting'¶

failed = 'Failed'¶

moving = 'Moving'¶

running = 'Running'¶

succeeded = 'Succeeded'¶

class azure.mgmt.kusto.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

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

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.kusto.models.ReadOnlyFollowingDatabase(*, location: str = None, hot_cache_period=None, statistics=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Database

Class representing a read only following database.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’
soft_delete_period (timedelta) – The time the data should be kept before it stops being accessible to queries in TimeSpan.
leader_cluster_resource_id (str) – The name of the leader cluster
attached_database_configuration_name (str) – The name of the attached database configuration cluster
principals_modification_kind (str or PrincipalsModificationKind) – The principals modification kind of the database. Possible values include: ‘Union’, ‘Replace’, ‘None’

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.
hot_cache_period (timedelta) – The time the data should be kept in cache for fast queries in TimeSpan.
statistics (DatabaseStatistics) – The statistics of the database.

class azure.mgmt.kusto.models.ReadWriteDatabase(*, location: str = None, soft_delete_period=None, hot_cache_period=None, statistics=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Database

Class representing a read write database.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Running’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Moving’
is_followed (bool) – Indicates whether the database is followed.

Parameters

location (str) – Resource location.
kind (str) – Required. Constant filled by server.
soft_delete_period (timedelta) – The time the data should be kept before it stops being accessible to queries in TimeSpan.
hot_cache_period (timedelta) – The time the data should be kept in cache for fast queries in TimeSpan.
statistics (DatabaseStatistics) – The statistics of the database.

class azure.mgmt.kusto.models.Reason(value)[source]¶

Bases: str, enum.Enum

An enumeration.

already_exists = 'AlreadyExists'¶

invalid = 'Invalid'¶

class azure.mgmt.kusto.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

Resource.

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

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.kusto.models.SkuDescription(**kwargs)[source]¶

Bases: msrest.serialization.Model

The Kusto SKU description of given resource type.

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

Variables

resource_type (str) – The resource type
name (str) – The name of the SKU
tier (str) – The tier of the SKU
locations (list[str]) – The set of locations that the SKU is available
location_info (list[SkuLocationInfoItem]) – Locations and zones
restrictions (list[object]) – The restrictions because of which SKU cannot be used

class azure.mgmt.kusto.models.SkuDescriptionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of SkuDescription object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.kusto.models.SkuLocationInfoItem(*, location: str, zones=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The locations and zones info for SKU.

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

Parameters

location (str) – Required. The available location of the SKU.
zones (list[str]) – The available zone of the SKU.

class azure.mgmt.kusto.models.State(value)[source]¶

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'¶

deleted = 'Deleted'¶

deleting = 'Deleting'¶

running = 'Running'¶

starting = 'Starting'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

unavailable = 'Unavailable'¶

updating = 'Updating'¶

class azure.mgmt.kusto.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]¶

Bases: azure.mgmt.kusto.models._models_py3.Resource

The resource model definition for a ARM tracked top level resource.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name (str) – The name of the resource
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

tags (dict[str, str]) – Resource tags.
location (str) – Required. The geo-location where the resource lives

class azure.mgmt.kusto.models.TrustedExternalTenant(*, value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents a tenant ID that is trusted by the cluster.

Parameters: value (str) – GUID representing an external tenant.

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

Bases: str, enum.Enum

An enumeration.

microsoft_kustoclustersattached_database_configurations = 'Microsoft.Kusto/clusters/attachedDatabaseConfigurations'¶

microsoft_kustoclustersdatabases = 'Microsoft.Kusto/clusters/databases'¶

class azure.mgmt.kusto.models.VirtualNetworkConfiguration(*, subnet_id: str, engine_public_ip_id: str, data_management_public_ip_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A class that contains virtual network definition.

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

Parameters

subnet_id (str) – Required. The subnet resource id.
engine_public_ip_id (str) – Required. Engine service’s public IP address resource id.
data_management_public_ip_id (str) – Required. Data management’s service public IP address resource id.