Clusters interface

套件:

@azure/arm-eventhub

表示叢集的介面。

方法

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	建立或更新事件中樞叢集的實例。
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	建立或更新事件中樞叢集的實例。
beginDelete(string, string, ClustersDeleteOptionalParams)	刪除現有的事件中樞叢集。 此作業是等冪的。
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	刪除現有的事件中樞叢集。 此作業是等冪的。
beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)	修改事件中樞叢集上的可變動屬性。 此作業是等冪的。
beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)	修改事件中樞叢集上的可變動屬性。 此作業是等冪的。
get(string, string, ClustersGetOptionalParams)	取得指定事件中樞叢集的資源描述。
listAvailableClusterRegion(ClustersListAvailableClusterRegionOptionalParams)	列出 Azure 區域編製索引的可用預先布建事件中樞叢集數量。
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	列出 ARM 資源群組內可用的事件中樞叢集
listBySubscription(ClustersListBySubscriptionOptionalParams)	列出 ARM 資源群組內可用的事件中樞叢集
listNamespaces(string, string, ClustersListNamespacesOptionalParams)	列出事件中樞專用叢集中的所有事件中樞命名空間標識碼。

方法詳細資料

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

建立或更新事件中樞叢集的實例。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

parameters

Cluster

建立 eventhub 叢集資源的參數。

options

ClustersCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

建立或更新事件中樞叢集的實例。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

parameters

Cluster

建立 eventhub 叢集資源的參數。

options

ClustersCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

刪除現有的事件中樞叢集。 此作業是等冪的。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

options

ClustersDeleteOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

刪除現有的事件中樞叢集。 此作業是等冪的。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

options

ClustersDeleteOptionalParams

選項參數。

傳回

Promise<void>

beginUpdate(string, string, Cluster, ClustersUpdateOptionalParams)

修改事件中樞叢集上的可變動屬性。 此作業是等冪的。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

parameters

Cluster

應更新的事件中樞叢集屬性。

options

ClustersUpdateOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, Cluster, ClustersUpdateOptionalParams)

修改事件中樞叢集上的可變動屬性。 此作業是等冪的。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

parameters

Cluster

應更新的事件中樞叢集屬性。

options

ClustersUpdateOptionalParams

選項參數。

傳回

Promise<Cluster>

get(string, string, ClustersGetOptionalParams)

取得指定事件中樞叢集的資源描述。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

options

ClustersGetOptionalParams

選項參數。

傳回

Promise<Cluster>

listAvailableClusterRegion(ClustersListAvailableClusterRegionOptionalParams)

列出 Azure 區域編製索引的可用預先布建事件中樞叢集數量。

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

參數

options

ClustersListAvailableClusterRegionOptionalParams

選項參數。

傳回

Promise<AvailableClustersList>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

列出 ARM 資源群組內可用的事件中樞叢集

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

options

ClustersListByResourceGroupOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription(ClustersListBySubscriptionOptionalParams)

列出 ARM 資源群組內可用的事件中樞叢集

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

參數

options

ClustersListBySubscriptionOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listNamespaces(string, string, ClustersListNamespacesOptionalParams)

列出事件中樞專用叢集中的所有事件中樞命名空間標識碼。

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

參數

resourceGroupName

string

Azure 訂用帳戶內的資源組名。

clusterName

string

事件中樞叢集的名稱。

options

ClustersListNamespacesOptionalParams

選項參數。

傳回

Promise<EHNamespaceIdListResult>