建立取用者群組
建立新的取用者群組。 建立取用者群組時,您可以在 ConsumerGroupDescription 中指定下列屬性。 如果未指定屬性,事件中樞會使用該屬性的預設值。 請參閱 ConsumerGroupDescription 屬性。
ConsumerGroupDescription 属性的預設值:
屬性名稱 | Default |
---|---|
UserMetadata |
(空白) |
要求
方法 | 要求 URI |
---|---|
PUT | https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups/{consumergroupName} |
要求標頭
如需與事件中樞相關的所有要求所使用的標頭和參數,請參閱 一般參數和標頭 。
回應
回應包括 HTTP 狀態碼、一組回應標頭和回應主體。
元素名稱 | 必要 | 類型 | 版本 | 描述 |
---|---|---|---|---|
CreatedAt |
是,唯讀 | 字串 | 2014-01 | 建立取用者群組的確切時間。 |
UpdatedAt |
是,唯讀 | 字串 | 2014-01 | 更新取用者群組的確切時間。 |
回應碼
程式碼 | 描述 |
---|---|
201 | 已建立。 |
400 | 不正確的要求。 |
401 | 授權失敗。 |
403 | 超過配額;未建立取用者群組。 |
409 | 指定的取用者群組已經存在 (,或指定的路徑已佔用) 。 |
500 | 內部錯誤。 |
回應本文
如果要求成功,回應本文會包含指定之取用者群組的描述。 如果要求不成功,本文會包含錯誤碼和錯誤訊息。
範例
要求
注意
您也可以使用 Azure Active Directory 令牌作為 授權 標頭,如 一般參數和標頭中所述。 例如:Authorization: Bearer <Azure AD token>
。
PUT https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01 HTTP/1.1
Authorization: SharedAccessSignature sr=https%3A%2F%2Fyour-namespace.servicebus.windows.net%2F&sig=your-sas-key&se=1455847106&skn=RootManageSharedAccessKey
Content-Type: application/atom+xml;type=entry;charset=utf-8
Host: your-namespace.servicebus.windows.net
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<ConsumerGroupDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
</ConsumerGroupDescription>
</content>
</entry>
回應
HTTP/1.1 201 Created
Content-Type: application/atom+xml;type=entry;charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Fri, 19 Feb 2016 01:52:50 GMT
Content-Length: 776
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01</id>
<title type="text">testCG</title>
<published>2016-02-19T01:52:50Z</published>
<updated>2016-02-19T01:52:50Z</updated>
<link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01" />
<content type="application/xml">
<ConsumerGroupDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CreatedAt>2016-02-19T01:52:50.570652Z</CreatedAt>
<UpdatedAt>2016-02-19T01:52:50.570652Z</UpdatedAt>
</ConsumerGroupDescription>
</content>
</entry>