Share via

Cluster interface

  • Reference
Package:
@azure/arm-operationalinsights

The top level Log Analytics cluster resource container.

Extends
TrackedResource

Properties

associatedWorkspaces

The list of Log Analytics workspaces associated with the cluster
billingType

The cluster's billing type.
capacityReservationProperties

Additional properties for capacity reservation
clusterId

The ID associated with the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
createdDate

The cluster creation time NOTE: This property will not be serialized. It can only be populated by the server.
identity

The identity of the resource.
isAvailabilityZonesEnabled

Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
isDoubleEncryptionEnabled

Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'
keyVaultProperties

The associated key properties.
lastModifiedDate

The last time the cluster was updated. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
sku

The sku properties.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

associatedWorkspaces

The list of Log Analytics workspaces associated with the cluster

associatedWorkspaces?: AssociatedWorkspace[]

Property Value

AssociatedWorkspace[]

billingType

The cluster's billing type.

billingType?: string

Property Value

string

capacityReservationProperties

Additional properties for capacity reservation

capacityReservationProperties?: CapacityReservationProperties

Property Value

CapacityReservationProperties

clusterId

The ID associated with the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

createdDate

The cluster creation time NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: string

Property Value

string

identity

The identity of the resource.

identity?: Identity

Property Value

Identity

isAvailabilityZonesEnabled

Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.

isAvailabilityZonesEnabled?: boolean

Property Value

boolean

isDoubleEncryptionEnabled

Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'

isDoubleEncryptionEnabled?: boolean

Property Value

boolean

keyVaultProperties

The associated key properties.

keyVaultProperties?: KeyVaultProperties

Property Value

KeyVaultProperties

lastModifiedDate

The last time the cluster was updated. NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedDate?: string

Property Value

string

provisioningState

The provisioning state of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sku

The sku properties.

sku?: ClusterSku

Property Value

ClusterSku

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type