Package version:

Interface Clusters

Interface representing a Clusters.

interface Clusters {
    beginCreateOrUpdate(resourceGroupName, clusterName, cluster, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginCreateOrUpdateAndWait(resourceGroupName, clusterName, cluster, options?): Promise<Cluster>;
    beginDelete(resourceGroupName, clusterName, options?): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName, clusterName, options?): Promise<void>;
    beginUpdate(resourceGroupName, clusterName, cluster, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginUpdateAndWait(resourceGroupName, clusterName, cluster, options?): Promise<Cluster>;
    get(resourceGroupName, clusterName, options?): Promise<Cluster>;
    listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<Cluster>;
    listBySubscription(options?): PagedAsyncIterableIterator<Cluster>;
    listStreamingJobs(resourceGroupName, clusterName, options?): PagedAsyncIterableIterator<ClusterJob>;
}

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByResourceGroup listBySubscription listStreamingJobs

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName, clusterName, cluster, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • Creates a Stream Analytics Cluster or replaces an already existing 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.

    • Optional options: ClustersCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait

  • beginCreateOrUpdateAndWait(resourceGroupName, clusterName, cluster, options?): Promise<Cluster>

  • Creates a Stream Analytics Cluster or replaces an already existing 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.

    • Optional options: ClustersCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<Cluster>

beginDelete

  • beginDelete(resourceGroupName, clusterName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Deletes the specified cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterName: string

      The name of the cluster.

    • Optional options: ClustersDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, clusterName, options?): Promise<void>

  • Deletes the specified cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterName: string

      The name of the cluster.

    • Optional options: ClustersDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginUpdate

  • beginUpdate(resourceGroupName, clusterName, cluster, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • 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.

    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).

    • Optional options: ClustersUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, clusterName, cluster, options?): Promise<Cluster>

  • 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.

    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).

    • Optional options: ClustersUpdateOptionalParams

      The options parameters.

    Returns Promise<Cluster>

get

  • get(resourceGroupName, clusterName, options?): Promise<Cluster>

  • Gets information about the specified cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterName: string

      The name of the cluster.

    • Optional options: ClustersGetOptionalParams

      The options parameters.

    Returns Promise<Cluster>

listByResourceGroup

listBySubscription

listStreamingJobs

Settings

Member Visibility

Theme

Generated using TypeDoc