Share via


Cluster Class

Definition

Class representing a Kusto cluster.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Cluster : Microsoft.Azure.Management.Kusto.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Cluster = class
    inherit TrackedResource
Public Class Cluster
Inherits TrackedResource
Inheritance
Attributes

Constructors

Cluster()

Initializes a new instance of the Cluster class.

Cluster(String, AzureSku, String, String, String, IDictionary<String, String>, IList<String>, Identity, String, String, String, String, String, IList<TrustedExternalTenant>, OptimizedAutoscale, Nullable<Boolean>, Nullable<Boolean>, VirtualNetworkConfiguration, KeyVaultProperties, Nullable<Boolean>, LanguageExtensionsList, Nullable<Boolean>, String, String)

Initializes a new instance of the Cluster class.

Cluster(String, AzureSku, String, String, String, IDictionary<String, String>, SystemData, IList<String>, Identity, String, String, String, String, String, IList<TrustedExternalTenant>, OptimizedAutoscale, Nullable<Boolean>, Nullable<Boolean>, VirtualNetworkConfiguration, KeyVaultProperties, Nullable<Boolean>, LanguageExtensionsList, Nullable<Boolean>, String, IList<String>, String, IList<AcceptedAudiences>, Nullable<Boolean>, String, IList<String>, String, String, IList<PrivateEndpointConnection>, String)

Initializes a new instance of the Cluster class.

Properties

AcceptedAudiences

Gets or sets the cluster's accepted audiences.

AllowedFqdnList

Gets or sets list of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.

AllowedIpRangeList

Gets or sets the list of ips in the format of CIDR allowed to connect to the cluster.

DataIngestionUri

Gets the cluster data ingestion URI.

EnableAutoStop

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

EnableDiskEncryption

Gets or sets a boolean value that indicates if the cluster's disks are encrypted.

EnableDoubleEncryption

Gets or sets a boolean value that indicates if double encryption is enabled.

EnablePurge

Gets or sets a boolean value that indicates if the purge operations are enabled.

EnableStreamingIngest

Gets or sets a boolean value that indicates if the streaming ingest is enabled.

EngineType

Gets or sets the engine type. Possible values include: 'V2', 'V3'

Etag

Gets a unique read-only string that changes whenever the resource is updated.

Id

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

(Inherited from Resource)
Identity

Gets or sets the identity of the cluster, if configured.

KeyVaultProperties

Gets or sets keyVault properties for the cluster encryption.

LanguageExtensions

Gets list of the cluster's language extensions.

Location

Gets or sets the geo-location where the resource lives

(Inherited from TrackedResource)
Name

Gets the name of the resource

(Inherited from Resource)
OptimizedAutoscale

Gets or sets optimized auto scale definition.

PrivateEndpointConnections

Gets a list of private endpoint connections.

ProvisioningState

Gets the provisioned state of the resource. Possible values include: 'Running', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Moving'

PublicIPType

Gets or sets indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6). Possible values include: 'IPv4', 'DualStack'

PublicNetworkAccess

Gets or sets public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed. Possible values include: 'Enabled', 'Disabled'

RestrictOutboundNetworkAccess

Gets or sets whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Possible values include: 'Enabled', 'Disabled'

Sku

Gets or sets the SKU of the cluster.

State

Gets the state of the resource. Possible values include: 'Creating', 'Unavailable', 'Running', 'Deleting', 'Deleted', 'Stopping', 'Stopped', 'Starting', 'Updating'

StateReason

Gets the reason for the cluster's current state.

SystemData
Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
TrustedExternalTenants

Gets or sets the cluster's external tenants.

Type

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

(Inherited from Resource)
Uri

Gets the cluster URI.

VirtualClusterGraduationProperties

Gets or sets virtual Cluster graduation properties

VirtualNetworkConfiguration

Gets or sets virtual network definition.

Zones

Gets or sets the availability zones of the cluster.

Methods

Validate()

Validate the object.

Applies to