@azure/arm-kusto package

Classes

KustoManagementClient

Interfaces

AcceptedAudiences	Represents an accepted audience trusted by the cluster.
AttachedDatabaseConfiguration	Class representing an attached database configuration.
AttachedDatabaseConfigurationListResult	The list attached database configurations operation response.
AttachedDatabaseConfigurations	Interface representing a AttachedDatabaseConfigurations.
AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsCheckNameRequest	The result returned from a AttachedDatabaseConfigurations check name availability request.
AttachedDatabaseConfigurationsCreateOrUpdateHeaders	Defines headers for AttachedDatabaseConfigurations_createOrUpdate operation.
AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsDeleteHeaders	Defines headers for AttachedDatabaseConfigurations_delete operation.
AttachedDatabaseConfigurationsDeleteOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsGetOptionalParams	Optional parameters.
AttachedDatabaseConfigurationsListByClusterOptionalParams	Optional parameters.
AzureCapacity	Azure capacity definition.
AzureResourceSku	Azure resource SKU definition.
AzureSku	Azure SKU definition.
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.
ClusterListResult	The list Kusto clusters operation response.
ClusterMigrateRequest	A cluster migrate request.
ClusterPrincipalAssignment	Class representing a cluster principal assignment.
ClusterPrincipalAssignmentCheckNameRequest	A principal assignment check name availability request.
ClusterPrincipalAssignmentListResult	The list Kusto cluster principal assignments operation response.
ClusterPrincipalAssignments	Interface representing a ClusterPrincipalAssignments.
ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsDeleteHeaders	Defines headers for ClusterPrincipalAssignments_delete operation.
ClusterPrincipalAssignmentsDeleteOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsGetOptionalParams	Optional parameters.
ClusterPrincipalAssignmentsListOptionalParams	Optional parameters.
ClusterUpdate	Class representing an update to a Kusto cluster.
Clusters	Interface representing a Clusters.
ClustersAddLanguageExtensionsHeaders	Defines headers for Clusters_addLanguageExtensions operation.
ClustersAddLanguageExtensionsOptionalParams	Optional parameters.
ClustersCheckNameAvailabilityOptionalParams	Optional parameters.
ClustersCreateOrUpdateOptionalParams	Optional parameters.
ClustersDeleteHeaders	Defines headers for Clusters_delete operation.
ClustersDeleteOptionalParams	Optional parameters.
ClustersDetachFollowerDatabasesHeaders	Defines headers for Clusters_detachFollowerDatabases operation.
ClustersDetachFollowerDatabasesOptionalParams	Optional parameters.
ClustersDiagnoseVirtualNetworkHeaders	Defines headers for Clusters_diagnoseVirtualNetwork operation.
ClustersDiagnoseVirtualNetworkOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListFollowerDatabasesOptionalParams	Optional parameters.
ClustersListLanguageExtensionsOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersListOutboundNetworkDependenciesEndpointsNextOptionalParams	Optional parameters.
ClustersListOutboundNetworkDependenciesEndpointsOptionalParams	Optional parameters.
ClustersListSkusByResourceOptionalParams	Optional parameters.
ClustersListSkusOptionalParams	Optional parameters.
ClustersMigrateHeaders	Defines headers for Clusters_migrate operation.
ClustersMigrateOptionalParams	Optional parameters.
ClustersRemoveLanguageExtensionsHeaders	Defines headers for Clusters_removeLanguageExtensions operation.
ClustersRemoveLanguageExtensionsOptionalParams	Optional parameters.
ClustersStartHeaders	Defines headers for Clusters_start operation.
ClustersStartOptionalParams	Optional parameters.
ClustersStopHeaders	Defines headers for Clusters_stop operation.
ClustersStopOptionalParams	Optional parameters.
ClustersUpdateHeaders	Defines headers for Clusters_update operation.
ClustersUpdateOptionalParams	Optional parameters.
ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties
CosmosDbDataConnection	Class representing a CosmosDb data connection.
DataConnection	Class representing an data connection.
DataConnectionCheckNameRequest	A data connection check name availability request.
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.
DataConnections	Interface representing a DataConnections.
DataConnectionsCheckNameAvailabilityOptionalParams	Optional parameters.
DataConnectionsCreateOrUpdateHeaders	Defines headers for DataConnections_createOrUpdate operation.
DataConnectionsCreateOrUpdateOptionalParams	Optional parameters.
DataConnectionsDataConnectionValidationHeaders	Defines headers for DataConnections_dataConnectionValidation operation.
DataConnectionsDataConnectionValidationOptionalParams	Optional parameters.
DataConnectionsDeleteHeaders	Defines headers for DataConnections_delete operation.
DataConnectionsDeleteOptionalParams	Optional parameters.
DataConnectionsGetOptionalParams	Optional parameters.
DataConnectionsListByDatabaseOptionalParams	Optional parameters.
DataConnectionsUpdateHeaders	Defines headers for DataConnections_update operation.
DataConnectionsUpdateOptionalParams	Optional parameters.
Database	Class representing a Kusto database.
DatabaseInviteFollowerOptionalParams	Optional parameters.
DatabaseInviteFollowerRequest	The request to invite a follower to a database.
DatabaseInviteFollowerResult	The result returned from a follower invitation generation request.
DatabaseListResult	The list Kusto databases operation response.
DatabaseOperations	Interface representing a DatabaseOperations.
DatabasePrincipal	A class representing database principal entity.
DatabasePrincipalAssignment	Class representing a database principal assignment.
DatabasePrincipalAssignmentCheckNameRequest	A principal assignment check name availability request.
DatabasePrincipalAssignmentListResult	The list Kusto database principal assignments operation response.
DatabasePrincipalAssignments	Interface representing a DatabasePrincipalAssignments.
DatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsDeleteHeaders	Defines headers for DatabasePrincipalAssignments_delete operation.
DatabasePrincipalAssignmentsDeleteOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsGetOptionalParams	Optional parameters.
DatabasePrincipalAssignmentsListOptionalParams	Optional parameters.
DatabasePrincipalListRequest	The list Kusto database principals operation request.
DatabasePrincipalListResult	The list Kusto database principals operation response.
DatabaseStatistics	A class that contains database statistics information.
Databases	Interface representing a Databases.
DatabasesAddPrincipalsOptionalParams	Optional parameters.
DatabasesCheckNameAvailabilityOptionalParams	Optional parameters.
DatabasesCreateOrUpdateHeaders	Defines headers for Databases_createOrUpdate operation.
DatabasesCreateOrUpdateOptionalParams	Optional parameters.
DatabasesDeleteHeaders	Defines headers for Databases_delete operation.
DatabasesDeleteOptionalParams	Optional parameters.
DatabasesGetOptionalParams	Optional parameters.
DatabasesListByClusterNextOptionalParams	Optional parameters.
DatabasesListByClusterOptionalParams	Optional parameters.
DatabasesListPrincipalsOptionalParams	Optional parameters.
DatabasesRemovePrincipalsOptionalParams	Optional parameters.
DatabasesUpdateHeaders	Defines headers for Databases_update operation.
DatabasesUpdateOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
EventGridDataConnection	Class representing an Event Grid data connection.
EventHubDataConnection	Class representing an event hub data connection.
FollowerDatabaseDefinition	A class representing follower database request.
FollowerDatabaseListResult	The list Kusto database principals operation response.
Identity	Identity for the resource.
IotHubDataConnection	Class representing an iot hub data connection.
KeyVaultProperties	Properties of the key vault.
KustoManagementClientOptionalParams	Optional parameters.
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.
ManagedPrivateEndpointListResult	The list managed private endpoints operation response.
ManagedPrivateEndpoints	Interface representing a ManagedPrivateEndpoints.
ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams	Optional parameters.
ManagedPrivateEndpointsCheckNameRequest	The result returned from a managedPrivateEndpoints check name availability request.
ManagedPrivateEndpointsCreateOrUpdateHeaders	Defines headers for ManagedPrivateEndpoints_createOrUpdate operation.
ManagedPrivateEndpointsCreateOrUpdateOptionalParams	Optional parameters.
ManagedPrivateEndpointsDeleteHeaders	Defines headers for ManagedPrivateEndpoints_delete operation.
ManagedPrivateEndpointsDeleteOptionalParams	Optional parameters.
ManagedPrivateEndpointsGetOptionalParams	Optional parameters.
ManagedPrivateEndpointsListOptionalParams	Optional parameters.
ManagedPrivateEndpointsUpdateHeaders	Defines headers for ManagedPrivateEndpoints_update operation.
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.
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.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsResults	Interface representing a OperationsResults.
OperationsResultsGetOptionalParams	Optional parameters.
OperationsResultsLocation	Interface representing a OperationsResultsLocation.
OperationsResultsLocationGetHeaders	Defines headers for OperationsResultsLocation_get operation.
OperationsResultsLocationGetOptionalParams	Optional parameters.
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.
OutboundNetworkDependenciesEndpointListResult	Collection of Outbound Environment Endpoints
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionListResult	A list of private endpoint connections
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteHeaders	Defines headers for PrivateEndpointConnections_delete operation.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
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.
ReadWriteDatabase	Class representing a read write database.
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.
SandboxCustomImage	Class representing a Kusto sandbox custom image.
SandboxCustomImages	Interface representing a SandboxCustomImages.
SandboxCustomImagesCheckNameAvailabilityOptionalParams	Optional parameters.
SandboxCustomImagesCheckNameRequest	The result returned from a sandboxCustomImage check name availability request.
SandboxCustomImagesCreateOrUpdateOptionalParams	Optional parameters.
SandboxCustomImagesDeleteHeaders	Defines headers for SandboxCustomImages_delete operation.
SandboxCustomImagesDeleteOptionalParams	Optional parameters.
SandboxCustomImagesGetOptionalParams	Optional parameters.
SandboxCustomImagesListByClusterOptionalParams	Optional parameters.
SandboxCustomImagesListResult	The list Kusto sandbox custom images operation response.
SandboxCustomImagesUpdateHeaders	Defines headers for SandboxCustomImages_update operation.
SandboxCustomImagesUpdateOptionalParams	Optional parameters.
Script	Class representing a database script.
ScriptCheckNameRequest	A script name availability request.
ScriptListResult	The list Kusto database script operation response.
Scripts	Interface representing a Scripts.
ScriptsCheckNameAvailabilityOptionalParams	Optional parameters.
ScriptsCreateOrUpdateHeaders	Defines headers for Scripts_createOrUpdate operation.
ScriptsCreateOrUpdateOptionalParams	Optional parameters.
ScriptsDeleteHeaders	Defines headers for Scripts_delete operation.
ScriptsDeleteOptionalParams	Optional parameters.
ScriptsGetOptionalParams	Optional parameters.
ScriptsListByDatabaseOptionalParams	Optional parameters.
ScriptsUpdateHeaders	Defines headers for Scripts_update operation.
ScriptsUpdateOptionalParams	Optional parameters.
SkuDescription	The Kusto SKU description of given resource type
SkuDescriptionList	The list of the EngagementFabric SKU descriptions
SkuLocationInfoItem	The locations and zones info for SKU.
Skus	Interface representing a Skus.
SkusListOptionalParams	Optional parameters.
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

AttachedDatabaseConfigurationsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
AttachedDatabaseConfigurationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AttachedDatabaseConfigurationsGetResponse	Contains response data for the get operation.
AttachedDatabaseConfigurationsListByClusterResponse	Contains response data for the listByCluster operation.
AzureScaleType	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
AzureSkuName	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
AzureSkuTier	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
BlobStorageEventType	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
CallerRole	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
ClusterNetworkAccessFlag	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
ClusterPrincipalAssignmentsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ClusterPrincipalAssignmentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ClusterPrincipalAssignmentsGetResponse	Contains response data for the get operation.
ClusterPrincipalAssignmentsListResponse	Contains response data for the list operation.
ClusterPrincipalRole	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
ClustersCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ClustersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ClustersDiagnoseVirtualNetworkResponse	Contains response data for the diagnoseVirtualNetwork operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClustersListFollowerDatabasesResponse	Contains response data for the listFollowerDatabases operation.
ClustersListLanguageExtensionsResponse	Contains response data for the listLanguageExtensions operation.
ClustersListOutboundNetworkDependenciesEndpointsNextResponse	Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.
ClustersListOutboundNetworkDependenciesEndpointsResponse	Contains response data for the listOutboundNetworkDependenciesEndpoints operation.
ClustersListResponse	Contains response data for the list operation.
ClustersListSkusByResourceResponse	Contains response data for the listSkusByResource operation.
ClustersListSkusResponse	Contains response data for the listSkus operation.
ClustersUpdateResponse	Contains response data for the update operation.
Compression	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
CreatedByType	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
DataConnectionKind	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
DataConnectionUnion
DataConnectionsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
DataConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DataConnectionsDataConnectionValidationResponse	Contains response data for the dataConnectionValidation operation.
DataConnectionsGetResponse	Contains response data for the get operation.
DataConnectionsListByDatabaseResponse	Contains response data for the listByDatabase operation.
DataConnectionsUpdateResponse	Contains response data for the update operation.
DatabaseInviteFollowerResponse	Contains response data for the inviteFollower operation.
DatabasePrincipalAssignmentsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
DatabasePrincipalAssignmentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DatabasePrincipalAssignmentsGetResponse	Contains response data for the get operation.
DatabasePrincipalAssignmentsListResponse	Contains response data for the list operation.
DatabasePrincipalRole	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
DatabasePrincipalType	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
DatabaseRouting	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
DatabaseShareOrigin	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
DatabaseUnion
DatabasesAddPrincipalsResponse	Contains response data for the addPrincipals operation.
DatabasesCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
DatabasesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DatabasesGetResponse	Contains response data for the get operation.
DatabasesListByClusterNextResponse	Contains response data for the listByClusterNext operation.
DatabasesListByClusterResponse	Contains response data for the listByCluster operation.
DatabasesListPrincipalsResponse	Contains response data for the listPrincipals operation.
DatabasesRemovePrincipalsResponse	Contains response data for the removePrincipals operation.
DatabasesUpdateResponse	Contains response data for the update operation.
DefaultPrincipalsModificationKind	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
EngineType	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
EventGridDataFormat	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
EventHubDataFormat	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
IdentityType	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
IotHubDataFormat	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
Kind	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
Language	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
LanguageExtensionImageName	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
LanguageExtensionName	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
ManagedPrivateEndpointsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ManagedPrivateEndpointsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ManagedPrivateEndpointsGetResponse	Contains response data for the get operation.
ManagedPrivateEndpointsListResponse	Contains response data for the list operation.
ManagedPrivateEndpointsUpdateResponse	Contains response data for the update operation.
MigrationClusterRole	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
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
OperationsResultsGetResponse	Contains response data for the get operation.
OperationsResultsLocationGetResponse	Contains response data for the get operation.
PrincipalType	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
PrincipalsModificationKind	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
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListResponse	Contains response data for the list operation.
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListResponse	Contains response data for the list operation.
ProvisioningState	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
PublicIPType	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
PublicNetworkAccess	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
Reason	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
SandboxCustomImagesCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
SandboxCustomImagesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SandboxCustomImagesGetResponse	Contains response data for the get operation.
SandboxCustomImagesListByClusterResponse	Contains response data for the listByCluster operation.
SandboxCustomImagesUpdateResponse	Contains response data for the update operation.
ScriptsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ScriptsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ScriptsGetResponse	Contains response data for the get operation.
ScriptsListByDatabaseResponse	Contains response data for the listByDatabase operation.
ScriptsUpdateResponse	Contains response data for the update operation.
SkusListResponse	Contains response data for the list operation.
State	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
Status	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
Type	Defines values for Type.
VnetState	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

Enums

KnownAzureScaleType	Known values of AzureScaleType that the service accepts.
KnownAzureSkuName	Known values of AzureSkuName that the service accepts.
KnownAzureSkuTier	Known values of AzureSkuTier that the service accepts.
KnownBlobStorageEventType	Known values of BlobStorageEventType that the service accepts.
KnownCallerRole	Known values of CallerRole that the service accepts.
KnownClusterNetworkAccessFlag	Known values of ClusterNetworkAccessFlag that the service accepts.
KnownClusterPrincipalRole	Known values of ClusterPrincipalRole that the service accepts.
KnownCompression	Known values of Compression that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDataConnectionKind	Known values of DataConnectionKind that the service accepts.
KnownDatabasePrincipalRole	Known values of DatabasePrincipalRole that the service accepts.
KnownDatabasePrincipalType	Known values of DatabasePrincipalType that the service accepts.
KnownDatabaseRouting	Known values of DatabaseRouting that the service accepts.
KnownDatabaseShareOrigin	Known values of DatabaseShareOrigin that the service accepts.
KnownDefaultPrincipalsModificationKind	Known values of DefaultPrincipalsModificationKind that the service accepts.
KnownEngineType	Known values of EngineType that the service accepts.
KnownEventGridDataFormat	Known values of EventGridDataFormat that the service accepts.
KnownEventHubDataFormat	Known values of EventHubDataFormat that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownIotHubDataFormat	Known values of IotHubDataFormat that the service accepts.
KnownKind	Known values of Kind that the service accepts.
KnownLanguage	Known values of Language that the service accepts.
KnownLanguageExtensionImageName	Known values of LanguageExtensionImageName that the service accepts.
KnownLanguageExtensionName	Known values of LanguageExtensionName that the service accepts.
KnownMigrationClusterRole	Known values of MigrationClusterRole that the service accepts.
KnownPrincipalType	Known values of PrincipalType that the service accepts.
KnownPrincipalsModificationKind	Known values of PrincipalsModificationKind that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicIPType	Known values of PublicIPType that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownReason	Known values of Reason that the service accepts.
KnownState	Known values of State that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownVnetState	Known values of VnetState that the service accepts.

Functions

getContinuationToken(unknown)

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

Function Details

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.