azure.mgmt.kusto.models module — Azure SDK for Python 2.0.0 documentation
Leah Mitchell
Published Feb 17, 2026
- class
azure.mgmt.kusto.models.AttachedDatabaseConfiguration(*, location: Optional[str] = None, database_name: Optional[str] = None, cluster_resource_id: Optional[str] = None, default_principals_modification_kind: Union[str, DefaultPrincipalsModificationKind, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass representing an attached database configuration.
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.
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) – 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) – The resource id of the cluster where the databases you would like to attach reside.
default_principals_modification_kind (str orDefaultPrincipalsModificationKind) – The default principals modification kind. Possible values include: “Union”, “Replace”, “None”.
- class
azure.mgmt.kusto.models.AttachedDatabaseConfigurationListResult(*, value: Optional[List[AttachedDatabaseConfiguration]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list attached database configurations operation response.
- Parameters
value (list[AttachedDatabaseConfiguration]) – The list of attached database configurations.
- class
azure.mgmt.kusto.models.AzureCapacity(*, scale_type: Union[str, AzureScaleType], minimum: int, maximum: int, default: int, **kwargs)[source]¶ Bases:
msrest.serialization.ModelAzure 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.AzureResourceSku(*, resource_type: Optional[str] = None, sku: Optional[AzureSku] = None, capacity: Optional[AzureCapacity] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelAzure 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.AzureSku(*, name: Union[str, AzureSkuName], tier: Union[str, AzureSkuTier], capacity: Optional[int] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelAzure 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_E64i_v3”, “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.CheckNameRequest(*, name: str, type: Union[str, Type], **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe result returned from a database check name availability request.
All required parameters must be populated in order to send to Azure.
- class
azure.mgmt.kusto.models.CheckNameResult(*, name_available: Optional[bool] = None, name: Optional[str] = None, message: Optional[str] = None, reason: Union[str, Reason, None] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe 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.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[CloudErrorBody]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelAn error response from Kusto.
- Parameters
code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message (str) – A message describing the error, intended to be suitable for displaying in a user interface.
target (str) – The target of the particular error. For example, the name of the property in error.
details (list[CloudErrorBody]) – A list of additional details about the error.
- class
azure.mgmt.kusto.models.Cluster(*, location: str, sku: azure.mgmt.kusto.models._models_py3.AzureSku, tags: Optional[Dict[str, str]] = None, zones: Optional[List[str]] = None, identity: Optional[Identity] = None, trusted_external_tenants: Optional[List[TrustedExternalTenant]] = None, optimized_autoscale: Optional[OptimizedAutoscale] = None, enable_disk_encryption: Optional[bool] = None, enable_streaming_ingest: Optional[bool] = False, virtual_network_configuration: Optional[VirtualNetworkConfiguration] = None, key_vault_properties: Optional[KeyVaultProperties] = None, enable_purge: Optional[bool] = False, enable_double_encryption: Optional[bool] = False, engine_type: Union[str, EngineType, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.TrackedResourceClass 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.
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
location (str) – Required. The geo-location where the resource lives.
sku (AzureSku) – Required. 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.
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.
enable_double_encryption (bool) – A boolean value that indicates if double encryption is enabled.
engine_type (str or EngineType) – The engine type. Possible values include: “V2”, “V3”.
- class
azure.mgmt.kusto.models.ClusterCheckNameRequest(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe 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, Default value: “
type= '¶
- class
azure.mgmt.kusto.models.ClusterListResult(*, value: Optional[List[Cluster]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto clusters operation response.
- class
azure.mgmt.kusto.models.ClusterPrincipalAssignment(*, principal_id: Optional[str] = None, role: Union[str, ClusterPrincipalRole, None] = None, tenant_id: Optional[str] = None, principal_type: Union[str, PrincipalType, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass representing a cluster principal assignment.
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.
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) – The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
role (str or ClusterPrincipalRole) – Cluster principal role. Possible values include: “AllDatabasesAdmin”, “AllDatabasesViewer”.
tenant_id (str) – The tenant id of the principal.
principal_type (str or PrincipalType) – Principal type. Possible values include: “App”, “Group”, “User”.
- class
azure.mgmt.kusto.models.ClusterPrincipalAssignmentCheckNameRequest(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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, Default value: “
type= '¶
- class
azure.mgmt.kusto.models.ClusterPrincipalAssignmentListResult(*, value: Optional[List[ClusterPrincipalAssignment]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto cluster principal assignments operation response.
- Parameters
value (list[ClusterPrincipalAssignment]) – The list of Kusto cluster principal assignments.
- class
azure.mgmt.kusto.models.ClusterUpdate(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, sku: Optional[AzureSku] = None, identity: Optional[Identity] = None, trusted_external_tenants: Optional[List[TrustedExternalTenant]] = None, optimized_autoscale: Optional[OptimizedAutoscale] = None, enable_disk_encryption: Optional[bool] = None, enable_streaming_ingest: Optional[bool] = False, virtual_network_configuration: Optional[VirtualNetworkConfiguration] = None, key_vault_properties: Optional[KeyVaultProperties] = None, enable_purge: Optional[bool] = False, enable_double_encryption: Optional[bool] = False, engine_type: Union[str, EngineType, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass 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.
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
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.
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.
enable_double_encryption (bool) – A boolean value that indicates if double encryption is enabled.
engine_type (str or EngineType) – The engine type. Possible values include: “V2”, “V3”.
- class
azure.mgmt.kusto.models.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties(**kwargs)[source]¶ Bases:
msrest.serialization.ModelComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.
Variables are only populated by the server, and will be ignored when sending a request.
- class
azure.mgmt.kusto.models.DataConnection(*, location: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass representing an data connection.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventGridDataConnection, EventHubDataConnection, IotHubDataConnection.
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
location (str) – Resource location.
kind (str or DataConnectionKind) – Required. Kind of the endpoint for the data connection.Constant filled by server. Possible values include: “EventHub”, “EventGrid”, “IotHub”.
- class
azure.mgmt.kusto.models.DataConnectionCheckNameRequest(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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, Default value: “
type= '¶
- class
azure.mgmt.kusto.models.DataConnectionListResult(*, value: Optional[List[DataConnection]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto data connections operation response.
- Parameters
value (list[DataConnection]) – The list of Kusto data connections.
- class
azure.mgmt.kusto.models.DataConnectionValidation(*, data_connection_name: Optional[str] = None, properties: Optional[DataConnection] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelClass 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: Optional[List[DataConnectionValidationResult]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe 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: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe 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: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass representing a Kusto database.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ReadOnlyFollowingDatabase, ReadWriteDatabase.
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
- class
azure.mgmt.kusto.models.DatabaseListResult(*, value: Optional[List[Database]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto databases operation response.
- class
azure.mgmt.kusto.models.DatabasePrincipal(*, role: Union[str, DatabasePrincipalRole], name: str, type: Union[str, DatabasePrincipalType], fqn: Optional[str] = None, email: Optional[str] = None, app_id: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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: Optional[str] = None, role: Union[str, DatabasePrincipalRole, None] = None, tenant_id: Optional[str] = None, principal_type: Union[str, PrincipalType, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceClass representing a database principal assignment.
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.
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) – The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
role (str or DatabasePrincipalRole) – 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) – Principal type. Possible values include: “App”, “Group”, “User”.
- class
azure.mgmt.kusto.models.DatabasePrincipalAssignmentCheckNameRequest(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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, Default value: “
type= '¶
- class
azure.mgmt.kusto.models.DatabasePrincipalAssignmentListResult(*, value: Optional[List[DatabasePrincipalAssignment]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto database principal assignments operation response.
- Parameters
value (list[DatabasePrincipalAssignment]) – The list of Kusto database principal assignments.
- class
azure.mgmt.kusto.models.DatabasePrincipalListRequest(*, value: Optional[List[DatabasePrincipal]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto database principals operation request.
- Parameters
value (list[DatabasePrincipal]) – The list of Kusto database principals.
- class
azure.mgmt.kusto.models.DatabasePrincipalListResult(*, value: Optional[List[DatabasePrincipal]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto database principals operation response.
- Parameters
value (list[DatabasePrincipal]) – The list of Kusto database principals.
- class
azure.mgmt.kusto.models.DatabaseStatistics(*, size: Optional[float] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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.DiagnoseVirtualNetworkResult(*, findings: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDiagnoseVirtualNetworkResult.
- class
azure.mgmt.kusto.models.EventGridDataConnection(*, location: Optional[str] = None, storage_account_resource_id: Optional[str] = None, event_hub_resource_id: Optional[str] = None, consumer_group: Optional[str] = None, table_name: Optional[str] = None, mapping_rule_name: Optional[str] = None, data_format: Union[str, EventGridDataFormat, None] = None, ignore_first_record: Optional[bool] = None, blob_storage_event_type: Union[str, BlobStorageEventType, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.DataConnectionClass 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.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: “Running”, “Creating”, “Deleting”, “Succeeded”, “Failed”, “Moving”.
- Parameters
location (str) – Resource location.
kind (str or DataConnectionKind) – Required. Kind of the endpoint for the data connection.Constant filled by server. Possible values include: “EventHub”, “EventGrid”, “IotHub”.
storage_account_resource_id (str) – The resource ID of the storage account where the data resides.
event_hub_resource_id (str) – The resource ID where the event grid is configured to send events.
consumer_group (str) – 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.EventHubDataConnection(*, location: Optional[str] = None, event_hub_resource_id: Optional[str] = None, consumer_group: Optional[str] = None, table_name: Optional[str] = None, mapping_rule_name: Optional[str] = None, data_format: Union[str, EventHubDataFormat, None] = None, event_system_properties: Optional[List[str]] = None, compression: Union[str, Compression, None] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.DataConnectionClass 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.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: “Running”, “Creating”, “Deleting”, “Succeeded”, “Failed”, “Moving”.
- Parameters
location (str) – Resource location.
kind (str or DataConnectionKind) – Required. Kind of the endpoint for the data connection.Constant filled by server. Possible values include: “EventHub”, “EventGrid”, “IotHub”.
event_hub_resource_id (str) – The resource ID of the event hub to be used to create a data connection.
consumer_group (str) – 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.FollowerDatabaseDefinition(*, cluster_resource_id: str, attached_database_configuration_name: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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
- Variables
database_name (str) – The database name owned by this cluster that was followed. * in case following all databases.
- class
azure.mgmt.kusto.models.FollowerDatabaseListResult(*, value: Optional[List[FollowerDatabaseDefinition]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list Kusto database principals operation response.
- Parameters
value (list[FollowerDatabaseDefinition]) – The list of follower database result.
- class
azure.mgmt.kusto.models.Identity(*, type: Union[str, IdentityType], user_assigned_identities: Optional[Dict[str, ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelIdentity 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
- Parameters
type (str or IdentityType) – Required. The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove all identities. Possible values include: “None”, “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str,ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties]) – 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/
- class
azure.mgmt.kusto.models.IotHubDataConnection(*, location: Optional[str] = None, iot_hub_resource_id: Optional[str] = None, consumer_group: Optional[str] = None, table_name: Optional[str] = None, mapping_rule_name: Optional[str] = None, data_format: Union[str, IotHubDataFormat, None] = None, event_system_properties: Optional[List[str]] = None, shared_access_policy_name: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.DataConnectionClass 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.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: “Running”, “Creating”, “Deleting”, “Succeeded”, “Failed”, “Moving”.
- Parameters
location (str) – Resource location.
kind (str or DataConnectionKind) – Required. Kind of the endpoint for the data connection.Constant filled by server. Possible values include: “EventHub”, “EventGrid”, “IotHub”.
iot_hub_resource_id (str) – The resource ID of the Iot hub to be used to create a data connection.
consumer_group (str) – 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) – The name of the share access policy.
- class
azure.mgmt.kusto.models.KeyVaultProperties(*, key_name: str, key_vault_uri: str, key_version: Optional[str] = None, user_identity: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelProperties of the key vault.
All required parameters must be populated in order to send to Azure.
- class
azure.mgmt.kusto.models.LanguageExtension(*, language_extension_name: Union[str, LanguageExtensionName, None] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe language extension object.
- Parameters
language_extension_name (str or LanguageExtensionName) – The language extension name. Possible values include: “PYTHON”, “R”.
- class
azure.mgmt.kusto.models.LanguageExtensionsList(*, value: Optional[List[LanguageExtension]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list of language extension objects.
- Parameters
value (list[LanguageExtension]) – The list of language extensions.
- class
azure.mgmt.kusto.models.ListResourceSkusResult(*, value: Optional[List[AzureResourceSku]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelList of available SKUs for a Kusto Cluster.
- Parameters
value (list[AzureResourceSku]) – The collection of available SKUs for an existing resource.
- class
azure.mgmt.kusto.models.Operation(*, name: Optional[str] = None, display: Optional[OperationDisplay] = None, origin: Optional[str] = None, properties: object = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA REST API operation.
- Parameters
name (str) – 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) – Any object.
- class
azure.mgmt.kusto.models.OperationDisplay(*, provider: Optional[str] = None, operation: Optional[str] = None, resource: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe object that describes the operation.
- class
azure.mgmt.kusto.models.OperationListResult(*, value: Optional[List[Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelResult of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
- class
azure.mgmt.kusto.models.OptimizedAutoscale(*, version: int, is_enabled: bool, minimum: int, maximum: int, **kwargs)[source]¶ Bases:
msrest.serialization.ModelA 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.ProxyResource(**kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceThe resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.
Variables are only populated by the server, and will be ignored when sending a request.
- class
azure.mgmt.kusto.models.ReadOnlyFollowingDatabase(*, location: Optional[str] = None, hot_cache_period: Optional[datetime.timedelta] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.DatabaseClass 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.
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.
statistics (DatabaseStatistics) – The statistics of the database.
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 orPrincipalsModificationKind) – The principals modification kind of the database. Possible values include: “Union”, “Replace”, “None”.
- Parameters
- class
azure.mgmt.kusto.models.ReadWriteDatabase(*, location: Optional[str] = None, soft_delete_period: Optional[datetime.timedelta] = None, hot_cache_period: Optional[datetime.timedelta] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.DatabaseClass 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.
provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: “Running”, “Creating”, “Deleting”, “Succeeded”, “Failed”, “Moving”.
statistics (DatabaseStatistics) – The statistics of the database.
is_followed (bool) – Indicates whether the database is followed.
- Parameters
location (str) – Resource location.
kind (str or Kind) – Required. Kind of the database.Constant filled by server. Possible values include: “ReadWrite”, “ReadOnlyFollowing”.
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.
- class
azure.mgmt.kusto.models.Resource(**kwargs)[source]¶ Bases:
msrest.serialization.ModelCommon fields that are returned in the response for all Azure Resource Manager resources.
Variables are only populated by the server, and will be ignored when sending a request.
- class
azure.mgmt.kusto.models.SkuDescription(**kwargs)[source]¶ Bases:
msrest.serialization.ModelThe 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.SkuDescriptionList(**kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list of the EngagementFabric SKU descriptions.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[SkuDescription]) – SKU descriptions.
- class
azure.mgmt.kusto.models.SkuLocationInfoItem(*, location: str, zones: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe locations and zones info for SKU.
All required parameters must be populated in order to send to Azure.
- class
azure.mgmt.kusto.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.kusto.models._models_py3.ResourceThe resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.
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
- class
azure.mgmt.kusto.models.TrustedExternalTenant(*, value: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelRepresents a tenant ID that is trusted by the cluster.
- Parameters
value (str) – GUID representing an external tenant.
- 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.ModelA class that contains virtual network definition.
All required parameters must be populated in order to send to Azure.
- class
azure.mgmt.kusto.models.AzureScaleType[source]¶ Scale type.
AUTOMATIC= 'automatic'¶
MANUAL= 'manual'¶
NONE= 'none'¶
- class
azure.mgmt.kusto.models.AzureSkuName[source]¶ SKU name.
DEV_NO_SLA_STANDARD_D11_V2= 'Dev(No SLA)_Standard_D11_v2'¶
DEV_NO_SLA_STANDARD_E2_A_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_V2_1_TB_PS= 'Standard_DS13_v2+1TB_PS'¶
STANDARD_DS13_V2_2_TB_PS= 'Standard_DS13_v2+2TB_PS'¶
STANDARD_DS14_V2_3_TB_PS= 'Standard_DS14_v2+3TB_PS'¶
STANDARD_DS14_V2_4_TB_PS= 'Standard_DS14_v2+4TB_PS'¶
STANDARD_E16_AS_V4_3_TB_PS= 'Standard_E16as_v4+3TB_PS'¶
STANDARD_E16_AS_V4_4_TB_PS= 'Standard_E16as_v4+4TB_PS'¶
STANDARD_E16_A_V4= 'Standard_E16a_v4'¶
STANDARD_E2_A_V4= 'Standard_E2a_v4'¶
STANDARD_E4_A_V4= 'Standard_E4a_v4'¶
STANDARD_E64_I_V3= 'Standard_E64i_v3'¶
STANDARD_E8_AS_V4_1_TB_PS= 'Standard_E8as_v4+1TB_PS'¶
STANDARD_E8_AS_V4_2_TB_PS= 'Standard_E8as_v4+2TB_PS'¶
STANDARD_E8_A_V4= 'Standard_E8a_v4'¶
STANDARD_L16_S= 'Standard_L16s'¶
STANDARD_L4_S= 'Standard_L4s'¶
STANDARD_L8_S= 'Standard_L8s'¶
- class
azure.mgmt.kusto.models.BlobStorageEventType[source]¶ The name of blob storage event type to process.
MICROSOFT_STORAGE_BLOB_CREATED= 'Microsoft.Storage.BlobCreated'¶
MICROSOFT_STORAGE_BLOB_RENAMED= 'Microsoft.Storage.BlobRenamed'¶
- class
azure.mgmt.kusto.models.ClusterPrincipalRole[source]¶ Cluster principal role.
ALL_DATABASES_ADMIN= 'AllDatabasesAdmin'¶
ALL_DATABASES_VIEWER= 'AllDatabasesViewer'¶
- class
azure.mgmt.kusto.models.DataConnectionKind[source]¶ Kind of the endpoint for the data connection
EVENT_GRID= 'EventGrid'¶
EVENT_HUB= 'EventHub'¶
IOT_HUB= 'IotHub'¶
- class
azure.mgmt.kusto.models.DatabasePrincipalRole[source]¶ Database principal role.
ADMIN= 'Admin'¶
INGESTOR= 'Ingestor'¶
MONITOR= 'Monitor'¶
UNRESTRICTED_VIEWERS= 'UnrestrictedViewers'¶
USER= 'User'¶
VIEWER= 'Viewer'¶
- class
azure.mgmt.kusto.models.DatabasePrincipalType[source]¶ Database principal type.
APP= 'App'¶
GROUP= 'Group'¶
USER= 'User'¶
- class
azure.mgmt.kusto.models.DefaultPrincipalsModificationKind[source]¶ The default principals modification kind
NONE= 'None'¶
REPLACE= 'Replace'¶
UNION= 'Union'¶
- class
azure.mgmt.kusto.models.EventGridDataFormat[source]¶ The data format of the message. Optionally the data format can be added to each message.
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.EventHubDataFormat[source]¶ The data format of the message. Optionally the data format can be added to each message.
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.IdentityType[source]¶ The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove all identities.
NONE= 'None'¶
SYSTEM_ASSIGNED= 'SystemAssigned'¶
SYSTEM_ASSIGNED_USER_ASSIGNED= 'SystemAssigned, UserAssigned'¶
USER_ASSIGNED= 'UserAssigned'¶
- class
azure.mgmt.kusto.models.IotHubDataFormat[source]¶ The data format of the message. Optionally the data format can be added to each message.
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.Kind[source]¶ Kind of the database
READ_ONLY_FOLLOWING= 'ReadOnlyFollowing'¶
READ_WRITE= 'ReadWrite'¶
- class
azure.mgmt.kusto.models.LanguageExtensionName[source]¶ Language extension that can run within KQL query.
PYTHON= 'PYTHON'¶
R= 'R'¶
- class
azure.mgmt.kusto.models.PrincipalType[source]¶ Principal type.
APP= 'App'¶
GROUP= 'Group'¶
USER= 'User'¶
- class
azure.mgmt.kusto.models.PrincipalsModificationKind[source]¶ The principals modification kind of the database
NONE= 'None'¶
REPLACE= 'Replace'¶
UNION= 'Union'¶
- class
azure.mgmt.kusto.models.ProvisioningState[source]¶ The provisioned state of the resource.
CREATING= 'Creating'¶
DELETING= 'Deleting'¶
FAILED= 'Failed'¶
MOVING= 'Moving'¶
RUNNING= 'Running'¶
SUCCEEDED= 'Succeeded'¶
- class
azure.mgmt.kusto.models.Reason[source]¶ Message providing the reason why the given name is invalid.
ALREADY_EXISTS= 'AlreadyExists'¶
INVALID= 'Invalid'¶