ClustersOperations interface

Package:

@azure/arm-eventhub

Interface representing a Clusters operations.

Properties

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

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

createOrUpdate

Creates or updates an instance of an Event Hubs Cluster.

createOrUpdate: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

delete

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

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the resource description of the specified Event Hubs Cluster.

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

Property Value

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

listAvailableClusterRegion

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

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

Property Value

(options?: ClustersListAvailableClusterRegionOptionalParams) => Promise<AvailableClustersList>

listByResourceGroup

Lists the available Event Hubs Clusters within an ARM resource group

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

Property Value

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

listBySubscription

Lists the available Event Hubs Clusters within an ARM resource group

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

Property Value

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

listNamespaces

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

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

Property Value

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

update

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

update: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>