@azure/arm-kusto package

Classes

KustoManagementClient

Interfaces

AcceptedAudiences	Represents an accepted audience trusted by the cluster.
AttachedDatabaseConfiguration	Class representing an attached database configuration.
AttachedDatabaseConfigurationProperties	Class representing the an attached database configuration properties of kind specific.
AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsCheckNameRequest	The result returned from a AttachedDatabaseConfigurations check name availability request.
AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsDeleteOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsGetOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsListByClusterOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsOperations	Interface representing a AttachedDatabaseConfigurations operations.
AzureCapacity	Azure capacity definition.
AzureResourceSku	Azure resource SKU definition.
AzureSku	Azure SKU definition.
CalloutPolicy	Configuration for external callout policies, including URI patterns, access types, and service types.
CalloutPolicyToRemove	Configuration for an external callout policy to remove.
CheckNameRequest	The result returned from a database check name availability request.
CheckNameResult	The result returned from a check name availability request.
Cluster	Class representing a Kusto cluster.
ClusterCheckNameRequest	The result returned from a cluster check name availability request.
ClusterMigrateRequest	A cluster migrate request.
ClusterPrincipalAssignment	Class representing a cluster principal assignment.
ClusterPrincipalAssignmentCheckNameRequest	A principal assignment check name availability request.
ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsDeleteOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsGetOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsListOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsOperations	Interface representing a ClusterPrincipalAssignments operations.
ClusterPrincipalProperties	A class representing cluster principal property.
ClusterProperties	Class representing the Kusto cluster properties.
ClusterUpdate	Class representing an update to a Kusto cluster.
ClustersAddCalloutPoliciesOptionalParams	Optional parameters.
ClustersAddLanguageExtensionsOptionalParams	Optional parameters.
ClustersCheckNameAvailabilityOptionalParams	Optional parameters.
ClustersCreateOrUpdateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersDetachFollowerDatabasesOptionalParams	Optional parameters.
ClustersDiagnoseVirtualNetworkOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListCalloutPoliciesOptionalParams	Optional parameters.
ClustersListFollowerDatabasesGetOptionalParams	Optional parameters.
ClustersListFollowerDatabasesOptionalParams	Optional parameters.
ClustersListLanguageExtensionsOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersListOutboundNetworkDependenciesEndpointsOptionalParams	Optional parameters.
ClustersListSkusByResourceOptionalParams	Optional parameters.
ClustersListSkusOptionalParams	Optional parameters.
ClustersMigrateOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersRemoveCalloutPolicyOptionalParams	Optional parameters.
ClustersRemoveLanguageExtensionsOptionalParams	Optional parameters.
ClustersStartOptionalParams	Optional parameters.
ClustersStopOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	Optional parameters.
ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties	model interface ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties
CosmosDbDataConnection	Class representing a CosmosDb data connection.
CosmosDbDataConnectionProperties	Class representing the Kusto CosmosDb data connection properties.
DataConnection	Class representing an data connection.
DataConnectionCheckNameRequest	A data connection check name availability request.
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.
DataConnectionsCheckNameAvailabilityOptionalParams	Optional parameters.
DataConnectionsCreateOrUpdateOptionalParams	Optional parameters.
DataConnectionsDataConnectionValidationOptionalParams	Optional parameters.
DataConnectionsDeleteOptionalParams	Optional parameters.
DataConnectionsGetOptionalParams	Optional parameters.
DataConnectionsListByDatabaseOptionalParams	Optional parameters.
DataConnectionsOperations	Interface representing a DataConnections operations.
DataConnectionsUpdateOptionalParams	Optional parameters.
Database	Class representing a Kusto database.
DatabaseInviteFollowerRequest	The request to invite a follower to a database.
DatabaseInviteFollowerResult	The result returned from a follower invitation generation request.
DatabaseOperationsInviteFollowerOptionalParams	Optional parameters.
DatabaseOperationsOperations	Interface representing a DatabaseOperations operations.
DatabasePrincipal	A class representing database principal entity.
DatabasePrincipalAssignment	Class representing a database principal assignment.
DatabasePrincipalAssignmentCheckNameRequest	A principal assignment check name availability request.
DatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsDeleteOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsGetOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsListOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsOperations	Interface representing a DatabasePrincipalAssignments operations.
DatabasePrincipalListRequest	The list Kusto database principals operation request.
DatabasePrincipalListResult	The list Kusto database principals operation response.
DatabasePrincipalProperties	A class representing database principal property.
DatabaseStatistics	A class that contains database statistics information.
DatabasesAddPrincipalsOptionalParams	Optional parameters.
DatabasesCheckNameAvailabilityOptionalParams	Optional parameters.
DatabasesCreateOrUpdateOptionalParams	Optional parameters.
DatabasesDeleteOptionalParams	Optional parameters.
DatabasesGetOptionalParams	Optional parameters.
DatabasesListByClusterOptionalParams	Optional parameters.
DatabasesListPrincipalsOptionalParams	Optional parameters.
DatabasesOperations	Interface representing a Databases operations.
DatabasesRemovePrincipalsOptionalParams	Optional parameters.
DatabasesUpdateOptionalParams	Optional parameters.
DiagnoseVirtualNetworkResult	model interface 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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EventGridConnectionProperties	Class representing the Kusto event grid connection properties.
EventGridConnectionWithManagedIdentityProperties	Class representing the Kusto event grid connection with mandatory managed identity properties.
EventGridDataConnection	Class representing an Event Grid data connection.
EventGridDataConnectionWithManagedIdentity	Class representing an Event Grid data connection with mandatory managed identity.
EventHubConnectionProperties	Class representing the Kusto event hub connection properties.
EventHubConnectionWithManagedIdentityProperties	Class representing the Kusto event hub connection with required managed identity properties.
EventHubDataConnection	Class representing an event hub data connection.
EventHubDataConnectionWithManagedIdentity	Class representing an event hub data connection with required managed identity.
FollowerDatabaseDefinition	A class representing follower database request.
FollowerDatabaseDefinitionGet	A class representing follower database object.
FollowerDatabaseProperties	A class representing the properties of a follower database object.
Identity	Identity for the resource.
IotHubConnectionProperties	Class representing the Kusto Iot hub connection properties.
IotHubDataConnection	Class representing an iot hub data connection.
KeyVaultProperties	Properties of the key vault.
KustoManagementClientOptionalParams	Optional parameters for the client.
LanguageExtension	The language extension object.
LanguageExtensionsList	The list of language extension objects.
ManagedPrivateEndpoint	Class representing a managed private endpoint.
ManagedPrivateEndpointProperties	A class representing the properties of a managed private endpoint object.
ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams	Optional parameters.
ManagedPrivateEndpointsCheckNameRequest	The result returned from a managedPrivateEndpoints check name availability request.
ManagedPrivateEndpointsCreateOrUpdateOptionalParams	Optional parameters.
ManagedPrivateEndpointsDeleteOptionalParams	Optional parameters.
ManagedPrivateEndpointsGetOptionalParams	Optional parameters.
ManagedPrivateEndpointsListOptionalParams	Optional parameters.
ManagedPrivateEndpointsOperations	Interface representing a ManagedPrivateEndpoints operations.
ManagedPrivateEndpointsUpdateOptionalParams	Optional parameters.
MigrationClusterProperties	Represents a properties of a cluster that is part of a migration.
Operation	A REST API operation
OperationDisplay	The object that describes the operation.
OperationResult	Operation Result Entity.
OperationResultErrorProperties	Operation result error properties
OperationResultProperties	Operation result properties
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OperationsResultsGetOptionalParams	Optional parameters.
OperationsResultsLocationGetOptionalParams	Optional parameters.
OperationsResultsLocationOperations	Interface representing a OperationsResultsLocation operations.
OperationsResultsOperations	Interface representing a OperationsResults operations.
OptimizedAutoscale	A class that contains the optimized auto scale definition.
OutboundNetworkDependenciesEndpoint	Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.
OutboundNetworkDependenciesEndpointProperties	Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionProperties	Properties of a private endpoint connection.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkResource	A private link resource
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReadOnlyFollowingDatabase	Class representing a read only following database.
ReadOnlyFollowingDatabaseProperties	Class representing the Kusto database properties.
ReadWriteDatabase	Class representing a read write database.
ReadWriteDatabaseProperties	Class representing the Kusto database properties.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceSkuCapabilities	Describes The SKU capabilities object.
ResourceSkuZoneDetails	Describes The zonal capabilities of a SKU.
RestorePollerOptions
SandboxCustomImage	Class representing a Kusto sandbox custom image.
SandboxCustomImageProperties	A class representing the properties of a sandbox custom image object.
SandboxCustomImagesCheckNameAvailabilityOptionalParams	Optional parameters.
SandboxCustomImagesCheckNameRequest	The result returned from a sandboxCustomImage check name availability request.
SandboxCustomImagesCreateOrUpdateOptionalParams	Optional parameters.
SandboxCustomImagesDeleteOptionalParams	Optional parameters.
SandboxCustomImagesGetOptionalParams	Optional parameters.
SandboxCustomImagesListByClusterOptionalParams	Optional parameters.
SandboxCustomImagesOperations	Interface representing a SandboxCustomImages operations.
SandboxCustomImagesUpdateOptionalParams	Optional parameters.
Script	Class representing a database script.
ScriptCheckNameRequest	A script name availability request.
ScriptProperties	A class representing database script property.
ScriptsCheckNameAvailabilityOptionalParams	Optional parameters.
ScriptsCreateOrUpdateOptionalParams	Optional parameters.
ScriptsDeleteOptionalParams	Optional parameters.
ScriptsGetOptionalParams	Optional parameters.
ScriptsListByDatabaseOptionalParams	Optional parameters.
ScriptsOperations	Interface representing a Scripts operations.
ScriptsUpdateOptionalParams	Optional parameters.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SkuDescription	The Kusto SKU description of given resource type
SkuLocationInfoItem	The locations and zones info for SKU.
SkusListOptionalParams	Optional parameters.
SkusOperations	Interface representing a Skus operations.
SuspensionDetails	The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
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'
TrustedExternalTenant	Represents a tenant ID that is trusted by the cluster.
VirtualNetworkConfiguration	A class that contains virtual network definition.

Type Aliases

AzureScaleType	Scale type. KnownAzureScaleType can be used interchangeably with AzureScaleType, this enum contains the known values that the service supports. Known values supported by the service automatic: automatic manual: manual none: none
AzureSkuName	SKU name. 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_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_D32d_v4: Standard_D32d_v4 Standard_D16d_v5: Standard_D16d_v5 Standard_D32d_v5: Standard_D32d_v5 Standard_DS13_v2+1TB_PS: Standard_DS13_v2+1TB_PS Standard_DS13_v2+2TB_PS: Standard_DS13_v2+2TB_PS Standard_DS14_v2+3TB_PS: Standard_DS14_v2+3TB_PS Standard_DS14_v2+4TB_PS: Standard_DS14_v2+4TB_PS Standard_L4s: Standard_L4s Standard_L8s: Standard_L8s Standard_L16s: Standard_L16s Standard_L8s_v2: Standard_L8s_v2 Standard_L16s_v2: Standard_L16s_v2 Standard_L8s_v3: Standard_L8s_v3 Standard_L16s_v3: Standard_L16s_v3 Standard_L32s_v3: Standard_L32s_v3 Standard_L8as_v3: Standard_L8as_v3 Standard_L16as_v3: Standard_L16as_v3 Standard_L32as_v3: Standard_L32as_v3 Standard_E64i_v3: Standard_E64i_v3 Standard_E80ids_v4: Standard_E80ids_v4 Standard_E2a_v4: Standard_E2a_v4 Standard_E4a_v4: Standard_E4a_v4 Standard_E8a_v4: Standard_E8a_v4 Standard_E16a_v4: Standard_E16a_v4 Standard_E8as_v4+1TB_PS: Standard_E8as_v4+1TB_PS Standard_E8as_v4+2TB_PS: Standard_E8as_v4+2TB_PS Standard_E16as_v4+3TB_PS: Standard_E16as_v4+3TB_PS Standard_E16as_v4+4TB_PS: Standard_E16as_v4+4TB_PS Standard_E8as_v5+1TB_PS: Standard_E8as_v5+1TB_PS Standard_E8as_v5+2TB_PS: Standard_E8as_v5+2TB_PS Standard_E16as_v5+3TB_PS: Standard_E16as_v5+3TB_PS Standard_E16as_v5+4TB_PS: Standard_E16as_v5+4TB_PS Standard_E2ads_v5: Standard_E2ads_v5 Standard_E4ads_v5: Standard_E4ads_v5 Standard_E8ads_v5: Standard_E8ads_v5 Standard_E16ads_v5: Standard_E16ads_v5 Standard_EC8as_v5+1TB_PS: Standard_EC8as_v5+1TB_PS Standard_EC8as_v5+2TB_PS: Standard_EC8as_v5+2TB_PS Standard_EC16as_v5+3TB_PS: Standard_EC16as_v5+3TB_PS Standard_EC16as_v5+4TB_PS: Standard_EC16as_v5+4TB_PS Standard_EC8ads_v5: Standard_EC8ads_v5 Standard_EC16ads_v5: Standard_EC16ads_v5 Standard_E8s_v4+1TB_PS: Standard_E8s_v4+1TB_PS Standard_E8s_v4+2TB_PS: Standard_E8s_v4+2TB_PS Standard_E16s_v4+3TB_PS: Standard_E16s_v4+3TB_PS Standard_E16s_v4+4TB_PS: Standard_E16s_v4+4TB_PS Standard_E8s_v5+1TB_PS: Standard_E8s_v5+1TB_PS Standard_E8s_v5+2TB_PS: Standard_E8s_v5+2TB_PS Standard_E16s_v5+3TB_PS: Standard_E16s_v5+3TB_PS Standard_E16s_v5+4TB_PS: Standard_E16s_v5+4TB_PS Standard_E2d_v4: Standard_E2d_v4 Standard_E4d_v4: Standard_E4d_v4 Standard_E8d_v4: Standard_E8d_v4 Standard_E16d_v4: Standard_E16d_v4 Standard_E2d_v5: Standard_E2d_v5 Standard_E4d_v5: Standard_E4d_v5 Standard_E8d_v5: Standard_E8d_v5 Standard_E16d_v5: Standard_E16d_v5
AzureSkuTier	SKU tier. KnownAzureSkuTier can be used interchangeably with AzureSkuTier, this enum contains the known values that the service supports. Known values supported by the service Basic: Basic Standard: Standard
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BlobStorageEventType	The name of blob storage event type to process. 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.BlobCreated Microsoft.Storage.BlobRenamed: Microsoft.Storage.BlobRenamed
CallerRole	Type of CallerRole
CalloutType	Type of the callout service, specifying the kind of external resource or service being accessed. KnownCalloutType can be used interchangeably with CalloutType, this enum contains the known values that the service supports. Known values supported by the service kusto: kusto sql: sql cosmosdb: cosmosdb external_data: external_data azure_digital_twins: azure_digital_twins sandbox_artifacts: sandbox_artifacts webapi: webapi mysql: mysql postgresql: postgresql genevametrics: genevametrics azure_openai: azure_openai
ClusterNetworkAccessFlag	Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' KnownClusterNetworkAccessFlag can be used interchangeably with ClusterNetworkAccessFlag, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
ClusterPrincipalRole	Cluster principal role. KnownClusterPrincipalRole can be used interchangeably with ClusterPrincipalRole, this enum contains the known values that the service supports. Known values supported by the service AllDatabasesAdmin: AllDatabasesAdmin AllDatabasesViewer: AllDatabasesViewer AllDatabasesMonitor: AllDatabasesMonitor
Compression	The compression type KnownCompression can be used interchangeably with Compression, this enum contains the known values that the service supports. Known values supported by the service None: None GZip: GZip
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DataConnectionKind	Kind of the endpoint for the data connection KnownDataConnectionKind can be used interchangeably with DataConnectionKind, this enum contains the known values that the service supports. Known values supported by the service EventHub: EventHub EventGrid: EventGrid IotHub: IotHub CosmosDb: CosmosDb EventHubWithManagedIdentity: EventHubWithManagedIdentity EventGridWithManagedIdentity: EventGridWithManagedIdentity
DataConnectionUnion	Alias for DataConnectionUnion
DatabasePrincipalRole	Database principal role. KnownDatabasePrincipalRole can be used interchangeably with DatabasePrincipalRole, this enum contains the known values that the service supports. Known values supported by the service Admin: Admin Ingestor: Ingestor Monitor: Monitor User: User UnrestrictedViewer: UnrestrictedViewer Viewer: Viewer
DatabasePrincipalType	Database principal type. KnownDatabasePrincipalType can be used interchangeably with DatabasePrincipalType, this enum contains the known values that the service supports. Known values supported by the service App: App Group: Group User: User
DatabaseRouting	Indication for database routing information from the data connection, by default only database routing information is allowed KnownDatabaseRouting can be used interchangeably with DatabaseRouting, this enum contains the known values that the service supports. Known values supported by the service Single: Single Multi: Multi
DatabaseShareOrigin	The origin of the following setup. KnownDatabaseShareOrigin can be used interchangeably with DatabaseShareOrigin, this enum contains the known values that the service supports. Known values supported by the service Direct: Direct DataShare: DataShare Other: Other
DatabaseUnion	Alias for DatabaseUnion
DefaultPrincipalsModificationKind	The default principals modification kind KnownDefaultPrincipalsModificationKind can be used interchangeably with DefaultPrincipalsModificationKind, this enum contains the known values that the service supports. Known values supported by the service Union: Union Replace: Replace None: None
EngineType	The engine type KnownEngineType can be used interchangeably with EngineType, this enum contains the known values that the service supports. Known values supported by the service V2: V2 V3: V3
EventGridDataFormat	The data format of the message. Optionally the data format can be added to each message. KnownEventGridDataFormat can be used interchangeably with EventGridDataFormat, this enum contains the known values that the service supports. Known values supported by the service MULTIJSON: MULTIJSON JSON: JSON CSV: CSV TSV: TSV SCSV: SCSV SOHSV: SOHSV PSV: PSV TXT: TXT RAW: RAW SINGLEJSON: SINGLEJSON AVRO: AVRO TSVE: TSVE PARQUET: PARQUET ORC: ORC APACHEAVRO: APACHEAVRO W3CLOGFILE: W3CLOGFILE AZMONSTREAM: AZMONSTREAM
EventHubDataFormat	The data format of the message. Optionally the data format can be added to each message. KnownEventHubDataFormat can be used interchangeably with EventHubDataFormat, this enum contains the known values that the service supports. Known values supported by the service MULTIJSON: MULTIJSON JSON: JSON CSV: CSV TSV: TSV SCSV: SCSV SOHSV: SOHSV PSV: PSV TXT: TXT RAW: RAW SINGLEJSON: SINGLEJSON AVRO: AVRO TSVE: TSVE PARQUET: PARQUET ORC: ORC APACHEAVRO: APACHEAVRO W3CLOGFILE: W3CLOGFILE AZMONSTREAM: AZMONSTREAM
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. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service None: None SystemAssigned: SystemAssigned UserAssigned: UserAssigned SystemAssigned, UserAssigned: SystemAssigned, UserAssigned
IotHubDataFormat	The data format of the message. Optionally the data format can be added to each message. KnownIotHubDataFormat can be used interchangeably with IotHubDataFormat, this enum contains the known values that the service supports. Known values supported by the service MULTIJSON: MULTIJSON JSON: JSON CSV: CSV TSV: TSV SCSV: SCSV SOHSV: SOHSV PSV: PSV TXT: TXT RAW: RAW SINGLEJSON: SINGLEJSON AVRO: AVRO TSVE: TSVE PARQUET: PARQUET ORC: ORC APACHEAVRO: APACHEAVRO W3CLOGFILE: W3CLOGFILE AZMONSTREAM: AZMONSTREAM
Kind	Kind of the database KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports. Known values supported by the service ReadWrite: ReadWrite ReadOnlyFollowing: ReadOnlyFollowing
Language	The language name, for example Python. KnownLanguage can be used interchangeably with Language, this enum contains the known values that the service supports. Known values supported by the service Python: Python
LanguageExtensionImageName	Language extension image name. KnownLanguageExtensionImageName can be used interchangeably with LanguageExtensionImageName, this enum contains the known values that the service supports. Known values supported by the service R: R Python3_6_5: Python3_6_5 Python3_10_8: Python3_10_8 Python3_10_8_DL: Python3_10_8_DL PythonCustomImage: PythonCustomImage Python3_11_7: Python3_11_7 Python3_11_7_DL: Python3_11_7_DL
LanguageExtensionName	Language extension that can run within KQL query. KnownLanguageExtensionName can be used interchangeably with LanguageExtensionName, this enum contains the known values that the service supports. Known values supported by the service PYTHON: PYTHON R: R
MigrationClusterRole	The role of the cluster in the migration process. KnownMigrationClusterRole can be used interchangeably with MigrationClusterRole, this enum contains the known values that the service supports. Known values supported by the service Source: Source Destination: Destination
OutboundAccess	Indicates whether outbound access is permitted for the specified URI pattern. KnownOutboundAccess can be used interchangeably with OutboundAccess, this enum contains the known values that the service supports. Known values supported by the service Allow: Allow Deny: Deny
PrincipalPermissionsAction	Indicates if the permissions for the script caller are kept following completion of the script. KnownPrincipalPermissionsAction can be used interchangeably with PrincipalPermissionsAction, this enum contains the known values that the service supports. Known values supported by the service RetainPermissionOnScriptCompletion: RetainPermissionOnScriptCompletion RemovePermissionOnScriptCompletion: RemovePermissionOnScriptCompletion
PrincipalType	Principal type. KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports. Known values supported by the service App: App Group: Group User: User
PrincipalsModificationKind	The principals modification kind of the database KnownPrincipalsModificationKind can be used interchangeably with PrincipalsModificationKind, this enum contains the known values that the service supports. Known values supported by the service Union: Union Replace: Replace None: None
ProvisioningState	The provisioned state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Running: Running Creating: Creating Deleting: Deleting Succeeded: Succeeded Failed: Failed Moving: Moving Canceled: Canceled
PublicIPType	Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) KnownPublicIPType can be used interchangeably with PublicIPType, this enum contains the known values that the service supports. Known values supported by the service IPv4: IPv4 DualStack: DualStack
PublicNetworkAccess	Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled SecuredByPerimeter: SecuredByPerimeter
Reason	Message providing the reason why the given name is invalid. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Invalid AlreadyExists: AlreadyExists
ScriptLevel	Differentiates between the type of script commands included - Database or Cluster. The default is Database. KnownScriptLevel can be used interchangeably with ScriptLevel, this enum contains the known values that the service supports. Known values supported by the service Database: Database Cluster: Cluster
State	The state of the resource. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Creating: Creating Unavailable: Unavailable Running: Running Deleting: Deleting Deleted: Deleted Stopping: Stopping Stopped: Stopped Starting: Starting Updating: Updating Migrated: Migrated
Status	The status of operation. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Canceled: Canceled Failed: Failed Running: Running
Type	The type of resource, for instance Microsoft.Kusto/clusters/databases.
VnetState	When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. KnownVnetState can be used interchangeably with VnetState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
ZoneStatus	Indicates whether the cluster is zonal or non-zonal. KnownZoneStatus can be used interchangeably with ZoneStatus, this enum contains the known values that the service supports. Known values supported by the service NonZonal: NonZonal ZonalInconsistency: ZonalInconsistency Zonal: Zonal

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAzureScaleType	Scale type.
KnownAzureSkuName	SKU name.
KnownAzureSkuTier	SKU tier.
KnownBlobStorageEventType	The name of blob storage event type to process.
KnownCallerRole	Known values of CallerRole that the service accepts.
KnownCalloutType	Type of the callout service, specifying the kind of external resource or service being accessed.
KnownClusterNetworkAccessFlag	Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
KnownClusterPrincipalRole	Cluster principal role.
KnownCompression	The compression type
KnownCreatedByType	The kind of entity that created the resource.
KnownDataConnectionKind	Kind of the endpoint for the data connection
KnownDatabasePrincipalRole	Database principal role.
KnownDatabasePrincipalType	Database principal type.
KnownDatabaseRouting	Indication for database routing information from the data connection, by default only database routing information is allowed
KnownDatabaseShareOrigin	The origin of the following setup.
KnownDefaultPrincipalsModificationKind	The default principals modification kind
KnownEngineType	The engine type
KnownEventGridDataFormat	The data format of the message. Optionally the data format can be added to each message.
KnownEventHubDataFormat	The data format of the message. Optionally the data format can be added to each message.
KnownIdentityType	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.
KnownIotHubDataFormat	The data format of the message. Optionally the data format can be added to each message.
KnownKind	Kind of the database
KnownLanguage	The language name, for example Python.
KnownLanguageExtensionImageName	Language extension image name.
KnownLanguageExtensionName	Language extension that can run within KQL query.
KnownMigrationClusterRole	The role of the cluster in the migration process.
KnownOutboundAccess	Indicates whether outbound access is permitted for the specified URI pattern.
KnownPrincipalPermissionsAction	Indicates if the permissions for the script caller are kept following completion of the script.
KnownPrincipalType	Principal type.
KnownPrincipalsModificationKind	The principals modification kind of the database
KnownProvisioningState	The provisioned state of the resource.
KnownPublicIPType	Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
KnownPublicNetworkAccess	Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed
KnownReason	Message providing the reason why the given name is invalid.
KnownScriptLevel	Differentiates between the type of script commands included - Database or Cluster. The default is Database.
KnownState	The state of the resource.
KnownStatus	The status of operation.
KnownVersions	The available API versions.
KnownVnetState	When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.
KnownZoneStatus	Indicates whether the cluster is zonal or non-zonal.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(KustoManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(KustoManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: KustoManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

KustoManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor