Set File Service Properties
この操作では Set File Service Properties 、FileREST API を使用して File Service リソースのプロパティを設定します。 この API は完全にサポートされていますが、レガシ管理 API です。 代わりに、Azure Storage リソース プロバイダー (Microsoft.Storage) によって提供される File Services - Set Service Properties を使用することをお勧めします。 Azure Storage リソース プロバイダーを使用してファイル サービス リソースをプログラムで操作する方法の詳細については、「 ファイル サービスに対する操作」を参照してください。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用可能 |
|---|---|
| SMB |  |
| NFS | |
要求
要求は Set File Service Properties 次のように指定できます。 HTTPS を使用することをお勧めします。 account-name をストレージ アカウントの名前に置き換えます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| PUT | https://account-name.file.core.windows.net/?restype=service&comp=properties |
HTTP/1.1 |
注意
URI のパスとクエリ部分からホスト名を分離するには、URI には常にスラッシュ文字 (/) を含める必要があります。 この操作では、URI のパス部分が空です。
URI パラメーター
| URI パラメーター | 説明 |
|---|---|
restype=service&comp=properties |
必須。 ストレージ サービス プロパティを設定するには、両方のクエリ文字列を組み合わせる必要があります。 |
timeout |
省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「 ファイル サービス操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
Authorization |
必須。 承認スキーム、ストレージ アカウント名、および署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date or x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 この操作は、バージョン 2015-02-21 以降でのみ使用できます。 ファイル サービスのメトリックを有効にするには、バージョン 2015-04-05 以降を指定する必要があります。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-client-request-id |
省略可能。 ログ記録の構成時にStorage Analytics ログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。 |
要求本文
バージョン 2020-02-10 の要求本文の形式は次のとおりです。
<?xml version="1.0" encoding="utf-8"?>
<StorageServiceProperties>
<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>
<ShareDeleteRetentionPolicy>
<Enabled>true|false</Enabled>
<Days>integer-value</Days>
</ShareDeleteRetentionPolicy>
<ProtocolSettings>
<SMB>
<Multichannel>
<Enabled>true|false</Enabled>
</Multichannel>
<Versions>comma-separated-list-of-smb-versions</Versions>
<AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
<KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
<ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
</SMB>
</ProtocolSettings>
</StorageServiceProperties>
要求のすべてのルート要素を指定する必要はありません。 ルート要素を省略した場合、その機能に対応したサービスの既存の設定が維持されます。 ただし、特定のルート要素を指定する場合は、その要素のすべての子要素を指定する必要があります。 ルート要素は次のとおりです。
HourMetricsMinuteMetricsCorsProtocolSettings
要求本文の要素を次の表に示します。
| 名前 | 説明 |
|---|---|
HourMetrics |
バージョン 2015-04-05 以降では省略可能です。 以前のバージョンには適用されません。 Storage AnalyticsHourMetrics設定をグループ化します。これにより、API ごとに 1 時間ごとの集計でグループ化された要求統計の概要が提供されます。 |
MinuteMetrics |
バージョン 2015-04-05 以降では省略可能です。 以前のバージョンには適用されません。 各分の要求統計を提供するStorage AnalyticsMinuteMetrics設定をグループにします。 |
Version |
メトリックが有効になっている場合は必須。 構成する Storage Analytics のバージョン。 この値には を使用 1.0 します。 |
Enabled |
必須。 ファイル サービスに対してメトリックが有効になっているかどうかを示します。 |
IncludeAPIs |
メトリックが有効な場合のみ必須です。 メトリックで、呼び出された API 操作の概要統計情報を生成するかどうかを示します。 |
RetentionPolicy/Enabled |
必須。 ファイル サービスに対してアイテム保持ポリシーが有効になっているかどうかを示します。 false の場合、メトリック データは保持され、ユーザーはそのデータを削除する責任があります。 |
RetentionPolicy/Days |
保持ポリシーが有効な場合のみ必須です。 メトリック データを保持する必要がある日数を示します。 この値より古いデータはすべて削除されます。 指定できる最小値は で 1、最大値は 365 (1 年) です。 メトリック データは、保持期間の有効期限が切れた後、ベスト エフォートベースで削除されます。 |
Cors |
省略可能。 要素は Cors 、バージョン 2015-02-21 以降でサポートされています。 すべてのクロスオリジン リソース共有 (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 Filesの場合、許可されるメソッドはDELETE、、、GET、HEAD、MERGE、POSTOPTIONS、および PUTです。 |
ShareDeleteRetentionPolicy |
省略可能。 このストレージ アカウント内の Azure ファイル共有の論理的な削除プロパティ。 |
Days |
省略可能。 Azure ファイル共有を保持する (論理的に削除される) 日数を示します。 指定できる最小値は で 1、最大値は 365 (1 年) です。 |
Enabled |
省略可能。 ストレージ アカウントで、Azure Filesに対して論理的な削除が有効になっているかどうかを示します。 |
ProtocolSettings |
省略可能。 ファイル システム プロトコルの設定をグループ化します。 |
SMB |
省略可能。 SMB の設定をグループにします。 |
Multichannel |
省略可能。 SMB マルチチャネルの設定が含まれます。 SMB マルチチャネルには、SMB マルチチャネルの Enabled 状態を切り替える Boolean プロパティが含まれています。 |
Version |
バージョン 2020-04-08 以降は省略可能。 許可される SMB バージョンのコンマ区切りの一覧。 使用できる値は、SMB2.1、SMB3.0、および SMB3.1.1 です。 |
AuthenticationMethods |
バージョン 2020-04-08 以降は省略可能。 許可される認証方法のコンマ区切りの一覧。 使用できる値は NTLMv2 と Kerberos です。 |
KerberosTicketEncryption |
バージョン 2020-04-08 以降は省略可能。 許可される Kerberos チケット暗号化アルゴリズムのコンマ区切りの一覧。 使用できる値は RC4-HMAC と AES-256 です。 |
ChannelEncryption |
バージョン 2020-04-08 以降は省略可能。 許可される SMB チャネル暗号化プロトコルのコンマ区切りの一覧。 使用できる値は、AES-128-CCM、AES-128-GCM、および AES-256-GCM です。 |
[応答]
応答には、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 Filesの 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 File Service Properties すと、既存の CORS 規則が維持されます。
CORS を無効にするには、空の CORS 規則設定 (つまり) を使用して を呼び出し、</Cors>内部 CORS 規則は呼び出Set File Service Propertiesしません。 この呼び出しにより、既存のルールが削除され、ファイル サービスの CORS が無効になります。
CorsRule 要素が指定されている場合は、すべての CORS ルール要素が必要になります。 要素がない場合、要求はエラー コード 400 (Bad Request) で失敗します。
CORS ルールと評価ロジックの詳細については、「 Azure Storage サービスのクロスオリジン リソース共有のサポート」を参照してください。
要求と応答の例
次のサンプル URI は、 myaccount という名前のストレージ アカウントのファイル サービス プロパティを変更する要求を行います。
PUT https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1
要求は次のヘッダーと共に送信されます。
x-ms-version: 2020-02-10
x-ms-date: <date>
Authorization: SharedKey myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=
Host: myaccount.file.core.windows.net
要求は次の XML 本文と共に送信されます。
<?xml version="1.0" encoding="utf-8"?>
<StorageServiceProperties>
<HourMetrics>
<Version>1.0</Version>
<Enabled>true</Enabled>
<IncludeAPIs>false</IncludeAPIs>
<RetentionPolicy>
<Enabled>true</Enabled>
<Days>7</Days>
</RetentionPolicy>
</HourMetrics>
<MinuteMetrics>
<Version>1.0</Version>
<Enabled>true</Enabled>
<IncludeAPIs>true</IncludeAPIs>
<RetentionPolicy>
<Enabled>true</Enabled>
<Days>7</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>
<ShareDeleteRetentionPolicy>
<Enabled>true</Enabled>
<Days>7</Days>
</ShareDeleteRetentionPolicy>
<ProtocolSettings>
<SMB>
<Multichannel>
<Enabled>true</Enabled>
</Multichannel>
<Versions>SMB3.1.1</Versions>
<AuthenticationMethods>Kerberos</AuthenticationMethods>
<KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
<ChannelEncryption>AES-256-GCM</ChannelEncryption>
</SMB>
</ProtocolSettings>
</StorageServiceProperties>
要求が送信された後、次の応答が返されます。
HTTP/1.1 202 Accepted
Connection: Keep-Alive
Transfer-Encoding: chunked
Date: <date>
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30
x-ms-version: 2015-04-05
関連項目
CORS ルールと評価ロジックの詳細については、「 Azure Storage サービスのクロスオリジン リソース共有のサポート」を参照してください。
Storage Analyticsの詳細については、「Storage Analytics」を参照してください。