azure-native.kusto.getCluster
Gets 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:
- Cluster
Name string The name of the Kusto cluster.
- Resource
Group stringName The name of the resource group containing the Kusto cluster.
- Cluster
Name string The name of the Kusto cluster.
- Resource
Group stringName The name of the resource group containing the Kusto cluster.
- cluster
Name String The name of the Kusto cluster.
- resource
Group StringName The name of the resource group containing the Kusto cluster.
- cluster
Name string The name of the Kusto cluster.
- resource
Group stringName The name of the resource group containing the Kusto cluster.
- cluster_
name str The name of the Kusto cluster.
- resource_
group_ strname The name of the resource group containing the Kusto cluster.
- cluster
Name String The name of the Kusto cluster.
- resource
Group StringName The name of the resource group containing the Kusto cluster.
getCluster Result
The following output properties are available:
- Data
Ingestion stringUri 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}
- Language
Extensions Pulumi.Azure Native. Kusto. Outputs. Language Extensions List Response List of the cluster's language extensions.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string The provisioned state of the resource.
- Sku
Pulumi.
Azure Native. Kusto. Outputs. Azure Sku Response The SKU of the cluster.
- State string
The state of the resource.
- State
Reason 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.
- Enable
Disk boolEncryption A boolean value that indicates if the cluster's disks are encrypted.
- Enable
Double boolEncryption 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 boolIngest A boolean value that indicates if the streaming ingest is enabled.
- Engine
Type string The engine type
- Identity
Pulumi.
Azure Native. Kusto. Outputs. Identity Response The identity of the cluster, if configured.
- Key
Vault Pulumi.Properties Azure Native. Kusto. Outputs. Key Vault Properties Response KeyVault properties for the cluster encryption.
- Optimized
Autoscale Pulumi.Azure Native. Kusto. Outputs. Optimized Autoscale Response Optimized auto scale definition.
- Dictionary<string, string>
Resource tags.
- Trusted
External List<Pulumi.Tenants Azure Native. Kusto. Outputs. Trusted External Tenant Response> The cluster's external tenants.
- Virtual
Network Pulumi.Configuration Azure Native. Kusto. Outputs. Virtual Network Configuration Response Virtual network definition.
- Zones List<string>
The availability zones of the cluster.
- Data
Ingestion stringUri 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}
- Language
Extensions LanguageExtensions List Response List of the cluster's language extensions.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string The provisioned state of the resource.
- Sku
Azure
Sku Response The SKU of the cluster.
- State string
The state of the resource.
- State
Reason 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.
- Enable
Disk boolEncryption A boolean value that indicates if the cluster's disks are encrypted.
- Enable
Double boolEncryption 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 boolIngest A boolean value that indicates if the streaming ingest is enabled.
- Engine
Type string The engine type
- Identity
Identity
Response The identity of the cluster, if configured.
- Key
Vault KeyProperties Vault Properties Response KeyVault properties for the cluster encryption.
- Optimized
Autoscale OptimizedAutoscale Response Optimized auto scale definition.
- map[string]string
Resource tags.
- Trusted
External []TrustedTenants External Tenant Response The cluster's external tenants.
- Virtual
Network VirtualConfiguration Network Configuration Response Virtual network definition.
- Zones []string
The availability zones of the cluster.
- data
Ingestion StringUri 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}
- language
Extensions LanguageExtensions List Response List of the cluster's language extensions.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- provisioning
State String The provisioned state of the resource.
- sku
Azure
Sku Response The SKU of the cluster.
- state String
The state of the resource.
- state
Reason 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.
- enable
Disk BooleanEncryption A boolean value that indicates if the cluster's disks are encrypted.
- enable
Double BooleanEncryption A boolean value that indicates if double encryption is enabled.
- enable
Purge Boolean A boolean value that indicates if the purge operations are enabled.
- enable
Streaming BooleanIngest A boolean value that indicates if the streaming ingest is enabled.
- engine
Type String The engine type
- identity
Identity
Response The identity of the cluster, if configured.
- key
Vault KeyProperties Vault Properties Response KeyVault properties for the cluster encryption.
- optimized
Autoscale OptimizedAutoscale Response Optimized auto scale definition.
- Map<String,String>
Resource tags.
- trusted
External List<TrustedTenants External Tenant Response> The cluster's external tenants.
- virtual
Network VirtualConfiguration Network Configuration Response Virtual network definition.
- zones List<String>
The availability zones of the cluster.
- data
Ingestion stringUri 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}
- language
Extensions LanguageExtensions List Response List of the cluster's language extensions.
- location string
The geo-location where the resource lives
- name string
The name of the resource
- provisioning
State string The provisioned state of the resource.
- sku
Azure
Sku Response The SKU of the cluster.
- state string
The state of the resource.
- state
Reason 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.
- enable
Disk booleanEncryption A boolean value that indicates if the cluster's disks are encrypted.
- enable
Double booleanEncryption A boolean value that indicates if double encryption is enabled.
- enable
Purge boolean A boolean value that indicates if the purge operations are enabled.
- enable
Streaming booleanIngest A boolean value that indicates if the streaming ingest is enabled.
- engine
Type string The engine type
- identity
Identity
Response The identity of the cluster, if configured.
- key
Vault KeyProperties Vault Properties Response KeyVault properties for the cluster encryption.
- optimized
Autoscale OptimizedAutoscale Response Optimized auto scale definition.
- {[key: string]: string}
Resource tags.
- trusted
External TrustedTenants External Tenant Response[] The cluster's external tenants.
- virtual
Network VirtualConfiguration Network Configuration Response Virtual network definition.
- zones string[]
The availability zones of the cluster.
- data_
ingestion_ struri 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 LanguageExtensions List Response 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
Azure
Sku Response 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_ boolencryption A boolean value that indicates if the cluster's disks are encrypted.
- enable_
double_ boolencryption 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_ boolingest A boolean value that indicates if the streaming ingest is enabled.
- engine_
type str The engine type
- identity
Identity
Response The identity of the cluster, if configured.
- key_
vault_ Keyproperties Vault Properties Response KeyVault properties for the cluster encryption.
- optimized_
autoscale OptimizedAutoscale Response Optimized auto scale definition.
- Mapping[str, str]
Resource tags.
- trusted_
external_ Sequence[Trustedtenants External Tenant Response] The cluster's external tenants.
- virtual_
network_ Virtualconfiguration Network Configuration Response Virtual network definition.
- zones Sequence[str]
The availability zones of the cluster.
- data
Ingestion StringUri 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}
- language
Extensions 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
- provisioning
State String The provisioned state of the resource.
- sku Property Map
The SKU of the cluster.
- state String
The state of the resource.
- state
Reason 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.
- enable
Disk BooleanEncryption A boolean value that indicates if the cluster's disks are encrypted.
- enable
Double BooleanEncryption A boolean value that indicates if double encryption is enabled.
- enable
Purge Boolean A boolean value that indicates if the purge operations are enabled.
- enable
Streaming BooleanIngest A boolean value that indicates if the streaming ingest is enabled.
- engine
Type String The engine type
- identity Property Map
The identity of the cluster, if configured.
- key
Vault Property MapProperties KeyVault properties for the cluster encryption.
- optimized
Autoscale Property Map Optimized auto scale definition.
- Map<String>
Resource tags.
- trusted
External List<Property Map>Tenants The cluster's external tenants.
- virtual
Network Property MapConfiguration Virtual network definition.
- zones List<String>
The availability zones of the cluster.
Supporting Types
AzureSkuResponse
IdentityResponse
- Principal
Id string The principal ID of resource identity.
- Tenant
Id 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.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Kusto. Inputs. Identity Response User Assigned Identities> 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 string The principal ID of resource identity.
- Tenant
Id 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.
- User
Assigned map[string]IdentityIdentities Response User Assigned Identities 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 String The principal ID of resource identity.
- tenant
Id 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.
- user
Assigned Map<String,IdentityIdentities Response User Assigned Identities> 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 string The principal ID of resource identity.
- tenant
Id 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.
- user
Assigned {[key: string]: IdentityIdentities Response User Assigned Identities} 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_ Mapping[str, Identityidentities Response User Assigned Identities] 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 String The principal ID of resource identity.
- tenant
Id 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.
- user
Assigned Map<Property Map>Identities 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
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
- client
Id string The client id of user assigned identity.
- principal
Id 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.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
KeyVaultPropertiesResponse
- Key
Name string The name of the key vault key.
- Key
Vault stringUri The Uri of the key vault.
- Key
Version string The version of the key vault key.
- User
Identity string The user assigned identity (ARM resource id) that has access to the key.
- Key
Name string The name of the key vault key.
- Key
Vault stringUri The Uri of the key vault.
- Key
Version string The version of the key vault key.
- User
Identity string The user assigned identity (ARM resource id) that has access to the key.
- key
Name String The name of the key vault key.
- key
Vault StringUri The Uri of the key vault.
- key
Version String The version of the key vault key.
- user
Identity String The user assigned identity (ARM resource id) that has access to the key.
- key
Name string The name of the key vault key.
- key
Vault stringUri The Uri of the key vault.
- key
Version string The version of the key vault key.
- user
Identity 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_ struri 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.
- key
Name String The name of the key vault key.
- key
Vault StringUri The Uri of the key vault.
- key
Version String The version of the key vault key.
- user
Identity String The user assigned identity (ARM resource id) that has access to the key.
LanguageExtensionResponse
- Language
Extension stringName The language extension name.
- Language
Extension stringName The language extension name.
- language
Extension StringName The language extension name.
- language
Extension stringName The language extension name.
- language_
extension_ strname The language extension name.
- language
Extension StringName The language extension name.
LanguageExtensionsListResponse
- Value
List<Pulumi.
Azure Native. Kusto. Inputs. Language Extension Response> The list of language extensions.
- Value
[]Language
Extension Response The list of language extensions.
- value
List<Language
Extension Response> The list of language extensions.
- value
Language
Extension Response[] The list of language extensions.
- value
Sequence[Language
Extension Response] The list of language extensions.
- value List<Property Map>
The list of language extensions.
OptimizedAutoscaleResponse
- 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.
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
- Data
Management stringPublic Ip Id Data management's service public IP address resource id.
- Engine
Public stringIp Id Engine service's public IP address resource id.
- Subnet
Id string The subnet resource id.
- Data
Management stringPublic Ip Id Data management's service public IP address resource id.
- Engine
Public stringIp Id Engine service's public IP address resource id.
- Subnet
Id string The subnet resource id.
- data
Management StringPublic Ip Id Data management's service public IP address resource id.
- engine
Public StringIp Id Engine service's public IP address resource id.
- subnet
Id String The subnet resource id.
- data
Management stringPublic Ip Id Data management's service public IP address resource id.
- engine
Public stringIp Id Engine service's public IP address resource id.
- subnet
Id string The subnet resource id.
- data_
management_ strpublic_ ip_ id Data management's service public IP address resource id.
- engine_
public_ strip_ id Engine service's public IP address resource id.
- subnet_
id str The subnet resource id.
- data
Management StringPublic Ip Id Data management's service public IP address resource id.
- engine
Public StringIp Id Engine service's public IP address resource id.
- subnet
Id String The subnet resource id.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0