Clusters interface

Package:

@azure/arm-eventhub

Interface representing a Clusters.

Methods

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Creates or updates an instance of an Event Hubs Cluster.
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Creates or updates an instance of an Event Hubs Cluster.
beginDelete(string, string, ClustersDeleteOptionalParams)	Deletes an existing Event Hubs Cluster. This operation is idempotent.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Deletes an existing Event Hubs Cluster. This operation is idempotent.
beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)	Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)	Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
get(string, string, ClustersGetOptionalParams)	Gets the resource description of the specified Event Hubs Cluster.
listAvailableClusterRegion(ClustersListAvailableClusterRegionOptionalParams)	List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Lists the available Event Hubs Clusters within an ARM resource group
listBySubscription(ClustersListBySubscriptionOptionalParams)	Lists the available Event Hubs Clusters within an ARM resource group
listNamespaces(string, string, ClustersListNamespacesOptionalParams)	List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

Method Details

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Creates or updates an instance of an Event Hubs Cluster.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

parameters

Cluster

Parameters for creating a eventhub cluster resource.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Creates or updates an instance of an Event Hubs Cluster.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

parameters

Cluster

Parameters for creating a eventhub cluster resource.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes an existing Event Hubs Cluster. This operation is idempotent.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes an existing Event Hubs Cluster. This operation is idempotent.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)

Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

parameters

Cluster

The properties of the Event Hubs Cluster which should be updated.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)

Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

parameters

Cluster

The properties of the Event Hubs Cluster which should be updated.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, ClustersGetOptionalParams)

Gets the resource description of the specified Event Hubs Cluster.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

listAvailableClusterRegion(ClustersListAvailableClusterRegionOptionalParams)

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

function listAvailableClusterRegion(options?: ClustersListAvailableClusterRegionOptionalParams): Promise<AvailableClustersList>

Parameters

options

ClustersListAvailableClusterRegionOptionalParams

The options parameters.

Returns

Promise<AvailableClustersList>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists the available Event Hubs Clusters within an ARM resource group

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

options

ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription(ClustersListBySubscriptionOptionalParams)

Lists the available Event Hubs Clusters within an ARM resource group

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

Parameters

options

ClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listNamespaces(string, string, ClustersListNamespacesOptionalParams)

List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

function listNamespaces(resourceGroupName: string, clusterName: string, options?: ClustersListNamespacesOptionalParams): Promise<EHNamespaceIdListResult>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

clusterName

string

The name of the Event Hubs Cluster.

options

ClustersListNamespacesOptionalParams

The options parameters.

Returns

Promise<EHNamespaceIdListResult>