Share via


KustoCluster Class

Definition

KustoCluster.

public class KustoCluster : Azure.Provisioning.Primitives.ProvisionableResource
type KustoCluster = class
    inherit ProvisionableResource
Public Class KustoCluster
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
KustoCluster(String, String)

Creates a new KustoCluster.

Properties

Name Description
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.

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
CalloutPolicies

List of callout policies for egress from Cluster.

ClusterUri

The cluster URI.

DataIngestionUri

The cluster data ingestion URI.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
EngineType

The engine type.

ETag

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

Id

Gets the Id.

Identity

The identity of the cluster, if configured.

IsAutoStopEnabled

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

IsDiskEncryptionEnabled

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

IsDoubleEncryptionEnabled

A boolean value that indicates if double encryption is enabled.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
IsPurgeEnabled

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

IsStreamingIngestEnabled

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

KeyVaultProperties

KeyVault properties for the cluster encryption.

LanguageExtensionsValue

The list of language extensions.

Location

Gets or sets the Location.

MigrationCluster

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

Name

The name of the Kusto 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.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
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.

SystemData

Gets the SystemData.

Tags

Gets or sets the Tags.

TrustedExternalTenants

The cluster's external tenants.

VirtualClusterGraduationProperties

Virtual Cluster graduation properties.

VirtualNetworkConfiguration

Virtual network definition.

Zones

The availability zones of the cluster.

ZoneStatus

Indicates whether the cluster is zonal or non-zonal.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of KustoCluster.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing KustoCluster.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to