Share via


ClusterProperties Class

Definition

Class representing the Kusto cluster properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ClusterPropertiesTypeConverter))]
public class ClusterProperties : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IClusterProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ClusterPropertiesTypeConverter))>]
type ClusterProperties = class
    interface IClusterProperties
    interface IJsonSerializable
Public Class ClusterProperties
Implements IClusterProperties
Inheritance
ClusterProperties
Attributes
Implements

Constructors

ClusterProperties()

Creates an new ClusterProperties instance.

Properties

AcceptedAudience

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.

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

KeyVaultPropertyKeyName

The name of the key vault key.

KeyVaultPropertyKeyVaultUri

The Uri of the key vault.

KeyVaultPropertyKeyVersion

The version of the key vault key.

KeyVaultPropertyUserIdentity

The user assigned identity (ARM resource id) that has access to the key.

LanguageExtensionValue

The list of language extensions.

MigrationClusterDataIngestionUri

The public data ingestion URL of the cluster.

MigrationClusterId

The resource ID of the cluster.

MigrationClusterRole

The role of the cluster in the migration process.

MigrationClusterUri

The public URL of the cluster.

OptimizedAutoscaleIsEnabled

A boolean value that indicate if the optimized autoscale feature is enabled or not.

OptimizedAutoscaleMaximum

Maximum allowed instances count.

OptimizedAutoscaleMinimum

Minimum allowed instances count.

OptimizedAutoscaleVersion

The version of the template defined, for instance 1.

PrivateEndpointConnection

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'

State

The state of the resource.

StateReason

The reason for the cluster's current state.

TrustedExternalTenant

The cluster's external tenants.

Uri

The cluster URI.

VirtualClusterGraduationProperty

Virtual Cluster graduation properties

VirtualNetworkConfigurationDataManagementPublicIPId

Data management's service public IP address resource id.

VirtualNetworkConfigurationEnginePublicIPId

Engine service's public IP address resource id.

VirtualNetworkConfigurationState

When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.

VirtualNetworkConfigurationSubnetId

The subnet resource id.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ClusterProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ClusterProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IClusterProperties.

FromJsonString(String)

Creates a new instance of ClusterProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ClusterProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to