Package-level declarations

Types

Link copied to clipboard
data class AcceptedAudiencesResponse(val value: String? = null)

Represents an accepted audience trusted by the cluster.

Link copied to clipboard
data class AzureSkuResponse(val capacity: Int? = null, val name: String, val tier: String)

Azure SKU definition.

Link copied to clipboard
data class CalloutPolicyResponse(val calloutId: String, val calloutType: String? = null, val calloutUriRegex: String? = null, val outboundAccess: String? = null)

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

Link copied to clipboard
data class DatabasePrincipalResponse(val appId: String? = null, val email: String? = null, val fqn: String? = null, val name: String, val role: String, val tenantName: String, val type: String)

A class representing database principal entity.

Link copied to clipboard
data class DatabaseStatisticsResponse(val size: Double? = null)

A class that contains database statistics information.

Link copied to clipboard
data class FollowerDatabaseDefinitionResponse(val attachedDatabaseConfigurationName: String, val clusterResourceId: String, val databaseName: String, val databaseShareOrigin: String, val tableLevelSharingProperties: TableLevelSharingPropertiesResponse)

A class representing follower database request.

Link copied to clipboard
data class GetAttachedDatabaseConfigurationResult(val attachedDatabaseNames: List<String>, val azureApiVersion: String, val clusterResourceId: String, val databaseName: String, val databaseNameOverride: String? = null, val databaseNamePrefix: String? = null, val defaultPrincipalsModificationKind: String, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tableLevelSharingProperties: TableLevelSharingPropertiesResponse? = null, val type: String)

Class representing an attached database configuration.

Link copied to clipboard
data class GetClusterPrincipalAssignmentResult(val aadObjectId: String, val azureApiVersion: String, val id: String, val name: String, val principalId: String, val principalName: String, val principalType: String, val provisioningState: String, val role: String, val tenantId: String? = null, val tenantName: String, val type: String)

Class representing a cluster principal assignment.

Link copied to clipboard
data class GetClusterResult(val acceptedAudiences: List<AcceptedAudiencesResponse>? = null, val allowedFqdnList: List<String>? = null, val allowedIpRangeList: List<String>? = null, val azureApiVersion: String, val calloutPolicies: List<CalloutPolicyResponse>? = null, val dataIngestionUri: String, val enableAutoStop: Boolean? = null, val enableDiskEncryption: Boolean? = null, val enableDoubleEncryption: Boolean? = null, val enablePurge: Boolean? = null, val enableStreamingIngest: Boolean? = null, val engineType: String? = null, val etag: String, val id: String, val identity: IdentityResponse? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val languageExtensions: LanguageExtensionsListResponse? = null, val location: String, val migrationCluster: MigrationClusterPropertiesResponse, val name: String, val optimizedAutoscale: OptimizedAutoscaleResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicIPType: String? = null, val publicNetworkAccess: String? = null, val restrictOutboundNetworkAccess: String? = null, val sku: AzureSkuResponse, val state: String, val stateReason: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val trustedExternalTenants: List<TrustedExternalTenantResponse>? = null, val type: String, val uri: String, val virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, val zoneStatus: String, val zones: List<String>? = null)

Class representing a Kusto cluster.

Link copied to clipboard
data class GetCosmosDbDataConnectionResult(val azureApiVersion: String, val cosmosDbAccountResourceId: String, val cosmosDbContainer: String, val cosmosDbDatabase: String, val id: String, val kind: String, val location: String? = null, val managedIdentityObjectId: String, val managedIdentityResourceId: String, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val retrievalStartDate: String? = null, val tableName: String, val type: String)

Class representing a CosmosDb data connection.

Link copied to clipboard
data class GetDatabasePrincipalAssignmentResult(val aadObjectId: String, val azureApiVersion: String, val id: String, val name: String, val principalId: String, val principalName: String, val principalType: String, val provisioningState: String, val role: String, val tenantId: String? = null, val tenantName: String, val type: String)

Class representing a database principal assignment.

Link copied to clipboard
data class GetEventGridDataConnectionResult(val azureApiVersion: String, val blobStorageEventType: String? = null, val consumerGroup: String, val dataFormat: String? = null, val databaseRouting: String? = null, val eventGridResourceId: String? = null, val eventHubResourceId: String, val id: String, val ignoreFirstRecord: Boolean? = null, val kind: String, val location: String? = null, val managedIdentityObjectId: String, val managedIdentityResourceId: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val storageAccountResourceId: String, val tableName: String? = null, val type: String)

Class representing an Event Grid data connection.

Link copied to clipboard
data class GetEventHubConnectionResult(val azureApiVersion: String, val consumerGroup: String, val dataFormat: String? = null, val eventHubResourceId: String, val id: String, val location: String? = null, val mappingRuleName: String? = null, val name: String, val tableName: String? = null, val type: String)

Class representing an event hub connection.

Link copied to clipboard
data class GetEventHubDataConnectionResult(val azureApiVersion: String, val compression: String? = null, val consumerGroup: String, val dataFormat: String? = null, val databaseRouting: String? = null, val eventHubResourceId: String, val eventSystemProperties: List<String>? = null, val id: String, val kind: String, val location: String? = null, val managedIdentityObjectId: String, val managedIdentityResourceId: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val retrievalStartDate: String? = null, val tableName: String? = null, val type: String)

Class representing an event hub data connection.

Link copied to clipboard
data class GetIotHubDataConnectionResult(val azureApiVersion: String, val consumerGroup: String, val dataFormat: String? = null, val databaseRouting: String? = null, val eventSystemProperties: List<String>? = null, val id: String, val iotHubResourceId: String, val kind: String, val location: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val retrievalStartDate: String? = null, val sharedAccessPolicyName: String, val tableName: String? = null, val type: String)

Class representing an iot hub data connection.

Link copied to clipboard
data class GetManagedPrivateEndpointResult(val azureApiVersion: String, val groupId: String, val id: String, val name: String, val privateLinkResourceId: String, val privateLinkResourceRegion: String? = null, val provisioningState: String, val requestMessage: String? = null, val systemData: SystemDataResponse, val type: String)

Class representing a managed private endpoint.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val groupId: String, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetReadOnlyFollowingDatabaseResult(val attachedDatabaseConfigurationName: String, val azureApiVersion: String, val databaseShareOrigin: String, val hotCachePeriod: String? = null, val id: String, val kind: String, val leaderClusterResourceId: String, val location: String? = null, val name: String, val originalDatabaseName: String, val principalsModificationKind: String, val provisioningState: String, val softDeletePeriod: String, val statistics: DatabaseStatisticsResponse, val suspensionDetails: SuspensionDetailsResponse, val tableLevelSharingProperties: TableLevelSharingPropertiesResponse, val type: String)

Class representing a read only following database.

Link copied to clipboard
data class GetReadWriteDatabaseResult(val azureApiVersion: String, val hotCachePeriod: String? = null, val id: String, val isFollowed: Boolean, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val kind: String, val location: String? = null, val name: String, val provisioningState: String, val softDeletePeriod: String? = null, val statistics: DatabaseStatisticsResponse, val suspensionDetails: SuspensionDetailsResponse, val type: String)

Class representing a read write database.

Link copied to clipboard
data class GetSandboxCustomImageResult(val azureApiVersion: String, val baseImageName: String? = null, val id: String, val language: String, val languageVersion: String? = null, val name: String, val provisioningState: String, val requirementsFileContent: String? = null, val type: String)

Class representing a Kusto sandbox custom image.

Link copied to clipboard
data class GetScriptResult(val azureApiVersion: String, val continueOnErrors: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val name: String, val principalPermissionsAction: String? = null, val provisioningState: String, val scriptLevel: String? = null, val scriptUrl: String? = null, val systemData: SystemDataResponse, val type: String)

Class representing a database script.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, IdentityResponseUserAssignedIdentities>? = null)

Identity for the resource.

Link copied to clipboard
data class IdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)
Link copied to clipboard
data class KeyVaultPropertiesResponse(val keyName: String? = null, val keyVaultUri: String? = null, val keyVersion: String? = null, val userIdentity: String? = null)

Properties of the key vault.

Link copied to clipboard
data class LanguageExtensionResponse(val languageExtensionCustomImageName: String? = null, val languageExtensionImageName: String? = null, val languageExtensionName: String? = null)

The language extension object.

Link copied to clipboard

The list of language extension objects.

Link copied to clipboard
data class ListClusterCalloutPoliciesResult(val nextLink: String? = null, val value: List<CalloutPolicyResponse>? = null)

A list of the service's callout policy objects.

Link copied to clipboard

The list Kusto database principals operation response.

Link copied to clipboard

The list of language extension objects.

Link copied to clipboard

The list Kusto database principals operation response.

Link copied to clipboard
data class MigrationClusterPropertiesResponse(val dataIngestionUri: String, val id: String, val role: String, val uri: String)

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

Link copied to clipboard
data class OptimizedAutoscaleResponse(val isEnabled: Boolean, val maximum: Int, val minimum: Int, val version: Int)

A class that contains the optimized auto scale definition.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupId: String, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A private endpoint connection

Link copied to clipboard

Private endpoint which the connection belongs to.

data class PrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String? = null, val status: String? = null)

Connection State of the Private Endpoint Connection.

Link copied to clipboard
data class SuspensionDetailsResponse(val suspensionStartDate: String? = null)

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

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TableLevelSharingPropertiesResponse(val externalTablesToExclude: List<String>? = null, val externalTablesToInclude: List<String>? = null, val functionsToExclude: List<String>? = null, val functionsToInclude: List<String>? = null, val materializedViewsToExclude: List<String>? = null, val materializedViewsToInclude: List<String>? = null, val tablesToExclude: List<String>? = null, val tablesToInclude: List<String>? = null)

Tables that will be included and excluded in the follower database

Link copied to clipboard
data class TrustedExternalTenantResponse(val value: String? = null)

Represents a tenant ID that is trusted by the cluster.

Link copied to clipboard
data class VirtualNetworkConfigurationResponse(val dataManagementPublicIpId: String, val enginePublicIpId: String, val state: String? = null, val subnetId: String)

A class that contains virtual network definition.