Cluster interface

  • Reference
Package:
@azure/arm-streamanalytics

A Stream Analytics Cluster object

Extends
TrackedResource

Properties

capacityAllocated

Represents the number of streaming units currently being used on the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
capacityAssigned

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. NOTE: This property will not be serialized. It can only be populated by the server.
clusterId

Unique identifier for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
createdDate

The date this cluster was created. NOTE: This property will not be serialized. It can only be populated by the server.
etag

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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled NOTE: This property will not be serialized. It can only be populated by the server.
sku

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

Inherited Properties

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

capacityAllocated

Represents the number of streaming units currently being used on the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

capacityAllocated?: number

Property Value

number

capacityAssigned

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. NOTE: This property will not be serialized. It can only be populated by the server.

capacityAssigned?: number

Property Value

number

clusterId

Unique identifier for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

createdDate

The date this cluster was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: Date

Property Value

Date

etag

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. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

provisioningState

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sku

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

sku?: ClusterSku

Property Value

ClusterSku

Inherited Property Details

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location?: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type