Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

getCluster

Class representing a Kusto cluster. API Version: 2021-01-01.

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:kusto:getCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterName string

The name of the Kusto cluster.

ResourceGroupName string

The name of the resource group containing the Kusto cluster.

ClusterName string

The name of the Kusto cluster.

ResourceGroupName string

The name of the resource group containing the Kusto cluster.

clusterName String

The name of the Kusto cluster.

resourceGroupName String

The name of the resource group containing the Kusto cluster.

clusterName string

The name of the Kusto cluster.

resourceGroupName string

The name of the resource group containing the Kusto cluster.

cluster_name str

The name of the Kusto cluster.

resource_group_name str

The name of the resource group containing the Kusto cluster.

clusterName String

The name of the Kusto cluster.

resourceGroupName String

The name of the resource group containing the Kusto cluster.

getCluster Result

The following output properties are available:

DataIngestionUri string

The cluster data ingestion URI.

Etag string

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

Id string

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

LanguageExtensions Pulumi.AzureNative.Kusto.Outputs.LanguageExtensionsListResponse

List of the cluster's language extensions.

Location string

The geo-location where the resource lives

Name string

The name of the resource

ProvisioningState string

The provisioned state of the resource.

Sku Pulumi.AzureNative.Kusto.Outputs.AzureSkuResponse

The SKU of the cluster.

State string

The state of the resource.

StateReason string

The reason for the cluster's current state.

Type string

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

Uri string

The cluster URI.

EnableDiskEncryption bool

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

EnableDoubleEncryption bool

A boolean value that indicates if double encryption is enabled.

EnablePurge bool

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

EnableStreamingIngest bool

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

EngineType string

The engine type

Identity Pulumi.AzureNative.Kusto.Outputs.IdentityResponse

The identity of the cluster, if configured.

KeyVaultProperties Pulumi.AzureNative.Kusto.Outputs.KeyVaultPropertiesResponse

KeyVault properties for the cluster encryption.

OptimizedAutoscale Pulumi.AzureNative.Kusto.Outputs.OptimizedAutoscaleResponse

Optimized auto scale definition.

Tags Dictionary<string, string>

Resource tags.

TrustedExternalTenants List<Pulumi.AzureNative.Kusto.Outputs.TrustedExternalTenantResponse>

The cluster's external tenants.

VirtualNetworkConfiguration Pulumi.AzureNative.Kusto.Outputs.VirtualNetworkConfigurationResponse

Virtual network definition.

Zones List<string>

The availability zones of the cluster.

DataIngestionUri string

The cluster data ingestion URI.

Etag string

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

Id string

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

LanguageExtensions LanguageExtensionsListResponse

List of the cluster's language extensions.

Location string

The geo-location where the resource lives

Name string

The name of the resource

ProvisioningState string

The provisioned state of the resource.

Sku AzureSkuResponse

The SKU of the cluster.

State string

The state of the resource.

StateReason string

The reason for the cluster's current state.

Type string

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

Uri string

The cluster URI.

EnableDiskEncryption bool

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

EnableDoubleEncryption bool

A boolean value that indicates if double encryption is enabled.

EnablePurge bool

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

EnableStreamingIngest bool

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

EngineType string

The engine type

Identity IdentityResponse

The identity of the cluster, if configured.

KeyVaultProperties KeyVaultPropertiesResponse

KeyVault properties for the cluster encryption.

OptimizedAutoscale OptimizedAutoscaleResponse

Optimized auto scale definition.

Tags map[string]string

Resource tags.

TrustedExternalTenants []TrustedExternalTenantResponse

The cluster's external tenants.

VirtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network definition.

Zones []string

The availability zones of the cluster.

dataIngestionUri String

The cluster data ingestion URI.

etag String

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

id String

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

languageExtensions LanguageExtensionsListResponse

List of the cluster's language extensions.

location String

The geo-location where the resource lives

name String

The name of the resource

provisioningState String

The provisioned state of the resource.

sku AzureSkuResponse

The SKU of the cluster.

state String

The state of the resource.

stateReason String

The reason for the cluster's current state.

type String

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

uri String

The cluster URI.

enableDiskEncryption Boolean

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

enableDoubleEncryption Boolean

A boolean value that indicates if double encryption is enabled.

enablePurge Boolean

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

enableStreamingIngest Boolean

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

engineType String

The engine type

identity IdentityResponse

The identity of the cluster, if configured.

keyVaultProperties KeyVaultPropertiesResponse

KeyVault properties for the cluster encryption.

optimizedAutoscale OptimizedAutoscaleResponse

Optimized auto scale definition.

tags Map<String,String>

Resource tags.

trustedExternalTenants List<TrustedExternalTenantResponse>

The cluster's external tenants.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network definition.

zones List<String>

The availability zones of the cluster.

dataIngestionUri string

The cluster data ingestion URI.

etag string

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

id string

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

languageExtensions LanguageExtensionsListResponse

List of the cluster's language extensions.

location string

The geo-location where the resource lives

name string

The name of the resource

provisioningState string

The provisioned state of the resource.

sku AzureSkuResponse

The SKU of the cluster.

state string

The state of the resource.

stateReason string

The reason for the cluster's current state.

type string

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

uri string

The cluster URI.

enableDiskEncryption boolean

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

enableDoubleEncryption boolean

A boolean value that indicates if double encryption is enabled.

enablePurge boolean

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

enableStreamingIngest boolean

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

engineType string

The engine type

identity IdentityResponse

The identity of the cluster, if configured.

keyVaultProperties KeyVaultPropertiesResponse

KeyVault properties for the cluster encryption.

optimizedAutoscale OptimizedAutoscaleResponse

Optimized auto scale definition.

tags {[key: string]: string}

Resource tags.

trustedExternalTenants TrustedExternalTenantResponse[]

The cluster's external tenants.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network definition.

zones string[]

The availability zones of the cluster.

data_ingestion_uri str

The cluster data ingestion URI.

etag str

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

id str

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

language_extensions LanguageExtensionsListResponse

List of the cluster's language extensions.

location str

The geo-location where the resource lives

name str

The name of the resource

provisioning_state str

The provisioned state of the resource.

sku AzureSkuResponse

The SKU of the cluster.

state str

The state of the resource.

state_reason str

The reason for the cluster's current state.

type str

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

uri str

The cluster URI.

enable_disk_encryption bool

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

enable_double_encryption bool

A boolean value that indicates if double encryption is enabled.

enable_purge bool

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

enable_streaming_ingest bool

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

engine_type str

The engine type

identity IdentityResponse

The identity of the cluster, if configured.

key_vault_properties KeyVaultPropertiesResponse

KeyVault properties for the cluster encryption.

optimized_autoscale OptimizedAutoscaleResponse

Optimized auto scale definition.

tags Mapping[str, str]

Resource tags.

trusted_external_tenants Sequence[TrustedExternalTenantResponse]

The cluster's external tenants.

virtual_network_configuration VirtualNetworkConfigurationResponse

Virtual network definition.

zones Sequence[str]

The availability zones of the cluster.

dataIngestionUri String

The cluster data ingestion URI.

etag String

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

id String

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

languageExtensions Property Map

List of the cluster's language extensions.

location String

The geo-location where the resource lives

name String

The name of the resource

provisioningState String

The provisioned state of the resource.

sku Property Map

The SKU of the cluster.

state String

The state of the resource.

stateReason String

The reason for the cluster's current state.

type String

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

uri String

The cluster URI.

enableDiskEncryption Boolean

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

enableDoubleEncryption Boolean

A boolean value that indicates if double encryption is enabled.

enablePurge Boolean

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

enableStreamingIngest Boolean

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

engineType String

The engine type

identity Property Map

The identity of the cluster, if configured.

keyVaultProperties Property Map

KeyVault properties for the cluster encryption.

optimizedAutoscale Property Map

Optimized auto scale definition.

tags Map<String>

Resource tags.

trustedExternalTenants List<Property Map>

The cluster's external tenants.

virtualNetworkConfiguration Property Map

Virtual network definition.

zones List<String>

The availability zones of the cluster.

Supporting Types

AzureSkuResponse

Name string

SKU name.

Tier string

SKU tier.

Capacity int

The number of instances of the cluster.

Name string

SKU name.

Tier string

SKU tier.

Capacity int

The number of instances of the cluster.

name String

SKU name.

tier String

SKU tier.

capacity Integer

The number of instances of the cluster.

name string

SKU name.

tier string

SKU tier.

capacity number

The number of instances of the cluster.

name str

SKU name.

tier str

SKU tier.

capacity int

The number of instances of the cluster.

name String

SKU name.

tier String

SKU tier.

capacity Number

The number of instances of the cluster.

IdentityResponse

PrincipalId string

The principal ID of resource identity.

TenantId string

The tenant ID of resource.

Type string

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.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Kusto.Inputs.IdentityResponseUserAssignedIdentities>

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}'.

PrincipalId string

The principal ID of resource identity.

TenantId string

The tenant ID of resource.

Type string

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.

UserAssignedIdentities map[string]IdentityResponseUserAssignedIdentities

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}'.

principalId String

The principal ID of resource identity.

tenantId String

The tenant ID of resource.

type String

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.

userAssignedIdentities Map<String,IdentityResponseUserAssignedIdentities>

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}'.

principalId string

The principal ID of resource identity.

tenantId string

The tenant ID of resource.

type string

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.

userAssignedIdentities {[key: string]: IdentityResponseUserAssignedIdentities}

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}'.

principal_id str

The principal ID of resource identity.

tenant_id str

The tenant ID of resource.

type str

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.

user_assigned_identities Mapping[str, IdentityResponseUserAssignedIdentities]

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}'.

principalId String

The principal ID of resource identity.

tenantId String

The tenant ID of resource.

type String

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.

userAssignedIdentities Map<Property Map>

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}'.

IdentityResponseUserAssignedIdentities

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId string

The principal id of user assigned identity.

client_id str

The client id of user assigned identity.

principal_id str

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

KeyVaultPropertiesResponse

KeyName string

The name of the key vault key.

KeyVaultUri string

The Uri of the key vault.

KeyVersion string

The version of the key vault key.

UserIdentity string

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

KeyName string

The name of the key vault key.

KeyVaultUri string

The Uri of the key vault.

KeyVersion string

The version of the key vault key.

UserIdentity string

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

keyName String

The name of the key vault key.

keyVaultUri String

The Uri of the key vault.

keyVersion String

The version of the key vault key.

userIdentity String

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

keyName string

The name of the key vault key.

keyVaultUri string

The Uri of the key vault.

keyVersion string

The version of the key vault key.

userIdentity string

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

key_name str

The name of the key vault key.

key_vault_uri str

The Uri of the key vault.

key_version str

The version of the key vault key.

user_identity str

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

keyName String

The name of the key vault key.

keyVaultUri String

The Uri of the key vault.

keyVersion String

The version of the key vault key.

userIdentity String

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

LanguageExtensionResponse

LanguageExtensionName string

The language extension name.

LanguageExtensionName string

The language extension name.

languageExtensionName String

The language extension name.

languageExtensionName string

The language extension name.

language_extension_name str

The language extension name.

languageExtensionName String

The language extension name.

LanguageExtensionsListResponse

Value []LanguageExtensionResponse

The list of language extensions.

value List<LanguageExtensionResponse>

The list of language extensions.

value LanguageExtensionResponse[]

The list of language extensions.

value Sequence[LanguageExtensionResponse]

The list of language extensions.

value List<Property Map>

The list of language extensions.

OptimizedAutoscaleResponse

IsEnabled bool

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

Maximum int

Maximum allowed instances count.

Minimum int

Minimum allowed instances count.

Version int

The version of the template defined, for instance 1.

IsEnabled bool

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

Maximum int

Maximum allowed instances count.

Minimum int

Minimum allowed instances count.

Version int

The version of the template defined, for instance 1.

isEnabled Boolean

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

maximum Integer

Maximum allowed instances count.

minimum Integer

Minimum allowed instances count.

version Integer

The version of the template defined, for instance 1.

isEnabled boolean

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

maximum number

Maximum allowed instances count.

minimum number

Minimum allowed instances count.

version number

The version of the template defined, for instance 1.

is_enabled bool

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

maximum int

Maximum allowed instances count.

minimum int

Minimum allowed instances count.

version int

The version of the template defined, for instance 1.

isEnabled Boolean

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

maximum Number

Maximum allowed instances count.

minimum Number

Minimum allowed instances count.

version Number

The version of the template defined, for instance 1.

TrustedExternalTenantResponse

Value string

GUID representing an external tenant.

Value string

GUID representing an external tenant.

value String

GUID representing an external tenant.

value string

GUID representing an external tenant.

value str

GUID representing an external tenant.

value String

GUID representing an external tenant.

VirtualNetworkConfigurationResponse

DataManagementPublicIpId string

Data management's service public IP address resource id.

EnginePublicIpId string

Engine service's public IP address resource id.

SubnetId string

The subnet resource id.

DataManagementPublicIpId string

Data management's service public IP address resource id.

EnginePublicIpId string

Engine service's public IP address resource id.

SubnetId string

The subnet resource id.

dataManagementPublicIpId String

Data management's service public IP address resource id.

enginePublicIpId String

Engine service's public IP address resource id.

subnetId String

The subnet resource id.

dataManagementPublicIpId string

Data management's service public IP address resource id.

enginePublicIpId string

Engine service's public IP address resource id.

subnetId string

The subnet resource id.

data_management_public_ip_id str

Data management's service public IP address resource id.

engine_public_ip_id str

Engine service's public IP address resource id.

subnet_id str

The subnet resource id.

dataManagementPublicIpId String

Data management's service public IP address resource id.

enginePublicIpId String

Engine service's public IP address resource id.

subnetId String

The subnet resource id.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0