Package-level declarations

Types

Link copied to clipboard
data class AssociatedWorkspaceResponse(val associateDate: String, val resourceId: String, val workspaceId: String, val workspaceName: String)

The list of Log Analytics workspaces associated with the cluster.

Link copied to clipboard
data class CapacityReservationPropertiesResponse(val lastSkuUpdate: String, val minCapacity: Double)

The Capacity Reservation properties.

Link copied to clipboard
data class ClusterSkuResponse(val capacity: Double? = null, val name: String? = null)

The cluster sku definition.

Link copied to clipboard
data class ColumnResponse(val dataTypeHint: String? = null, val description: String? = null, val displayName: String? = null, val isDefaultDisplay: Boolean, val isHidden: Boolean, val name: String? = null, val type: String? = null)

Table column.

Link copied to clipboard
data class GetClusterResult(val associatedWorkspaces: List<AssociatedWorkspaceResponse>? = null, val billingType: String? = null, val capacityReservationProperties: CapacityReservationPropertiesResponse? = null, val clusterId: String, val createdDate: String, val id: String, val identity: IdentityResponse? = null, val isAvailabilityZonesEnabled: Boolean? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val lastModifiedDate: String, val location: String, val name: String, val provisioningState: String, val sku: ClusterSkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

The top level Log Analytics cluster resource container.

Link copied to clipboard
data class GetDataExportResult(val createdDate: String? = null, val dataExportId: String? = null, val enable: Boolean? = null, val eventHubName: String? = null, val id: String, val lastModifiedDate: String? = null, val name: String, val resourceId: String, val tableNames: List<String>, val type: String)

The top level data export resource container.

Link copied to clipboard
data class GetDataSourceResult(val etag: String? = null, val id: String, val kind: String, val name: String, val properties: Any, val tags: Map<String, String>? = null, val type: String)

Datasources under OMS Workspace.

Link copied to clipboard
data class GetLinkedServiceResult(val id: String, val name: String, val provisioningState: String? = null, val resourceId: String? = null, val tags: Map<String, String>? = null, val type: String, val writeAccessResourceId: String? = null)

The top level Linked service resource container.

Link copied to clipboard
data class GetLinkedStorageAccountResult(val dataSourceType: String, val id: String, val name: String, val storageAccountIds: List<String>? = null, val type: String)

Linked storage accounts top level resource container.

Link copied to clipboard
data class GetMachineGroupResult(val count: Int? = null, val displayName: String, val etag: String? = null, val groupType: String? = null, val id: String, val kind: String, val machines: List<MachineReferenceWithHintsResponse>? = null, val name: String, val type: String)

A user-defined logical grouping of machines.

Link copied to clipboard
data class GetQueryPackResult(val id: String, val location: String, val name: String, val provisioningState: String, val queryPackId: String, val tags: Map<String, String>? = null, val timeCreated: String, val timeModified: String, val type: String)

An Log Analytics QueryPack definition.

Link copied to clipboard
data class GetQueryResult(val author: String, val body: String, val description: String? = null, val displayName: String, val id: String, val name: String, val properties: Any, val related: LogAnalyticsQueryPackQueryPropertiesResponseRelated? = null, val systemData: SystemDataResponse, val tags: Map<String, List<String>>? = null, val timeCreated: String, val timeModified: String, val type: String)

A Log Analytics QueryPack-Query definition.

Link copied to clipboard
data class GetSavedSearchResult(val category: String, val displayName: String, val etag: String? = null, val functionAlias: String? = null, val functionParameters: String? = null, val id: String, val name: String, val query: String, val tags: List<TagResponse>? = null, val type: String, val version: Double? = null)

Value object for saved search results.

Link copied to clipboard
data class GetSharedKeysResult(val primarySharedKey: String? = null, val secondarySharedKey: String? = null)

The shared keys for a workspace.

Link copied to clipboard
data class GetStorageInsightConfigResult(val containers: List<String>? = null, val eTag: String? = null, val id: String, val name: String, val status: StorageInsightStatusResponse, val storageAccount: StorageAccountResponse, val tables: List<String>? = null, val tags: Map<String, String>? = null, val type: String)

The top level storage insight resource container.

Link copied to clipboard
data class GetTableResult(val archiveRetentionInDays: Int, val id: String, val lastPlanModifiedDate: String, val name: String, val plan: String? = null, val provisioningState: String, val restoredLogs: RestoredLogsResponse? = null, val resultStatistics: ResultStatisticsResponse? = null, val retentionInDays: Int? = null, val schema: SchemaResponse? = null, val searchResults: SearchResultsResponse? = null, val systemData: SystemDataResponse, val totalRetentionInDays: Int? = null, val type: String)

Workspace data table definition.

Link copied to clipboard
data class GetWorkspaceResult(val createdDate: String, val customerId: String, val eTag: String? = null, val features: WorkspaceFeaturesResponse? = null, val forceCmkForQuery: Boolean? = null, val id: String, val location: String, val modifiedDate: String, val name: String, val privateLinkScopedResources: List<PrivateLinkScopedResourceResponse>, val provisioningState: String? = null, val publicNetworkAccessForIngestion: String? = null, val publicNetworkAccessForQuery: String? = null, val retentionInDays: Int? = null, val sku: WorkspaceSkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val workspaceCapping: WorkspaceCappingResponse? = null)

The top level Workspace resource container.

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

Identity for the resource.

Link copied to clipboard
data class KeyVaultPropertiesResponse(val keyName: String? = null, val keyRsaSize: Int? = null, val keyVaultUri: String? = null, val keyVersion: String? = null)

The key vault properties.

data class LogAnalyticsQueryPackQueryPropertiesResponseRelated(val categories: List<String>? = null, val resourceTypes: List<String>? = null, val solutions: List<String>? = null)

The related metadata items for the function.

Link copied to clipboard
data class MachineReferenceWithHintsResponse(val displayNameHint: String, val id: String, val kind: String, val name: String, val osFamilyHint: String, val type: String)

A machine reference with a hint of the machine's name and operating system.

Link copied to clipboard
data class PrivateLinkScopedResourceResponse(val resourceId: String? = null, val scopeId: String? = null)

The private link scope resource reference.

Link copied to clipboard
data class RestoredLogsResponse(val endRestoreTime: String? = null, val sourceTable: String? = null, val startRestoreTime: String? = null)

Restore parameters.

Link copied to clipboard
data class ResultStatisticsResponse(val ingestedRecords: Int, val progress: Double)

Search job execution statistics.

Link copied to clipboard
data class SchemaResponse(val categories: List<String>, val columns: List<ColumnResponse>? = null, val description: String? = null, val displayName: String? = null, val labels: List<String>, val name: String? = null, val restoredLogs: RestoredLogsResponse, val searchResults: SearchResultsResponse, val solutions: List<String>, val source: String, val standardColumns: List<ColumnResponse>, val tableSubType: String, val tableType: String)

Table's schema.

Link copied to clipboard
data class SearchResultsResponse(val description: String? = null, val endSearchTime: String? = null, val limit: Int? = null, val query: String? = null, val sourceTable: String, val startSearchTime: String? = null)

Parameters of the search job that initiated this table.

Link copied to clipboard
data class StorageAccountResponse(val id: String, val key: String)

Describes a storage account connection.

Link copied to clipboard
data class StorageInsightStatusResponse(val description: String? = null, val state: String)

The status of the storage insight.

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 TagResponse(val name: String, val value: String)

A tag of a saved search.

Link copied to clipboard
data class UserIdentityPropertiesResponse(val clientId: String, val principalId: String)

User assigned identity properties.

Link copied to clipboard
data class WorkspaceCappingResponse(val dailyQuotaGb: Double? = null, val dataIngestionStatus: String, val quotaNextResetTime: String)

The daily volume cap for ingestion.

Link copied to clipboard
data class WorkspaceFeaturesResponse(val clusterResourceId: String? = null, val disableLocalAuth: Boolean? = null, val enableDataExport: Boolean? = null, val enableLogAccessUsingOnlyResourcePermissions: Boolean? = null, val immediatePurgeDataOn30Days: Boolean? = null)

Workspace features.

Link copied to clipboard
data class WorkspaceSkuResponse(val capacityReservationLevel: Int? = null, val lastSkuUpdate: String, val name: String)

The SKU (tier) of a workspace.