Azure Native

v1.78.0 published on Wednesday, Sep 14, 2022 by Pulumi

getCluster

A Stream Analytics Cluster object API Version: 2020-03-01-preview.

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:streamanalytics:getCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterName string

The name of the cluster.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ClusterName string

The name of the cluster.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

clusterName String

The name of the cluster.

resourceGroupName String

The name of the resource group. The name is case insensitive.

clusterName string

The name of the cluster.

resourceGroupName string

The name of the resource group. The name is case insensitive.

cluster_name str

The name of the cluster.

resource_group_name str

The name of the resource group. The name is case insensitive.

clusterName String

The name of the cluster.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getCluster Result

The following output properties are available:

Etag string

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

Id string

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

Name string

The name of the resource

Properties Pulumi.AzureNative.StreamAnalytics.Outputs.ClusterPropertiesResponse

The properties associated with a Stream Analytics cluster.

Type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Location string

The geo-location where the resource lives

Sku Pulumi.AzureNative.StreamAnalytics.Outputs.ClusterSkuResponse

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Tags Dictionary<string, string>

Resource tags.

Etag string

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

Id string

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

Name string

The name of the resource

Properties ClusterPropertiesResponse

The properties associated with a Stream Analytics cluster.

Type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Location string

The geo-location where the resource lives

Sku ClusterSkuResponse

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Tags map[string]string

Resource tags.

etag String

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

id String

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

name String

The name of the resource

properties ClusterPropertiesResponse

The properties associated with a Stream Analytics cluster.

type String

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

location String

The geo-location where the resource lives

sku ClusterSkuResponse

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

tags Map<String,String>

Resource tags.

etag string

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

id string

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

name string

The name of the resource

properties ClusterPropertiesResponse

The properties associated with a Stream Analytics cluster.

type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

location string

The geo-location where the resource lives

sku ClusterSkuResponse

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

tags {[key: string]: string}

Resource tags.

etag str

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

id str

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

name str

The name of the resource

properties ClusterPropertiesResponse

The properties associated with a Stream Analytics cluster.

type str

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

location str

The geo-location where the resource lives

sku ClusterSkuResponse

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

tags Mapping[str, str]

Resource tags.

etag String

The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

id String

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

name String

The name of the resource

properties Property Map

The properties associated with a Stream Analytics cluster.

type String

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

location String

The geo-location where the resource lives

sku Property Map

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

tags Map<String>

Resource tags.

Supporting Types

ClusterPropertiesResponse

CapacityAllocated int

Represents the number of streaming units currently being used on the cluster.

CapacityAssigned int

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

ClusterId string

Unique identifier for the cluster.

CreatedDate string

The date this cluster was created.

ProvisioningState string

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

CapacityAllocated int

Represents the number of streaming units currently being used on the cluster.

CapacityAssigned int

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

ClusterId string

Unique identifier for the cluster.

CreatedDate string

The date this cluster was created.

ProvisioningState string

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

capacityAllocated Integer

Represents the number of streaming units currently being used on the cluster.

capacityAssigned Integer

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

clusterId String

Unique identifier for the cluster.

createdDate String

The date this cluster was created.

provisioningState String

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

capacityAllocated number

Represents the number of streaming units currently being used on the cluster.

capacityAssigned number

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

clusterId string

Unique identifier for the cluster.

createdDate string

The date this cluster was created.

provisioningState string

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

capacity_allocated int

Represents the number of streaming units currently being used on the cluster.

capacity_assigned int

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

cluster_id str

Unique identifier for the cluster.

created_date str

The date this cluster was created.

provisioning_state str

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

capacityAllocated Number

Represents the number of streaming units currently being used on the cluster.

capacityAssigned Number

Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

clusterId String

Unique identifier for the cluster.

createdDate String

The date this cluster was created.

provisioningState String

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

ClusterSkuResponse

Capacity int

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

Name string

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

Capacity int

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

Name string

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

capacity Integer

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

name String

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

capacity number

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

name string

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

capacity int

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

name str

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

capacity Number

Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

name String

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

Package Details

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