@azure/arm-kusto package

Represents an accepted audience trusted by the cluster.

Class representing an attached database configuration.

The list attached database configurations operation response.

Interface representing a AttachedDatabaseConfigurations.

Optional parameters.

The result returned from a AttachedDatabaseConfigurations check name availability request.

Defines headers for AttachedDatabaseConfigurations_createOrUpdate operation.

Optional parameters.

Defines headers for AttachedDatabaseConfigurations_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Azure capacity definition.

Azure resource SKU definition.

Azure SKU definition.

A list of the service's callout policy objects.

Configuration for external callout policies, including URI patterns, access types, and service types.

Configuration for an external callout policy to remove.

The result returned from a database check name availability request.

The result returned from a check name availability request.

Class representing a Kusto cluster.

The result returned from a cluster check name availability request.

The list Kusto clusters operation response.

A cluster migrate request.

Class representing a cluster principal assignment.

A principal assignment check name availability request.

The list Kusto cluster principal assignments operation response.

Interface representing a ClusterPrincipalAssignments.

Optional parameters.

Optional parameters.

Defines headers for ClusterPrincipalAssignments_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Class representing an update to a Kusto cluster.

Interface representing a Clusters.

Defines headers for Clusters_addCalloutPolicies operation.

Optional parameters.

Defines headers for Clusters_addLanguageExtensions operation.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Clusters_delete operation.

Optional parameters.

Defines headers for Clusters_detachFollowerDatabases operation.

Optional parameters.

Defines headers for Clusters_diagnoseVirtualNetwork operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Clusters_migrate operation.

Optional parameters.

Defines headers for Clusters_removeCalloutPolicy operation.

Optional parameters.

Defines headers for Clusters_removeLanguageExtensions operation.

Optional parameters.

Defines headers for Clusters_start operation.

Optional parameters.

Defines headers for Clusters_stop operation.

Optional parameters.

Defines headers for Clusters_update operation.

Optional parameters.

Class representing a CosmosDb data connection.

Class representing an data connection.

A data connection check name availability request.

The list Kusto data connections operation response.

Class representing an data connection validation.

The list Kusto data connection validation result.

The result returned from a data connection validation request.

Interface representing a DataConnections.

Optional parameters.

Defines headers for DataConnections_createOrUpdate operation.

Optional parameters.

Defines headers for DataConnections_dataConnectionValidation operation.

Optional parameters.

Defines headers for DataConnections_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for DataConnections_update operation.

Optional parameters.

Class representing a Kusto database.

Optional parameters.

The request to invite a follower to a database.

The result returned from a follower invitation generation request.

The list Kusto databases operation response.

Interface representing a DatabaseOperations.

A class representing database principal entity.

Class representing a database principal assignment.

A principal assignment check name availability request.

The list Kusto database principal assignments operation response.

Interface representing a DatabasePrincipalAssignments.

Optional parameters.

Optional parameters.

Defines headers for DatabasePrincipalAssignments_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

The list Kusto database principals operation request.

The list Kusto database principals operation response.

A class that contains database statistics information.

Interface representing a Databases.

Optional parameters.

Optional parameters.

Defines headers for Databases_createOrUpdate operation.

Optional parameters.

Defines headers for Databases_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Databases_update operation.

Optional parameters.

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

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

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Class representing an Event Grid data connection.

Class representing an event hub data connection.

A class representing follower database request.

A class representing follower database object.

The list Kusto database principals operation response.

The list Kusto database principals operation response.

Identity for the resource.

Class representing an iot hub data connection.

Properties of the key vault.

Optional parameters.

The language extension object.

The list of language extension objects.

List of available SKUs for a Kusto Cluster.

Class representing a managed private endpoint.

The list managed private endpoints operation response.

Interface representing a ManagedPrivateEndpoints.

Optional parameters.

The result returned from a managedPrivateEndpoints check name availability request.

Defines headers for ManagedPrivateEndpoints_createOrUpdate operation.

Optional parameters.

Defines headers for ManagedPrivateEndpoints_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for ManagedPrivateEndpoints_update operation.

Optional parameters.

Represents a properties of a cluster that is part of a migration.

A REST API operation

The object that describes the operation.

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.

Operation Result Entity.

Interface representing a Operations.

Optional parameters.

Optional parameters.

Interface representing a OperationsResults.

Optional parameters.

Interface representing a OperationsResultsLocation.

Defines headers for OperationsResultsLocation_get operation.

Optional parameters.

A class that contains the optimized auto scale definition.

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

Collection of Outbound Environment Endpoints

A private endpoint connection

A list of private endpoint connections

Interface representing a PrivateEndpointConnections.

Optional parameters.

Defines headers for PrivateEndpointConnections_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Private endpoint which the connection belongs to.

A private link resource

A list of private link resources

Interface representing a PrivateLinkResources.

Optional parameters.

Optional parameters.

Connection State of the Private Endpoint Connection.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Class representing a read only following database.

Class representing a read write database.

Common fields that are returned in the response for all Azure Resource Manager resources

Describes The SKU capabilities object.

Describes The zonal capabilities of a SKU.

Class representing a Kusto sandbox custom image.

Interface representing a SandboxCustomImages.

Optional parameters.

The result returned from a sandboxCustomImage check name availability request.

Optional parameters.

Defines headers for SandboxCustomImages_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

The list Kusto sandbox custom images operation response.

Defines headers for SandboxCustomImages_update operation.

Optional parameters.

Class representing a database script.

A script name availability request.

The list Kusto database script operation response.

Interface representing a Scripts.

Optional parameters.

Defines headers for Scripts_createOrUpdate operation.

Optional parameters.

Defines headers for Scripts_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Scripts_update operation.

Optional parameters.

The Kusto SKU description of given resource type

The list of the EngagementFabric SKU descriptions

The locations and zones info for SKU.

Interface representing a Skus.

Optional parameters.

The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.

Metadata pertaining to creation and last modification of the resource.

Tables that will be included and excluded in the follower database

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Represents a tenant ID that is trusted by the cluster.

A class that contains virtual network definition.

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByCluster operation.

Defines values for AzureScaleType.
KnownAzureScaleType can be used interchangeably with AzureScaleType, this enum contains the known values that the service supports.

Known values supported by the service

automatic
manual
none

Defines values for AzureSkuName.
KnownAzureSkuName can be used interchangeably with AzureSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Dev(No SLA)_Standard_D11_v2
Dev(No SLA)_Standard_E2a_v4
Standard_D11_v2
Standard_D12_v2
Standard_D13_v2
Standard_D14_v2
Standard_D32d_v4
Standard_D16d_v5
Standard_D32d_v5
Standard_DS13_v2+1TB_PS
Standard_DS13_v2+2TB_PS
Standard_DS14_v2+3TB_PS
Standard_DS14_v2+4TB_PS
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L8s_v2
Standard_L16s_v2
Standard_L8s_v3
Standard_L16s_v3
Standard_L32s_v3
Standard_L8as_v3
Standard_L16as_v3
Standard_L32as_v3
Standard_E64i_v3
Standard_E80ids_v4
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
Standard_E8as_v5+1TB_PS
Standard_E8as_v5+2TB_PS
Standard_E16as_v5+3TB_PS
Standard_E16as_v5+4TB_PS
Standard_E2ads_v5
Standard_E4ads_v5
Standard_E8ads_v5
Standard_E16ads_v5
Standard_EC8as_v5+1TB_PS
Standard_EC8as_v5+2TB_PS
Standard_EC16as_v5+3TB_PS
Standard_EC16as_v5+4TB_PS
Standard_EC8ads_v5
Standard_EC16ads_v5
Standard_E8s_v4+1TB_PS
Standard_E8s_v4+2TB_PS
Standard_E16s_v4+3TB_PS
Standard_E16s_v4+4TB_PS
Standard_E8s_v5+1TB_PS
Standard_E8s_v5+2TB_PS
Standard_E16s_v5+3TB_PS
Standard_E16s_v5+4TB_PS
Standard_E2d_v4
Standard_E4d_v4
Standard_E8d_v4
Standard_E16d_v4
Standard_E2d_v5
Standard_E4d_v5
Standard_E8d_v5
Standard_E16d_v5

Defines values for AzureSkuTier.
KnownAzureSkuTier can be used interchangeably with AzureSkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Standard

Defines values for BlobStorageEventType.
KnownBlobStorageEventType can be used interchangeably with BlobStorageEventType, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Storage.BlobCreated
Microsoft.Storage.BlobRenamed

Defines values for CallerRole.
KnownCallerRole can be used interchangeably with CallerRole, this enum contains the known values that the service supports.

Known values supported by the service

Admin
None

Defines values for CalloutType.
KnownCalloutType can be used interchangeably with CalloutType, this enum contains the known values that the service supports.

Known values supported by the service

kusto
sql
cosmosdb
external_data
azure_digital_twins
sandbox_artifacts
webapi
mysql
postgresql
genevametrics
azure_openai

Defines values for ClusterNetworkAccessFlag.
KnownClusterNetworkAccessFlag can be used interchangeably with ClusterNetworkAccessFlag, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for ClusterPrincipalRole.
KnownClusterPrincipalRole can be used interchangeably with ClusterPrincipalRole, this enum contains the known values that the service supports.

Known values supported by the service

AllDatabasesAdmin
AllDatabasesViewer
AllDatabasesMonitor

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the diagnoseVirtualNetwork operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listCalloutPolicies operation.

Contains response data for the listFollowerDatabasesGet operation.

Contains response data for the listFollowerDatabases operation.

Contains response data for the listLanguageExtensions operation.

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

Contains response data for the list operation.

Contains response data for the listSkusByResource operation.

Contains response data for the listSkus operation.

Contains response data for the update operation.

Defines values for Compression.
KnownCompression can be used interchangeably with Compression, this enum contains the known values that the service supports.

Known values supported by the service

None
GZip

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for DataConnectionKind.
KnownDataConnectionKind can be used interchangeably with DataConnectionKind, this enum contains the known values that the service supports.

Known values supported by the service

EventHub
EventGrid
IotHub
CosmosDb

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the dataConnectionValidation operation.

Contains response data for the get operation.

Contains response data for the listByDatabase operation.

Contains response data for the update operation.

Contains response data for the inviteFollower operation.

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for DatabasePrincipalRole.
KnownDatabasePrincipalRole can be used interchangeably with DatabasePrincipalRole, this enum contains the known values that the service supports.

Known values supported by the service

Admin
Ingestor
Monitor
User
UnrestrictedViewer
Viewer

Defines values for DatabasePrincipalType.
KnownDatabasePrincipalType can be used interchangeably with DatabasePrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

App
Group
User

Defines values for DatabaseRouting.
KnownDatabaseRouting can be used interchangeably with DatabaseRouting, this enum contains the known values that the service supports.

Known values supported by the service

Single
Multi

Defines values for DatabaseShareOrigin.
KnownDatabaseShareOrigin can be used interchangeably with DatabaseShareOrigin, this enum contains the known values that the service supports.

Known values supported by the service

Direct
DataShare
Other

Contains response data for the addPrincipals operation.

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByClusterNext operation.

Contains response data for the listByCluster operation.

Contains response data for the listPrincipals operation.

Contains response data for the removePrincipals operation.

Contains response data for the update operation.

Defines values for DefaultPrincipalsModificationKind.
KnownDefaultPrincipalsModificationKind can be used interchangeably with DefaultPrincipalsModificationKind, this enum contains the known values that the service supports.

Known values supported by the service

Union
Replace
None

Defines values for EngineType.
KnownEngineType can be used interchangeably with EngineType, this enum contains the known values that the service supports.

Known values supported by the service

V2
V3

Defines values for EventGridDataFormat.
KnownEventGridDataFormat can be used interchangeably with EventGridDataFormat, this enum contains the known values that the service supports.

Known values supported by the service

MULTIJSON
JSON
CSV
TSV
SCSV
SOHSV
PSV
TXT
RAW
SINGLEJSON
AVRO
TSVE
PARQUET
ORC
APACHEAVRO
W3CLOGFILE

Defines values for EventHubDataFormat.
KnownEventHubDataFormat can be used interchangeably with EventHubDataFormat, this enum contains the known values that the service supports.

Known values supported by the service

MULTIJSON
JSON
CSV
TSV
SCSV
SOHSV
PSV
TXT
RAW
SINGLEJSON
AVRO
TSVE
PARQUET
ORC
APACHEAVRO
W3CLOGFILE

Defines values for IdentityType.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

Defines values for IotHubDataFormat.
KnownIotHubDataFormat can be used interchangeably with IotHubDataFormat, this enum contains the known values that the service supports.

Known values supported by the service

MULTIJSON
JSON
CSV
TSV
SCSV
SOHSV
PSV
TXT
RAW
SINGLEJSON
AVRO
TSVE
PARQUET
ORC
APACHEAVRO
W3CLOGFILE

Defines values for Kind.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

ReadWrite
ReadOnlyFollowing

Defines values for Language.
KnownLanguage can be used interchangeably with Language, this enum contains the known values that the service supports.

Known values supported by the service

Python

Defines values for LanguageExtensionImageName.
KnownLanguageExtensionImageName can be used interchangeably with LanguageExtensionImageName, this enum contains the known values that the service supports.

Known values supported by the service

R
Python3_6_5
Python3_10_8
Python3_10_8_DL
PythonCustomImage
Python3_11_7
Python3_11_7_DL

Defines values for LanguageExtensionName.
KnownLanguageExtensionName can be used interchangeably with LanguageExtensionName, this enum contains the known values that the service supports.

Known values supported by the service

PYTHON
R

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for MigrationClusterRole.
KnownMigrationClusterRole can be used interchangeably with MigrationClusterRole, this enum contains the known values that the service supports.

Known values supported by the service

Source
Destination

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the get operation.

Contains response data for the get operation.

Defines values for OutboundAccess.
KnownOutboundAccess can be used interchangeably with OutboundAccess, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

Defines values for PrincipalPermissionsAction.
KnownPrincipalPermissionsAction can be used interchangeably with PrincipalPermissionsAction, this enum contains the known values that the service supports.

Known values supported by the service

RetainPermissionOnScriptCompletion
RemovePermissionOnScriptCompletion

Defines values for PrincipalType.
KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

App
Group
User

Defines values for PrincipalsModificationKind.
KnownPrincipalsModificationKind can be used interchangeably with PrincipalsModificationKind, this enum contains the known values that the service supports.

Known values supported by the service

Union
Replace
None

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the list operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Creating
Deleting
Succeeded
Failed
Moving
Canceled

Defines values for PublicIPType.
KnownPublicIPType can be used interchangeably with PublicIPType, this enum contains the known values that the service supports.

Known values supported by the service

IPv4
DualStack

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Defines values for Reason.
KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByCluster operation.

Contains response data for the update operation.

Defines values for ScriptLevel.
KnownScriptLevel can be used interchangeably with ScriptLevel, this enum contains the known values that the service supports.

Known values supported by the service

Database
Cluster

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByDatabase operation.

Contains response data for the update operation.

Contains response data for the list operation.

Defines values for State.
KnownState can be used interchangeably with State, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Unavailable
Running
Deleting
Deleted
Stopping
Stopped
Starting
Updating
Migrated

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Canceled
Failed
Running

Defines values for Type.

Defines values for VnetState.
KnownVnetState can be used interchangeably with VnetState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Defines values for ZoneStatus.
KnownZoneStatus can be used interchangeably with ZoneStatus, this enum contains the known values that the service supports.

Known values supported by the service

NonZonal
ZonalInconsistency
Zonal

Known values of AzureScaleType that the service accepts.

Known values of AzureSkuName that the service accepts.

Known values of AzureSkuTier that the service accepts.

Known values of BlobStorageEventType that the service accepts.

Known values of CallerRole that the service accepts.

Known values of CalloutType that the service accepts.

Known values of ClusterNetworkAccessFlag that the service accepts.

Known values of ClusterPrincipalRole that the service accepts.

Known values of Compression that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of DataConnectionKind that the service accepts.

Known values of DatabasePrincipalRole that the service accepts.

Known values of DatabasePrincipalType that the service accepts.

Known values of DatabaseRouting that the service accepts.

Known values of DatabaseShareOrigin that the service accepts.

Known values of DefaultPrincipalsModificationKind that the service accepts.

Known values of EngineType that the service accepts.

Known values of EventGridDataFormat that the service accepts.

Known values of EventHubDataFormat that the service accepts.

Known values of IdentityType that the service accepts.

Known values of IotHubDataFormat that the service accepts.

Known values of Kind that the service accepts.

Known values of Language that the service accepts.

Known values of LanguageExtensionImageName that the service accepts.

Known values of LanguageExtensionName that the service accepts.

Known values of MigrationClusterRole that the service accepts.

Known values of OutboundAccess that the service accepts.

Known values of PrincipalPermissionsAction that the service accepts.

Known values of PrincipalType that the service accepts.

Known values of PrincipalsModificationKind that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of PublicIPType that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of Reason that the service accepts.

Known values of ScriptLevel that the service accepts.

Known values of State that the service accepts.

Known values of Status that the service accepts.

Known values of VnetState that the service accepts.

Known values of ZoneStatus that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.