Set Queue Service Properties

[アーティクル]
06/27/2023

この操作ではSet Queue Service Properties、ストレージアカウントの Queue サービスエンドポイントのプロパティ (Storage Analyticsおよびクロスオリジンリソース共有 (CORS) ルールのプロパティを含む) が設定されます。 CORS ルールの詳細については、「ストレージサービスの CORS サポート」を参照してください。

要求

要求は Set Queue Service Properties 次のように指定できます。 HTTPS を使用することをお勧めします。 account-name をストレージアカウントの名前に置き換えます。

Method	要求 URI	HTTP バージョン
PUT	`https://account-name.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

注意

URI のパスとクエリ部分からホスト名を分離するには、URI には常にスラッシュ文字 (/) を含める必要があります。この操作では、URI のパス部分が空です。

URI パラメーター

パラメーター	説明
`restype=service&comp=properties`	必須。 Azure Storage サービスのプロパティを設定するには、両方のクエリ文字列の組み合わせが必要です。
`timeout`	省略可能。 `timeout` パラメーターは、秒単位で表されます。詳細については、「キューサービス操作のタイムアウトを設定する」を参照してください。

要求ヘッダー

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

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

要求本文

バージョン 2012-02-12 以前では、要求本文の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

バージョン 2013-08-15 以降では、要求本文の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-seperated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

バージョン 2013-08-15 以降では、要求本文で指定された 1 つ以上のルート要素を使用してを呼び出 Set Queue Service Properties すことができます。ルート要素は次のとおりです。

Logging
HourMetrics
MinuteMetrics
Cors

要求のすべてのルート要素を指定する必要はなくなりました。ルート要素を省略した場合、その機能に対応したサービスの既存の設定が維持されます。ただし、指定したルート要素を指定する場合は、その要素のすべての子要素を指定する必要があります。

要求本文の要素を次の表に示します。

要素名	説明
Logging	バージョン 2013-08-15 以降は省略可能。それよりも前のバージョンでは必須です。 Storage Analyticsログ設定をグループにします。
Metrics	バージョン 2012-02-12 以前では必須です。バージョン 2013-08-15 以降には適用されません。 Storage Analyticsメトリック設定をグループにします。 Metrics 設定によって、キューの 1 時間ごとの集計で API 別にグループ化された要求の統計に関する概要が示されます。
HourMetrics	バージョン 2013-08-15 以降では省略可能です。以前のバージョンには適用されません。 Storage Analytics HourMetrics 設定をグループにします。 HourMetrics 設定によって、キューの 1 時間ごとの集計で API 別にグループ化された要求の統計に関する概要が示されます。
MinuteMetrics	バージョン 2013-08-15 以降では省略可能です。以前のバージョンには適用されません。 Storage Analytics MinuteMetrics 設定をグループにします。 MinuteMetrics 設定によって、キューの分単位の要求の統計が示されます。 2013-08-15 より前のバージョンの場合、 MinuteMetrics は応答本文に含まれません。
Version	ログ、メトリック、HourMetrics、または MinuteMetrics の設定が指定されている場合は必須です。構成する Storage Analytics のバージョン。
削除	ログ、メトリック、HourMetrics、または MinuteMetrics の設定が指定されている場合は必須です。ログ構成にのみ適用されます。すべての削除要求をログに記録するかどうかを示します。
読み取り	ログ、メトリック、HourMetrics、または MinuteMetrics の設定が指定されている場合は必須です。ログ構成にのみ適用されます。すべての読み取り要求をログに記録するかどうかを示します。
書き込み	ログ、メトリック、HourMetrics、または MinuteMetrics の設定が指定されている場合は必須です。ログ構成にのみ適用されます。すべての書き込み要求をログに記録するかどうかを示します。
有効	必須。キューサービスに対してメトリックが有効であるかどうかを示します。読み取りアクセスの地理冗長レプリケーションが有効である場合、プライマリメトリックとセカンダリメトリックの両方が収集されます。読み取りアクセス geo 冗長レプリケーションが有効になっていない場合は、プライマリメトリックのみが収集されます。
IncludeAPIs	メトリックが有効な場合のみ必須です。メトリック構成にのみ適用されます。メトリックで、呼び出された API 操作の概要統計情報を生成するかどうかを示します。
RetentionPolicy/Enabled	必須。ストレージサービスに対して保持ポリシーが有効であるかどうかを示します。
RetentionPolicy/Days	保持ポリシーが有効な場合のみ必須です。メトリックまたはログデータを保持する日数を示します。この値より古いデータはすべて削除されます。指定できる最小値はで `1`、最大値は `365` (1 年) です。
Cors	省略可能。 Cors 要素は、バージョン 2013-08-15 以降でサポートされています。すべての CORS ルールをグループ化します。この要素グループを省略しても、既存の CORS 設定は上書きされません。
CorsRule	省略可能。キューサービスの CORS ルールを指定します。要求には、最大 5 つの CorsRule 要素を含めることができます。要求本文に CorsRule 要素が含まれていない場合、すべての CORS ルールが削除され、キューサービスに対して CORS が無効になります。
AllowedOrigins	CorsRule 要素が存在する場合は必須です。 CORS または "" を使用して許可される元のドメインのコンマ区切りのリストです ("" はすべてのドメインを許可します)。配信元ドメインには、ドメインのすべてのサブドメインに対する CORS 経由の要求を許可するワイルドカード文字がサブドメインに含まれる場合もあります。元のドメインは 64 個までに限定されています。許可される元のドメインのそれぞれは、最大 256 文字で指定できます。
ExposedHeaders	CorsRule 要素が存在する場合は必須です。 CORS クライアントに公開されている応答ヘッダーのコンマ区切りのリストです。定義済みのヘッダーは 64 個まで、プレフィックスが指定されたヘッダーは 2 個までに制限されています。各ヘッダーには、最大 256 文字を含めることができます。
MaxAgeInSeconds	CorsRule 要素が存在する場合は必須です。クライアント/ブラウザーがプレフライト応答をキャッシュする秒数。
AllowedHeaders	CorsRule 要素が存在する場合は必須です。クロスオリジン要求の一部として許可されるヘッダーのコンマ区切りのリストです。定義済みのヘッダーは 64 個まで、プレフィックスが指定されたヘッダーは 2 個までに制限されています。各ヘッダーには、最大 256 文字を含めることができます。
AllowedMethods	CorsRule 要素が存在する場合は必須です。元のドメインによる実行が許可される HTTP メソッドのコンマ区切りのリストです。 Azure Storage の場合、許可されるメソッドは`DELETE`、、、`GET`、`HEAD`、`MERGE`、`POSTOPTIONS`、またはです`PUT`。

[応答]

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

状態コード

操作が正常に終了すると、ステータスコード 202 (Accepted) が返されます。

応答ヘッダー

この操作の応答には、次のヘッダーが含まれています。応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。

応答ヘッダー	説明
`x-ms-request-id`	サービスに対して行われた要求を一意に識別します。
`x-ms-version`	応答に使用された操作のバージョンを指定します。詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
`x-ms-client-request-id`	要求と対応する応答のトラブルシューティングに使用できます。このヘッダーの値は、要求に存在し、その値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値 `x-ms-client-request-id` と等しくなります。ヘッダーが `x-ms-client-request-id` 要求に存在しない場合、応答には存在しません。

応答本文

なし。

承認

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

注釈

次の制約事項と制限事項は、Azure Storage の CORS ルールに適用されます。

最大 5 つのルールを格納できます。
XML タグを除く要求のすべての CORS ルール設定の最大サイズは、2 KiB を超えないようにしてください。
許可されるヘッダー、公開されるヘッダー、許可される元のドメインの長さは、256 文字を超えることはできません。
許可されるヘッダーと公開されるヘッダーは、次のいずれかになります。
- リテラルヘッダー。x-ms-meta-processed などの正確なヘッダー名を指定します。最大 64 個のリテラルヘッダーを要求で指定できます。
- プレフィックスが指定されたヘッダー。x-ms-meta-data* などのヘッダーのプレフィックスを指定します。この方法でプレフィックスを指定すると、指定したプレフィックスで始まるヘッダーが許可または公開されます。最大 2 個のプレフィックスが指定されたヘッダーを要求で指定できます。
要素で AllowedMethods 指定されたメソッド (または HTTP 動詞) は、Azure Storage サービス API でサポートされているメソッドに準拠している必要があります。サポートされているメソッドは、DELETE、、GET、、MERGEHEAD、POST、OPTIONSおよび PUTです。

要求での CORS ルールの指定は、省略できます。要求本文で Cors 要素を指定せずにを呼び出Set Queue Service Propertiesすと、既存の CORS 規則が維持されます。

CORS を無効にするには、空の CORS ルール設定 (つまり、*</Cors>) を使用してを呼び出し、内部 CORS ルールは呼び出Set Queue Service Propertiesしません。この呼び出しにより、既存のルールが削除され、Queue サービスの CORS が無効になります。

CorsRule 要素が指定されている場合は、すべての CORS ルール要素が必要です。要素がない場合、要求はエラーコード 400 (Bad Request) で失敗します。

バージョン 2013-08-15 の時点では、XML 設定要素は省略可能であるため、更新された要素のみを含む XML を送信することで、特定の要素を更新できます。その他の設定は影響を受けません。

CORS ルールと評価ロジックの詳細については、「 Azure Storage サービスの CORS サポート」を参照してください。

要求と応答の例

次のサンプル URI は、 myaccount という名前の架空のストレージアカウントの Queue サービスプロパティを変更する要求を行います。

PUT https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

要求は次のヘッダーと共に送信されます。

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:28:19 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

要求は次の XML 本文と共に送信されます。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins> http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

要求が送信された後、次の応答が返されます。

HTTP/1.1 202 Accepted  
Connection: Keep-Alive  
Transfer-Encoding: chunked  
Date: Wed, 23 Oct 2013 04:28:20 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

次の方法で共有