Set Queue ACL

[アーティクル]
08/02/2022

Set Queue ACL 操作は、共有アクセス署名で使用できるキューの保存されているアクセスポリシーを設定します。詳細については、「保存されているアクセスポリシーの定義」を参照してください。

Note

Set Queue ACL 操作は、バージョン 2012-02-12 以降で使用できます。

Request

Set Queue ACL 要求の構成は次のとおりです。 HTTPS が推奨されます。 myaccount をストレージアカウントの名前に置き換えます。

Method	要求 URI	HTTP バージョン
`PUT`	`https://myaccount.queue.core.windows.net/myqueue?comp=acl`	HTTP/1.1

エミュレートされたストレージサービスの URI

エミューレートされたストレージサービスに対する要求では、エミュレーターのホスト名とキューサービスポートを 127.0.0.1:10001 と指定し、その後にエミューレートされたストレージアカウント名を指定します。

Method	要求 URI	HTTP バージョン
`PUT`	`http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=acl`	HTTP/1.1

詳細については、「Storage Emulator サービスと Azure Storage サービスの違い」を参照してください。

URI パラメーター

次の追加パラメーターを要求の URI で指定できます。

パラメーター	説明
`timeout`	省略可能。 `timeout` パラメーターは、秒単位で表されます。詳細については、「キューサービス操作のタイムアウトの設定」を参照してください。

要求ヘッダー

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

要求ヘッダー	説明
`Authorization`	必須。承認スキーム、アカウント名、署名を指定します。詳細については、「Azure Storage要求を承認する」を参照してください。
`Date` または `x-ms-date`	必須。要求に対して協定世界時 (UTC) を指定します。詳細については、「Azure Storage要求を承認する」を参照してください。
`x-ms-version`	省略可能。この要求に使用する操作のバージョンを指定します。詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
`x-ms-client-request-id`	省略可能。ストレージ分析ログが有効になっているときに分析ログに記録される 1 KiB 文字の制限を持つクライアント生成の不透明な値を提供します。クライアント側のアクティビティをサーバーが受信した要求と関連付けるには、このヘッダーを使用することが強く推奨されます。詳細については、「Storage Analyticsログ記録と Azure ログ記録: ログを使用したStorage要求の追跡」を参照してください。

要求本文

保存されているアクセスポリシーを指定するには、Set Queue ACL 操作の要求本文で一意識別子とアクセスポリシーを指定します。

SignedIdentifier 要素には、Id 要素で指定された一意識別子と、AccessPolicy 要素で指定されたアクセスポリシーの詳細が含まれます。一意識別子の最大長は 64 文字です。

フィールドは StartExpiry UTC 時刻で表され、有効な ISO 8061 形式に準拠している必要があります。サポートされている ISO 8061 形式は次のとおりです。

YYYY-MM-DD
YYYY-MM-DDThh:mmTZD
YYYY-MM-DDThh:mm:ssTZD
YYYY-MM-DDThh:mm:ss.ffffffTZD

これらの形式の日付部分では、YYYY は 4 桁の年表現、MM は 2 桁の月表現、DD は 2 桁の日付表現です。時間部分では、hh は 24 時間表記の時間表現、mm は 2 桁の分表現、ss は 2 桁の秒表現、ffffff は 6 桁のミリ秒表現です。時間指定子 T は文字列の日付部分と時間部分を分離し、タイムゾーン指定子 TZD はタイムゾーンを指定します。

<?xml version="1.0" encoding="utf-8"?>  
<SignedIdentifiers>  
  <SignedIdentifier>   
    <Id>unique-64-character-value</Id>  
    <AccessPolicy>  
      <Start>start-time</Start>  
      <Expiry>expiry-time</Expiry>  
      <Permission>abbreviated-permission-list</Permission>  
    </AccessPolicy>  
  </SignedIdentifier>  
</SignedIdentifiers>

要求のサンプル

Request Syntax:  
PUT https://myaccount.queue.core.windows.net/myqueue?comp=acl HTTP/1.1  
  
Request Headers:  
x-ms-version: 2012-02-12  
x-ms-date: Sun, 25 Sep 2011 00:42:49 GMT  
Authorization: SharedKey myaccount:V47F2tYLS29MmHPhiR8FyiCny9zO5De3kVSF0RYQHmo=  
  
Request Body:  
<?xml version="1.0" encoding="utf-8"?>  
<SignedIdentifiers>  
  <SignedIdentifier>   
    <Id>MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=</Id>  
    <AccessPolicy>  
      <Start>2009-09-28T08:49:37.0000000Z</Start>  
      <Expiry>2009-09-29T08:49:37.0000000Z</Expiry>  
      <Permission>raup</Permission>  
    </AccessPolicy>  
  </SignedIdentifier>  
</SignedIdentifiers>

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`	このヘッダーは、要求と対応する応答のトラブルシューティングに使用できます。このヘッダーの値は、要求に存在し、値が最大 1024 の ASCII 文字で表示される場合、ヘッダーの値 `x-ms-client-request-id` と等しくなります。ヘッダーが `x-ms-client-request-id` 要求に存在しない場合、このヘッダーは応答に存在しません。

応答のサンプル

Response Status:  
HTTP/1.1 204 No Content  
  
Response Headers:  
Transfer-Encoding: chunked  
Date: Sun, 25 Sep 2011 22:42:55 GMT  
x-ms-version: 2012-02-12  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0

承認

この操作を呼び出すことができるのはアカウント所有者のみです。

解説

特定のキュー内のリソースにアクセスできるのはアカウント所有者だけです。ただし、アカウント所有者がそのキュー内のリソースに対して共有アクセス署名を発行している場合を除きます。

キューのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。キューのアクセス許可を更新するには、 Get Queue ACL を呼び出してキューに関連付けられているすべてのアクセスポリシーをフェッチし、変更するアクセスポリシーを変更してから、完全なデータセットを呼び出 Set Queue ACL して更新を実行します。

保存されているアクセスポリシーの設定

保存されているアクセスポリシーでは、関連付けられている共有アクセス署名の開始時刻、有効期限、およびアクセス許可を指定できます。キューリソースへのアクセスを制御する方法に応じて、保存されているアクセスポリシー内でこれらのすべてのパラメーターを指定し、共有アクセス署名の URL からこれらを省略できます。これにより、関連付けられた署名の動作をいつでも変更または取り消しできます。また、保存されているアクセスポリシー内で 1 つ以上のアクセスポリシーパラメーターを指定し、残りのパラメーターを URL で指定することもできます。すべてのパラメーターを URL で指定することもできます。この場合、保存されているアクセスポリシーを使用して署名を取り消すことができますが、署名の動作を変更することはできません。アクセスポリシーの確立の詳細については、格納されているアクセスポリシーの定義に関するページを参照してください。

Shared Access Signature と格納されているアクセスポリシーを組み合わせて、署名を承認するために必要なすべてのフィールドを含める必要があります。必須フィールドが欠落している場合、要求は失敗します。同様に、共有アクセス署名の URL と保存されているアクセスポリシーの両方で同じフィールドが指定されている場合、ステータスコード 400 (Bad Request) が返されて要求は失敗します。

常に最大 5 つのアクセスポリシーを特定のキューに設定できます。 5 つを超えるアクセスポリシーが要求本文で渡された場合、サービスはステータスコード 400 (Bad Request) を返します。