Clusters interface
表示群集的接口。
方法
| begin |
创建或更新事件中心群集的实例。 |
| begin |
创建或更新事件中心群集的实例。 |
| begin |
删除现有事件中心群集。 此作是幂等的。 |
| begin |
删除现有事件中心群集。 此作是幂等的。 |
| begin |
修改事件中心群集上的可变属性。 此作是幂等的。 |
| begin |
修改事件中心群集上的可变属性。 此作是幂等的。 |
| get(string, string, Clusters |
获取指定事件中心群集的资源说明。 |
| list |
列出 Azure 区域编制索引的可用预预配事件中心群集的数量。 |
| list |
列出 ARM 资源组中的可用事件中心群集 |
| list |
列出事件中心专用群集中的所有事件中心命名空间 ID。 |
方法详细信息
beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)
创建或更新事件中心群集的实例。
function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>
参数
- resourceGroupName
-
string
Azure 订阅中的资源组的名称。
- clusterName
-
string
事件中心群集的名称。
- parameters
- Cluster
用于创建 eventhub 群集资源的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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 群集资源的参数。
选项参数。
返回
Promise<Cluster>
beginDelete(string, string, ClustersDeleteOptionalParams)
删除现有事件中心群集。 此作是幂等的。
function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
Azure 订阅中的资源组的名称。
- clusterName
-
string
事件中心群集的名称。
- options
- ClustersDeleteOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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<PollerLike<PollOperationState<Cluster>, Cluster>>
参数
- resourceGroupName
-
string
Azure 订阅中的资源组的名称。
- clusterName
-
string
事件中心群集的名称。
- parameters
- Cluster
应更新的事件中心群集的属性。
- options
- ClustersUpdateOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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>
参数
选项参数。
返回
Promise<AvailableClustersList>
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
列出 ARM 资源组中的可用事件中心群集
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
参数
- resourceGroupName
-
string
Azure 订阅中的资源组的名称。
选项参数。
返回
listNamespaces(string, string, ClustersListNamespacesOptionalParams)
列出事件中心专用群集中的所有事件中心命名空间 ID。
function listNamespaces(resourceGroupName: string, clusterName: string, options?: ClustersListNamespacesOptionalParams): Promise<EHNamespaceIdListResult>
参数
- resourceGroupName
-
string
Azure 订阅中的资源组的名称。
- clusterName
-
string
事件中心群集的名称。
选项参数。
返回
Promise<EHNamespaceIdListResult>