models Package

Classes

AcceptedAudiences

Represents an accepted audience trusted by the cluster.

AttachedDatabaseConfiguration

Class representing an attached database configuration.

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

AttachedDatabaseConfigurationListResult

The list attached database configurations operation response.

AttachedDatabaseConfigurationsCheckNameRequest

The result returned from a AttachedDatabaseConfigurations 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.

AzureCapacity

Azure capacity definition.

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

AzureResourceSku

Azure resource SKU definition.

AzureSku

Azure SKU definition.

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

CheckNameRequest

The result returned from a database check name availability request.

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

CheckNameResult

The result returned from a check name availability request.

CloudErrorBody

An error response from Kusto.

Cluster

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.

ClusterCheckNameRequest

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.

ClusterListResult

The list Kusto clusters operation response.

ClusterPrincipalAssignment

Class representing a cluster principal assignment.

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

ClusterPrincipalAssignmentCheckNameRequest

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.

ClusterPrincipalAssignmentListResult

The list Kusto cluster principal assignments operation response.

ClusterUpdate

Class representing an update to a Kusto cluster.

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

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.

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

DataConnection

Class 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.

DataConnectionCheckNameRequest

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.

DataConnectionListResult

The list Kusto data connections operation response.

DataConnectionValidation

Class representing an data connection validation.

DataConnectionValidationListResult

The list Kusto data connection validation result.

DataConnectionValidationResult

The result returned from a data connection validation request.

Database

Class 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.

DatabaseListResult

The list Kusto databases operation response.

DatabasePrincipal

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.

DatabasePrincipalAssignment

Class representing a database principal assignment.

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

DatabasePrincipalAssignmentCheckNameRequest

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.

DatabasePrincipalAssignmentListResult

The list Kusto database principal assignments operation response.

DatabasePrincipalListRequest

The list Kusto database principals operation request.

DatabasePrincipalListResult

The list Kusto database principals operation response.

DatabaseStatistics

A class that contains database statistics information.

DiagnoseVirtualNetworkResult

DiagnoseVirtualNetworkResult.

EndpointDependency

A domain name that a service is reached at, including details of the current connection status.

EndpointDetail

Current TCP connectivity information from the Kusto cluster to a single endpoint.

EventGridDataConnection

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.

EventHubDataConnection

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.

FollowerDatabaseDefinition

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.

FollowerDatabaseListResult

The list Kusto database principals operation response.

Identity

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.

IotHubDataConnection

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.

KeyVaultProperties

Properties of the key vault.

LanguageExtension

The language extension object.

LanguageExtensionsList

The list of language extension objects.

ListResourceSkusResult

List of available SKUs for a Kusto Cluster.

ManagedPrivateEndpoint

Class representing a managed private endpoint.

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

ManagedPrivateEndpointListResult

The list managed private endpoints operation response.

ManagedPrivateEndpointsCheckNameRequest

The result returned from a managedPrivateEndpoints 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.

Operation

A REST API operation.

OperationDisplay

The object that describes the operation.

OperationListResult

Result 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.

OperationResult

Operation Result Entity.

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

OptimizedAutoscale

A class that contains the optimized auto scale definition.

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

OutboundNetworkDependenciesEndpoint

Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.

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

OutboundNetworkDependenciesEndpointListResult

Collection of Outbound Environment Endpoints.

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.

PrivateEndpointConnection

A private endpoint connection.

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

PrivateEndpointConnectionListResult

A list of private endpoint connections.

PrivateEndpointProperty

Private endpoint which the connection belongs to.

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

PrivateLinkResource

A private link resource.

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

PrivateLinkResourceListResult

A list of private link resources.

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

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

ProxyResource

The 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.

ReadOnlyFollowingDatabase

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.

ReadWriteDatabase

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.

Resource

Common 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.

Script

Class representing a database script.

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

ScriptCheckNameRequest

A script 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.

ScriptListResult

The list Kusto database script operation response.

SkuDescription

The Kusto SKU description of given resource type.

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

SkuDescriptionList

The list of the EngagementFabric SKU descriptions.

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

SkuLocationInfoItem

The locations and zones info for SKU.

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

SystemData

Metadata pertaining to creation and last modification of the resource.

TableLevelSharingProperties

Tables that will be included and excluded in the follower database.

TrackedResource

The 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.

TrustedExternalTenant

Represents a tenant ID that is trusted by the cluster.

VirtualNetworkConfiguration

A class that contains virtual network definition.

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

Enums

AzureScaleType

Scale type.

AzureSkuName

SKU name.

AzureSkuTier

SKU tier.

BlobStorageEventType

The name of blob storage event type to process.

ClusterNetworkAccessFlag

Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

ClusterPrincipalRole

Cluster principal role.

Compression

The compression type

CreatedByType

The type of identity that created the resource.

DataConnectionKind

Kind of the endpoint for the data connection

DatabasePrincipalRole

Database principal role.

DatabasePrincipalType

Database principal type.

DatabaseRouting

Indication for database routing information from the data connection, by default only database routing information is allowed

DefaultPrincipalsModificationKind

The default principals modification kind

EngineType

The engine type

EventGridDataFormat

The data format of the message. Optionally the data format can be added to each message.

EventHubDataFormat

The data format of the message. Optionally the data format can be added to each message.

IdentityType

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.

IotHubDataFormat

The data format of the message. Optionally the data format can be added to each message.

Kind

Kind of the database

LanguageExtensionName

Language extension that can run within KQL query.

PrincipalType

Principal type.

PrincipalsModificationKind

The principals modification kind of the database

ProvisioningState

The provisioned state of the resource.

PublicIPType

Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)

PublicNetworkAccess

Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed

Reason

Message providing the reason why the given name is invalid.

State

The state of the resource.

Status

The status of operation.

Type

The type of resource, for instance Microsoft.Kusto/clusters/databases.