ConsumerGroups interface
代表 ConsumerGroups 的介面。
方法
| create |
建立或更新事件中樞取用者群組作為命名空間內的巢狀資源。 |
| delete(string, string, string, string, Consumer |
從指定的事件中樞和資源群組中刪除取用者群組。 |
| get(string, string, string, string, Consumer |
取得指定之取用者群組的描述。 |
| list |
取得命名空間中的所有取用者群組。 如果命名空間中沒有任何取用者群組存在，則會傳回空摘要。 |
方法詳細資料
createOrUpdate(string, string, string, string, ConsumerGroup, ConsumerGroupsCreateOrUpdateOptionalParams)
建立或更新事件中樞取用者群組作為命名空間內的巢狀資源。
function createOrUpdate(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, parameters: ConsumerGroup, options?: ConsumerGroupsCreateOrUpdateOptionalParams): Promise<ConsumerGroup>參數
- resourceGroupName
-
string
Azure 訂用帳戶內的資源組名。
- namespaceName
-
string
命名空間名稱
- eventHubName
-
string
事件中樞名稱
- consumerGroupName
-
string
取用者組名
- parameters
- ConsumerGroup
提供用來建立或更新取用者群組資源的參數。
選項參數。
傳回
Promise<ConsumerGroup>
delete(string, string, string, string, ConsumerGroupsDeleteOptionalParams)
從指定的事件中樞和資源群組中刪除取用者群組。
function delete(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
Azure 訂用帳戶內的資源組名。
- namespaceName
-
string
命名空間名稱
- eventHubName
-
string
事件中樞名稱
- consumerGroupName
-
string
取用者組名
選項參數。
傳回
Promise<void>
get(string, string, string, string, ConsumerGroupsGetOptionalParams)
取得指定之取用者群組的描述。
function get(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsGetOptionalParams): Promise<ConsumerGroup>參數
- resourceGroupName
-
string
Azure 訂用帳戶內的資源組名。
- namespaceName
-
string
命名空間名稱
- eventHubName
-
string
事件中樞名稱
- consumerGroupName
-
string
取用者組名
- options
- ConsumerGroupsGetOptionalParams
選項參數。
傳回
Promise<ConsumerGroup>
listByEventHub(string, string, string, ConsumerGroupsListByEventHubOptionalParams)
取得命名空間中的所有取用者群組。 如果命名空間中沒有任何取用者群組存在，則會傳回空摘要。
function listByEventHub(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: ConsumerGroupsListByEventHubOptionalParams): PagedAsyncIterableIterator<ConsumerGroup, ConsumerGroup[], PageSettings>參數
- resourceGroupName
-
string
Azure 訂用帳戶內的資源組名。
- namespaceName
-
string
命名空間名稱
- eventHubName
-
string
事件中樞名稱
選項參數。