Set Queue Metadata
Set Queue Metadata 操作は、ユーザー定義のメタデータを指定したキューに設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。
要求
要求は Set Queue Metadata 次のように構築できます。 HTTPS を使用することをお勧めします。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
https://myaccount.queue.core.windows.net/myqueue?comp=metadata |
HTTP/1.1 |
エミュレートされたストレージ サービス要求
エミュレートされたストレージ サービスに対して要求を行う場合は、エミュレーターのホスト名とキュー サービス ポートを として 127.0.0.1:10001指定し、その後にエミュレートされたストレージ アカウント名を指定します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=metadata |
HTTP/1.1 |
詳細については、ローカルでの Azure Storage の開発に Azurite エミュレーターを使用する方法に関するページを参照してください。
URI パラメーター
次の追加パラメーターを要求 URI に指定できます。
| パラメーター | 説明 |
|---|---|
timeout |
省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「 キュー サービス操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
省略可能。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-meta-name:string-value |
省略可能。 キューにメタデータとして関連付ける名前と値のペアを指定します。 この操作を呼び出すと、その都度、キューに関連付けられている既存のメタデータがすべて置き換えられます。 すべてのメタデータをキューから削除するには、この操作をメタデータ ヘッダーなしで呼び出します。 注: バージョン 2009-09-19 の時点で、メタデータ名は C# 識別子の名前付け規則に従う必要があります。 |
x-ms-client-request-id |
省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「 Azure Queue Storage の監視」を参照してください。 |
要求本文
なし。
要求のサンプル
Request Syntax:
PUT https://myaccount.queue.core.windows.net/myqueue?comp=metadata HTTP/1.1
Request Headers:
x-ms-version: 2011-08-18
x-ms-date: Fri, 16 Sep 2011 01:47:14 GMT
x-ms-meta-meta-sample1: sample1
x-ms-meta-meta-sample2: sample2
Authorization: SharedKey myaccount:u6PSIebDltGW5xHpO77epRpiUhcsTkWMvcM4GTmfqqA=
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
状態コード
操作が正常に終了すると、ステータス コード 204 (No Content) が返されます。
状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 説明 |
|---|---|
x-ms-request-id |
行われた要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されたキュー サービスのバージョンを示します。 このヘッダーは、バージョン 2009-09-19 以降に対して行われた要求に対して返されます。 |
Date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-client-request-id |
このヘッダーは、要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値 x-ms-client-request-id は、要求に存在し、値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値と同じです。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、応答には存在しません。 |
応答本文
なし。
承認
この操作を呼び出すことができるのはアカウント所有者のみです。
注釈
キューのメタデータを削除するには、メタデータのヘッダーを指定することなく Set Queue Metadata を呼び出します。