Event Hub の更新

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

イベントハブを更新します。イベントハブを更新する場合は、ここに記載されているプロパティのみを変更できます。その他のプロパティを変更しようとすると、エラーが発生します。変更できるが指定されていないプロパティは、既定値に設定されます。

プロパティ

プロパティ名	次の API バージョン以降で利用可	Default	[プロパティの説明]
MessageRetentionInDays	2014-01	0	MessageRetentionInDays

Request

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

要求ヘッダー

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

追加の要求ヘッダー

要求ヘッダー	必須または省略可能	説明
If-Match	必須	イベントハブを更新するには、このヘッダーを "*" に設定します。更新されたイベントハブで必要なすべてのプロパティ値を指定する必要があります。指定されていない値は、サービスの既定値に設定されます。このヘッダーが見つからない場合、更新呼び出しは、このイベントハブが既に存在することを示すエラーを返します。

要求本文

Atom エントリの内容に説明を埋め込みます。例:

<entry xmlns='http://www.w3.org/2005/Atom'>  
  <content type='application/xml'>  
    {EventHubDescription}  
  </content>  
</entry>

[応答]

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

応答コード

コード	説明
200	正常終了しました。
400	無効な要求です。
401	認証エラー。
409	If-Match ヘッダーがないために競合が発生しました。
500	内部エラーです。

応答本文

要求が成功した場合、応答本文にはイベントハブの説明が含まれます。 PUT 要求にないプロパティは既定値で返されます。要求が成功しない場合、本文にはエラーコードとエラーメッセージが含まれます。

要素名	説明
`AuthorizationRules`	承認規則。
`MessageRetentionInDays`	このイベントハブのイベントを保持する日数。
`Status`	イベントハブの現在の状態 (有効または無効)。
`CreatedAt`	イベントハブが作成された正確な時刻。
`UpdatedAt`	イベントハブが更新された正確な時刻。
`PartitionCount`	イベントハブ上のパーティションの現在の数。
`PartitionIds`	イベントハブ用に作成されたパーティションの識別子。

使用例

Request

注意

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

PUT 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  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Host: your-namespace.servicebus.windows.net
If-Match: *
Content-Length: 264  
Expect: 100-continue  
Connection: Keep-Alive  
  
<entry xmlns='http://www.w3.org/2005/Atom'>  
  <content type='application/xml'>  
    <EventHubDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">  
      <MessageRetentionInDays>3</MessageRetentionInDays>  
    </EventHubDescription>  
  </content>  
</entry>

応答

HTTP/1.1 201 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">  
        <MessageRetentionInDays>3</MessageRetentionInDays>  
    </EventHubDescription>  
  </content>  
</entry>

次の方法で共有