Share via


ICluster Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ClusterTypeConverter))]
public interface ICluster : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api10.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ClusterTypeConverter))>]
type ICluster = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
Public Interface ICluster
Implements ITrackedResource
Derived
Attributes
Implements

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

Etag

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

Id

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

(Inherited from IResource)
IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.

IdentityUserAssignedIdentity

The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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.

Location

The geo-location where the resource lives

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

Name

The name of the resource

(Inherited from IResource)
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'

SkuCapacity

The number of instances of the cluster.

SkuName

SKU name.

SkuTier

SKU tier.

State

The state of the resource.

StateReason

The reason for the cluster's current state.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

(Inherited from ITrackedResource)
TrustedExternalTenant

The cluster's external tenants.

Type

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

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

Zone

The availability zones of the cluster.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to