エンティティの作成または更新

[アーティクル]
02/12/2024

メッセージングエンティティを作成または更新します。

Request

Method	要求 URI	HTTP バージョン
PUT	https://{serviceNamespace}.servicebus.windows.net/{Entity Path}	HTTP/1.1

エンティティパスには複数セグメント名を指定でき、セグメントは '/' で区切ります。パス全体がエンティティの名前を構成します。複数のエンティティで同じプレフィックスセグメントを共有できます。

要求ヘッダー

必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求ヘッダー	説明
承認	"管理" 権限を持つ Shared Access Signature (SAS) トークンを指定します。詳細については、「 Shared Access Signature を使用した Service Bus 認証」を参照してください。
Content-Type	application/atom+xml;type=entry;charset=utf-8 を設定します。
If-Match	エンティティを更新するには、このヘッダーを "*" に設定します。更新されるエンティティで必要なすべてのプロパティ値を指定する必要があります。指定されない値は、サービスの既定値に設定されます。更新要求時、このヘッダーが欠落している場合、このエンティティが既に存在することを示すエラーが返されます。

要求本文

要求の本文には、作成するエンティティの説明を埋め込む有効な Atom XML エントリが含まれている必要があります

<?xml version="1.0" encoding="utf-8" ?>  
<entry xmlns='http://www.w3.org/2005/Atom'>  
  <content type='application/xml'>  
    {description}  
  </content>  
</entry>

{description} は、最上位エンティティの Queue または Topic、または親エンティティに対するサブスクリプションまたはルールを記述しました。

たとえば、キューは要素で QueueDescription 記述されます。したがって、キューを作成または更新するための XML ペイロードは、次の形式になることがあります。したがって、省略されたすべてのプロパティは既定値と見なされます。

<?xml version="1.0" encoding="utf-8" ?>  
<entry xmlns="http://www.w3.org/2005/Atom">  
  <content type="application/xml">  
    <QueueDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
       <LockDuration>T1M</LockDuration>
    </QueueDescription>
  </content>  
</entry>

エンティティとそのパスとの関係の詳細については、「概要」を参照してください。

Response

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

応答コード

注意

特殊文字またはエンコードされた文字を含む名前でエンティティを更新する場合 (例: "test?Name=value&")。 "test%3FName%3Dvalue%26" にエンコードされます。(401) 未承認の例外が生成されます。

コード	説明
201	エンティティが更新。
400	要求本文が無効。
401	認証エラー。
403	クォータを超過。エンティティは更新されません。
500	内部エラーです。

状態コードの詳細については、「状態コードとエラーコード」を参照してください。

レスポンスヘッダー

[なし] :

応答本文

エンティティの説明が返されました。一部の説明プロパティには、PUT 要求に欠落していた場合に既定値が含まれている可能性があります。