Event Hub の取得

[アーティクル]
08/05/2023

指定したイベントハブに関連付けられているすべてのメタデータを取得します。「EventHubDescription のプロパティ」を参照してください。

Request

Method	要求 URI
GET	`https://{serviceNamespace}.servicebus.windows.net/{eventHubPath}`

要求ヘッダー

Event Hubs に関連するすべての要求で使用されるヘッダーとパラメーターについては、「共通パラメーターとヘッダー」を参照してください。

[応答]

応答には、HTTP 状態コード、一連の応答ヘッダー、および応答本文が含まれています。

要素名	必須	Type	Version	Description
`AuthorizationRules`	はい、読み取り専用	string	2014-01	承認規則。
MessageRetentionInDays	はい、読み取り専用	string	2014-01	このイベントハブのイベントを保持する日数。
`Status`	はい、読み取り専用	string	2014-01	イベントハブの現在の状態 (有効または無効)。
`CreatedAt`	はい、読み取り専用	string	2014-01	イベントハブが作成された正確な時刻。
`UpdatedAt`	はい、読み取り専用	string	2014-01	イベントハブが更新された正確な時刻。
`PartitionCount`	はい、読み取り専用	string	2014-01	イベントハブ上のパーティションの現在の数。
`PartitionIds`	はい、読み取り専用	string	2014-01	イベントハブ用に作成されたパーティションの識別子。

応答コード

コード	説明
200	正常終了しました。
401	認証エラー。
500	内部エラーです。

応答本文

要求が成功した場合、照会した Event Hub の説明が応答本文に追加されます。要求が失敗すると、本文にエラーコードとエラーメッセージが追加されます。

使用例

Request

注意

また、「共通パラメーターとヘッダー」で説明されているように、Authorization ヘッダーに Azure Active Directory トークンを使用することもできます。たとえば、Authorization: Bearer <Azure AD token> のように指定します。

GET https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01 HTTP/1.1  
Authorization: SharedAccessSignature sr=your-namespace.servicebus.windows.net&sig=tYu8qdH563Pc96Lky0SFs5PhbGnljF7mLYQwCZmk9M0%3d&se=1403736877&skn=RootManageSharedAccessKey  
ContentType: application/atom+xml;type=entry;charset=utf-8  
Host: your-namespace.servicebus.windows.net

Response

HTTP/1.1 200 Created  
Transfer-Encoding: chunked  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Wed, 25 Jun 2014 22:43:27 GMT  
  
<entry xmlns="http://www.w3.org/2005/Atom">  
  <id>https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01</id>  
  <title type="text">your-event-hub</title>  
  <published>2014-06-25T22:43:16Z</published>  
  <updated>2014-06-25T22:43:27Z</updated>  
  <author>  
    <name>your-namespace</name>  
  </author>  
  <link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01"/>  
  <content type="application/xml">  
    <EventHubDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
      <SizeInBytes>0</SizeInBytes>  
      <MessageRetentionInDays>2</MessageRetentionInDays>  
      <AuthorizationRules></AuthorizationRules>  
      <Status>Active</Status>  
      <CreatedAt>2014-06-25T22:51:47.8656642</CreatedAt>  
      <UpdatedAt>2014-06-25T22:51:50.623Z</UpdatedAt>  
      <AccessedAt>0001-01-01T00:00:00Z</AccessedAt>  
      <PartitionCount>4</PartitionCount>  
      <EntityAvailabilityStatus>Available</EntityAvailabilityStatus>  
    </EventHubDescription>  
  </content>  
</entry>

次の方法で共有