Clusters interface

Package:

@azure/arm-streamanalytics

Interface representing a Clusters.

Methods

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Creates a Stream Analytics Cluster or replaces an already existing cluster.
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Creates a Stream Analytics Cluster or replaces an already existing cluster.
beginDelete(string, string, ClustersDeleteOptionalParams)	Deletes the specified cluster.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Deletes the specified cluster.
beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)	Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.
beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)	Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.
get(string, string, ClustersGetOptionalParams)	Gets information about the specified cluster.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Lists all of the clusters in the given resource group.
listBySubscription(ClustersListBySubscriptionOptionalParams)	Lists all of the clusters in the given subscription.
listStreamingJobs(string, string, ClustersListStreamingJobsOptionalParams)	Lists all of the streaming jobs in the given cluster.

Method Details

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

cluster

Cluster

The definition of the cluster that will be used to create a new cluster or replace the existing one.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

cluster

Cluster

The definition of the cluster that will be used to create a new cluster or replace the existing one.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes the specified cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes the specified cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

function beginUpdate(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

cluster

Cluster

The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

cluster

Cluster

The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, ClustersGetOptionalParams)

Gets information about the specified cluster.

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists all of the clusters in the given resource group.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

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

options

ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription(ClustersListBySubscriptionOptionalParams)

Lists all of the clusters in the given subscription.

function listBySubscription(options?: ClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options

ClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listStreamingJobs(string, string, ClustersListStreamingJobsOptionalParams)

Lists all of the streaming jobs in the given cluster.

function listStreamingJobs(resourceGroupName: string, clusterName: string, options?: ClustersListStreamingJobsOptionalParams): PagedAsyncIterableIterator<ClusterJob, ClusterJob[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersListStreamingJobsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterJob, ClusterJob[], PageSettings>