Cluster interface

Package:

@azure/arm-kusto

Class representing a Kusto cluster.

Extends

TrackedResource

Properties

acceptedAudiences	The cluster's accepted audiences.
allowedFqdnList	List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.
allowedIpRangeList	The list of ips in the format of CIDR allowed to connect to the cluster.
calloutPolicies	List of callout policies for egress from Cluster.
dataIngestionUri	The cluster data ingestion URI.
enableAutoStop	A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).
enableDiskEncryption	A boolean value that indicates if the cluster's disks are encrypted.
enableDoubleEncryption	A boolean value that indicates if double encryption is enabled.
enablePurge	A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest	A boolean value that indicates if the streaming ingest is enabled.
engineType	The engine type
etag	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
identity	The identity of the cluster, if configured.
keyVaultProperties	KeyVault properties for the cluster encryption.
languageExtensions	List of the cluster's language extensions.
migrationCluster	Properties of the peer cluster involved in a migration to/from this cluster.
optimizedAutoscale	Optimized auto scale definition.
privateEndpointConnections	A list of private endpoint connections.
provisioningState	The provisioned state of the resource.
publicIPType	Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
publicNetworkAccess	Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed
restrictOutboundNetworkAccess	Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
sku	The SKU of the cluster.
state	The state of the resource.
stateReason	The reason for the cluster's current state.
trustedExternalTenants	The cluster's external tenants.
uri	The cluster URI.
virtualClusterGraduationProperties	Virtual Cluster graduation properties
virtualNetworkConfiguration	Virtual network definition.
zones	The availability zones.
zoneStatus	Indicates whether the cluster is zonal or non-zonal.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

acceptedAudiences

The cluster's accepted audiences.

acceptedAudiences?: AcceptedAudiences[]

Property Value

AcceptedAudiences[]

allowedFqdnList

List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.

allowedFqdnList?: string[]

Property Value

string[]

allowedIpRangeList

The list of ips in the format of CIDR allowed to connect to the cluster.

allowedIpRangeList?: string[]

Property Value

string[]

calloutPolicies

List of callout policies for egress from Cluster.

calloutPolicies?: CalloutPolicy[]

Property Value

CalloutPolicy[]

dataIngestionUri

The cluster data ingestion URI.

dataIngestionUri?: string

Property Value

string

enableAutoStop

A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).

enableAutoStop?: boolean

Property Value

boolean

enableDiskEncryption

A boolean value that indicates if the cluster's disks are encrypted.

enableDiskEncryption?: boolean

Property Value

boolean

enableDoubleEncryption

A boolean value that indicates if double encryption is enabled.

enableDoubleEncryption?: boolean

Property Value

boolean

enablePurge

A boolean value that indicates if the purge operations are enabled.

enablePurge?: boolean

Property Value

boolean

enableStreamingIngest

A boolean value that indicates if the streaming ingest is enabled.

enableStreamingIngest?: boolean

Property Value

boolean

engineType

The engine type

engineType?: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: string

Property Value

string

identity

The identity of the cluster, if configured.

identity?: Identity

Property Value

Identity

keyVaultProperties

KeyVault properties for the cluster encryption.

keyVaultProperties?: KeyVaultProperties

Property Value

KeyVaultProperties

languageExtensions

List of the cluster's language extensions.

languageExtensions?: LanguageExtensionsList

Property Value

LanguageExtensionsList

migrationCluster

Properties of the peer cluster involved in a migration to/from this cluster.

migrationCluster?: MigrationClusterProperties

Property Value

MigrationClusterProperties

optimizedAutoscale

Optimized auto scale definition.

optimizedAutoscale?: OptimizedAutoscale

Property Value

OptimizedAutoscale

privateEndpointConnections

A list of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioned state of the resource.

provisioningState?: string

Property Value

string

publicIPType

Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)

publicIPType?: string

Property Value

string

publicNetworkAccess

Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed

publicNetworkAccess?: string

Property Value

string

restrictOutboundNetworkAccess

Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

restrictOutboundNetworkAccess?: string

Property Value

string

sku

The SKU of the cluster.

sku: AzureSku

Property Value

AzureSku

state

The state of the resource.

state?: string

Property Value

string

stateReason

The reason for the cluster's current state.

stateReason?: string

Property Value

string

trustedExternalTenants

The cluster's external tenants.

trustedExternalTenants?: TrustedExternalTenant[]

Property Value

TrustedExternalTenant[]

uri

The cluster URI.

uri?: string

Property Value

string

virtualClusterGraduationProperties

Virtual Cluster graduation properties

virtualClusterGraduationProperties?: string

Property Value

string

virtualNetworkConfiguration

Virtual network definition.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Property Value

VirtualNetworkConfiguration

zones

The availability zones.

zones?: string[]

Property Value

string[]

zoneStatus

Indicates whether the cluster is zonal or non-zonal.

zoneStatus?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type