Azure Native v1.98.1, Mar 24 23

azure-native.operationalinsights.getCluster

Gets a Log Analytics cluster instance. API Version: 2020-10-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:operationalinsights:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: Name of the Log Analytics Cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: Name of the Log Analytics Cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: Name of the Log Analytics Cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: Name of the Log Analytics Cluster.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: Name of the Log Analytics Cluster.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: Name of the Log Analytics Cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getCluster Result

The following output properties are available:

ClusterId string: The ID associated with the cluster.
CreatedDate string: The cluster creation time
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastModifiedDate string: The last time the cluster was updated.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state of the cluster.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AssociatedWorkspaces List<Pulumi.AzureNative.OperationalInsights.Outputs.AssociatedWorkspaceResponse>: The list of Log Analytics workspaces associated with the cluster
BillingType string: The cluster's billing type.
CapacityReservationProperties Pulumi.AzureNative.OperationalInsights.Outputs.CapacityReservationPropertiesResponse: Additional properties for capacity reservation
Identity Pulumi.AzureNative.OperationalInsights.Outputs.IdentityResponse: The identity of the resource.
IsAvailabilityZonesEnabled bool: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
KeyVaultProperties Pulumi.AzureNative.OperationalInsights.Outputs.KeyVaultPropertiesResponse: The associated key properties.
Sku Pulumi.AzureNative.OperationalInsights.Outputs.ClusterSkuResponse: The sku properties.
Tags Dictionary<string, string>: Resource tags.

ClusterId string: The ID associated with the cluster.
CreatedDate string: The cluster creation time
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastModifiedDate string: The last time the cluster was updated.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state of the cluster.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AssociatedWorkspaces []AssociatedWorkspaceResponse: The list of Log Analytics workspaces associated with the cluster
BillingType string: The cluster's billing type.
CapacityReservationProperties CapacityReservationPropertiesResponse: Additional properties for capacity reservation
Identity IdentityResponse: The identity of the resource.
IsAvailabilityZonesEnabled bool: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
KeyVaultProperties KeyVaultPropertiesResponse: The associated key properties.
Sku ClusterSkuResponse: The sku properties.
Tags map[string]string: Resource tags.

clusterId String: The ID associated with the cluster.
createdDate String: The cluster creation time
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedDate String: The last time the cluster was updated.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state of the cluster.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
associatedWorkspaces List<AssociatedWorkspaceResponse>: The list of Log Analytics workspaces associated with the cluster
billingType String: The cluster's billing type.
capacityReservationProperties CapacityReservationPropertiesResponse: Additional properties for capacity reservation
identity IdentityResponse: The identity of the resource.
isAvailabilityZonesEnabled Boolean: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
keyVaultProperties KeyVaultPropertiesResponse: The associated key properties.
sku ClusterSkuResponse: The sku properties.
tags Map<String,String>: Resource tags.

clusterId string: The ID associated with the cluster.
createdDate string: The cluster creation time
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedDate string: The last time the cluster was updated.
location string: The geo-location where the resource lives
name string: The name of the resource
provisioningState string: The provisioning state of the cluster.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
associatedWorkspaces AssociatedWorkspaceResponse[]: The list of Log Analytics workspaces associated with the cluster
billingType string: The cluster's billing type.
capacityReservationProperties CapacityReservationPropertiesResponse: Additional properties for capacity reservation
identity IdentityResponse: The identity of the resource.
isAvailabilityZonesEnabled boolean: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
keyVaultProperties KeyVaultPropertiesResponse: The associated key properties.
sku ClusterSkuResponse: The sku properties.
tags {[key: string]: string}: Resource tags.

cluster_id str: The ID associated with the cluster.
created_date str: The cluster creation time
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_modified_date str: The last time the cluster was updated.
location str: The geo-location where the resource lives
name str: The name of the resource
provisioning_state str: The provisioning state of the cluster.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
associated_workspaces Sequence[AssociatedWorkspaceResponse]: The list of Log Analytics workspaces associated with the cluster
billing_type str: The cluster's billing type.
capacity_reservation_properties CapacityReservationPropertiesResponse: Additional properties for capacity reservation
identity IdentityResponse: The identity of the resource.
is_availability_zones_enabled bool: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
key_vault_properties KeyVaultPropertiesResponse: The associated key properties.
sku ClusterSkuResponse: The sku properties.
tags Mapping[str, str]: Resource tags.

clusterId String: The ID associated with the cluster.
createdDate String: The cluster creation time
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedDate String: The last time the cluster was updated.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state of the cluster.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
associatedWorkspaces List<Property Map>: The list of Log Analytics workspaces associated with the cluster
billingType String: The cluster's billing type.
capacityReservationProperties Property Map: Additional properties for capacity reservation
identity Property Map: The identity of the resource.
isAvailabilityZonesEnabled Boolean: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
keyVaultProperties Property Map: The associated key properties.
sku Property Map: The sku properties.
tags Map<String>: Resource tags.

Supporting Types

AssociatedWorkspaceResponse

AssociateDate string: The time of workspace association.
ResourceId string: The ResourceId id the assigned workspace.
WorkspaceId string: The id of the assigned workspace.
WorkspaceName string: The name id the assigned workspace.

AssociateDate string: The time of workspace association.
ResourceId string: The ResourceId id the assigned workspace.
WorkspaceId string: The id of the assigned workspace.
WorkspaceName string: The name id the assigned workspace.

associateDate String: The time of workspace association.
resourceId String: The ResourceId id the assigned workspace.
workspaceId String: The id of the assigned workspace.
workspaceName String: The name id the assigned workspace.

associateDate string: The time of workspace association.
resourceId string: The ResourceId id the assigned workspace.
workspaceId string: The id of the assigned workspace.
workspaceName string: The name id the assigned workspace.

associate_date str: The time of workspace association.
resource_id str: The ResourceId id the assigned workspace.
workspace_id str: The id of the assigned workspace.
workspace_name str: The name id the assigned workspace.

associateDate String: The time of workspace association.
resourceId String: The ResourceId id the assigned workspace.
workspaceId String: The id of the assigned workspace.
workspaceName String: The name id the assigned workspace.

CapacityReservationPropertiesResponse

LastSkuUpdate string: The last time Sku was updated.
MinCapacity double: Minimum CapacityReservation value in GB.

LastSkuUpdate string: The last time Sku was updated.
MinCapacity float64: Minimum CapacityReservation value in GB.

lastSkuUpdate String: The last time Sku was updated.
minCapacity Double: Minimum CapacityReservation value in GB.

lastSkuUpdate string: The last time Sku was updated.
minCapacity number: Minimum CapacityReservation value in GB.

last_sku_update str: The last time Sku was updated.
min_capacity float: Minimum CapacityReservation value in GB.

lastSkuUpdate String: The last time Sku was updated.
minCapacity Number: Minimum CapacityReservation value in GB.

ClusterSkuResponse

Capacity double: The capacity value
Name string: The name of the SKU.

Capacity float64: The capacity value
Name string: The name of the SKU.

capacity Double: The capacity value
name String: The name of the SKU.

capacity number: The capacity value
name string: The name of the SKU.

capacity float: The capacity value
name str: The name of the SKU.

capacity Number: The capacity value
name String: The name of the SKU.

IdentityResponse

PrincipalId string: The principal ID of resource identity.
TenantId string: The tenant ID of resource.
Type string: Type of managed service identity.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.OperationalInsights.Inputs.UserIdentityPropertiesResponse>: The list of user identities associated with the resource. 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: Type of managed service identity.
UserAssignedIdentities map[string]UserIdentityPropertiesResponse: The list of user identities associated with the resource. 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: Type of managed service identity.
userAssignedIdentities Map<String,UserIdentityPropertiesResponse>: The list of user identities associated with the resource. 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: Type of managed service identity.
userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}: The list of user identities associated with the resource. 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: Type of managed service identity.
user_assigned_identities Mapping[str, UserIdentityPropertiesResponse]: The list of user identities associated with the resource. 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: Type of managed service identity.
userAssignedIdentities Map<Property Map>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

KeyVaultPropertiesResponse

KeyName string: The name of the key associated with the Log Analytics cluster.
KeyRsaSize int: Selected key minimum required size.
KeyVaultUri string: The Key Vault uri which holds they key associated with the Log Analytics cluster.
KeyVersion string: The version of the key associated with the Log Analytics cluster.

KeyName string: The name of the key associated with the Log Analytics cluster.
KeyRsaSize int: Selected key minimum required size.
KeyVaultUri string: The Key Vault uri which holds they key associated with the Log Analytics cluster.
KeyVersion string: The version of the key associated with the Log Analytics cluster.

keyName String: The name of the key associated with the Log Analytics cluster.
keyRsaSize Integer: Selected key minimum required size.
keyVaultUri String: The Key Vault uri which holds they key associated with the Log Analytics cluster.
keyVersion String: The version of the key associated with the Log Analytics cluster.

keyName string: The name of the key associated with the Log Analytics cluster.
keyRsaSize number: Selected key minimum required size.
keyVaultUri string: The Key Vault uri which holds they key associated with the Log Analytics cluster.
keyVersion string: The version of the key associated with the Log Analytics cluster.

key_name str: The name of the key associated with the Log Analytics cluster.
key_rsa_size int: Selected key minimum required size.
key_vault_uri str: The Key Vault uri which holds they key associated with the Log Analytics cluster.
key_version str: The version of the key associated with the Log Analytics cluster.

keyName String: The name of the key associated with the Log Analytics cluster.
keyRsaSize Number: Selected key minimum required size.
keyVaultUri String: The Key Vault uri which holds they key associated with the Log Analytics cluster.
keyVersion String: The version of the key associated with the Log Analytics cluster.

UserIdentityPropertiesResponse

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.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0