重要
この API は廃止され、2021 年 11 月 1 日に廃止され、使用されなくなりました。
新しいサブスクリプションを作成します。 作成されると、サブスクリプション リソース マニフェストは変更できません。 この操作はべき等ではありません。 同じ名前のサブスクリプション (同じトピックと名前空間の下) が正常に作成された後に作成呼び出しを繰り返すと、409 競合エラー メッセージが表示されます。
特別な文字またはエンコードされた文字を含む名前のサブスクリプションを作成する場合 (例: "test?Name=value&"。"test%3FName%3Dvalue%26" にエンコードされ、(401) 不正な例外が生成されます。
次のサブスクリプション名の制限に注意してください。
文字、数字、ピリオド (.)、ハイフン (-)、アンダースコア (_) のみを含めることができます。
複数のセグメントは使用できません。
スラッシュ (/) は、サブスクリプション名のプレフィックスまたはサフィックスとして使用できません。
最大文字数は 50 字です。
Request
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| PUT | https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/Topics/Subscriptions/{Subscription Name} | HTTP/1.1 |
要求ヘッダー
必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
| Content-Type | application/xml;type=entry;charset=utf-8 |
| 名前空間 | 管理エンドポイントの url |
| x-ms-version | 2012-03-01 |
要求には、クライアント証明書も必要です。 この証明書は、特定のサブスクリプション用にアップロードした証明書に一致する必要があります。
要求本文
次の表では、要求本文の主要な要素について説明します。
| プロパティ名 | Type | 説明 |
|---|---|---|
| DefaultMessageTimeToLive | XML Datetime | 配信不能が有効になっているかどうかに基づいて、メッセージが指定された時間を超えてトピックに格納されている場合、配信不能キューに自動的に移動されるか、削除されます。 メッセージの TTL がトピックに設定された TTL より小さい場合、この値はメッセージに指定された TTL によって上書きされます。 トピックが作成された後、この値は変更不可になります。 - 範囲: 1 秒から 14 日。 - 既定値: 14 日。 |
| LockDuration | XML Datetime | この設定により、受信者による処理のためにメッセージをロックする時間 (秒単位) が決まります。 この時間の後、メッセージはロック解除され、次の受信者による消費が可能になります。 トピック作成時にのみ設定可能: - 範囲: 0 から 5 分。0 は、メッセージがロックされていないことを意味します。 - 既定値: 30 秒。 |
| RequiresSession | Boolean | トピックの作成時にのみ設定可能です。 に設定すると true、トピックはセッション対応であり、サポートされているだけです SessionReceiver 。 セッション対応のトピックは、REST ではサポートされていません。- 既定値: False。 |
| EnableDeadLetteringOnMessageExpiration | ブール値 | サブスクリプション作成時にのみ設定可能です。 - 既定値: False。 このフィールドは、有効期限が切れた TTL を持つメッセージを Service Bus が処理する方法を決定します。 メッセージの有効期限が切れた場合 true 、Service Bus はメッセージをトピックからそのトピックの配信不能サブキューに移動します。 の場合 false、メッセージはトピックから完全に削除されます。 |
| DeadLetteringOnFilterEvaluationExceptions | サブスクリプション フィルターの評価中に例外を引き起こすメッセージを Service Bus が処理する方法を決定します。 の場合 true、例外の原因となったメッセージはサブスクリプションの配信不能キューに移動されます。 それ以外の場合は破棄されます。 既定では、このパラメーターが true に設定されている場合、例外の原因を調べることができます。 不正な形式のメッセージや、メッセージの形式に関するフィルターで不適切な想定が行われた場合に発生する可能性があります。 トピックの作成時にのみ設定可能です。- 既定値: true |
|
| EnableBatchedOperations | 特定のキューに操作を実行しているときに、サービス側のバッチ動作を有効または無効にします。 有効にすると、Service Bus はバックエンドに対して複数の操作を収集またはバッチ処理し、接続の効率を高めます。 操作の待機時間を短くしたい場合は、この機能を無効にすることができます。 既定値: false |
|
| MaxDeliveryCount | 符号なし整数 | メッセージが配信不能または破棄されるまでに Service Bus がメッセージの配信を試行する最大回数。 - 既定値: 10 |
| MessageCount | 符号なし整数 | 監視システムによって報告されるように、まだデキューされていないサブスクリプション内のメッセージの数を報告します。 |
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
応答コード
注意
特別な文字またはエンコードされた文字 (たとえば、 にエンコードされる) を含む名前を持つ名前空間をtest%3FName%3Dvalue%26作成すると、test?Name=value&(401) Unauthorized 例外が生成されます。
| コード | 説明 |
|---|---|
| 201 | サブスクリプションが正常に作成されました。 |
| 400 | 要求本文が無効。 |
| 401 | 認証エラー。 |
| 403 | クォータを超過。サブスクリプションは作成されません。 |
| 409 | 指定されたサブスクリプションは既に存在します (または指定されたパスが既に使用されています)。 |
| 500 | 内部エラーです。 |
状態コードの詳細については、「 状態コードとエラー コード」を参照してください。
レスポンス ヘッダー
[なし] :
応答本文
PUT 要求でサブスクリプションのすべての属性の値が指定されていない場合、一部の description プロパティには既定値を含めることができるため、サブスクリプションの説明が返されます。