Set File Service Properties操作では、FileREST API を使用して File Service リソースのプロパティを設定します。 この API は完全にサポートされていますが、レガシ管理 API です。 代わりに、Azure Storage リソース プロバイダー (Microsoft.Storage) によって提供される File Services - Set Service Properties を使用することをお勧めします。 Azure Storage リソース プロバイダーを使用してファイル サービス リソースをプログラムで操作する方法の詳細については、「 ファイル サービスに対する操作」を参照してください。
プロトコルの可用性
| 有効なファイル共有プロトコル | 在庫有り |
|---|---|
| 中小企業 |
|
| ネットワークファイルシステム（NFS） |
|
リクエスト
Set File Service Properties要求は次のように指定できます。 HTTPS を使用することをお勧めします。
アカウント名をストレージ アカウントの名前に置き換えます。
| メソッド | URI リクエスト | HTTP バージョン |
|---|---|---|
| 配置する | 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 ファイルを監視する」をご覧ください。 |
リクエストの本文
バージョン 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-separated-list-of-response-headers</ExposedHeaders>
<AllowedHeaders>comma-separated-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>semicolon-separated-list-of-smb-versions</Versions>
<AuthenticationMethods>semicolon-separated-list-of-auth-methods</AuthenticationMethod>
<KerberosTicketEncryption>semicolon-separated-list-of-kerberos-encryption-algorithms</KerberosTicketEncryption>
<ChannelEncryption>semicolon-separated-list-of-smb-channel-encryption-algorithms</ChannelEncryption>
</SMB>
</ProtocolSettings>
</StorageServiceProperties>
要求のすべてのルート要素を指定する必要はありません。 ルート要素を省略した場合、その機能のサービスの既存の設定は保持されます。 ただし、特定のルート要素を指定する場合は、その要素のすべての子要素を指定する必要があります。 ルート要素には次のものが含まれます。
HourMetricsMinuteMetricsCorsProtocolSettings
要求本文の要素を次の表に示します。
| 名前 | 説明 |
|---|---|
HourMetrics |
バージョン 2015-04-05 以降では省略可能です。 以前のバージョンには適用されません。 Storage Analytics HourMetrics 設定をグループ化します。この設定では、API ごとにグループ化された要求統計の概要が時間単位で集計されます。 |
MinuteMetrics |
バージョン 2015-04-05 以降では省略可能です。 以前のバージョンには適用されません。 Storage Analytics MinuteMetrics 設定をグループ化します。この設定により、1 分ごとに要求の統計情報が提供されます。 |
Version |
メトリックが有効な場合は必須。 構成する Storage Analytics のバージョン。 この値には 1.0 を使用します。 |
Enabled |
必須。 File サービスに対してメトリックが有効になっているかどうかを示します。 |
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、 POST、 OPTIONS、および PUTです。 |
ShareDeleteRetentionPolicy |
任意。 このストレージ アカウント内の Azure ファイル共有の論理的な削除プロパティ。 |
Days |
任意。 Azure ファイル共有を保持する (論理的に削除される) 日数を示します。 指定できる最小値は 1で、最大値は 365 (1 年) です。 |
Enabled |
任意。 ストレージ アカウントで Azure Files に対して論理的な削除が有効になっているかどうかを示します。 |
ProtocolSettings |
任意。 ファイル システム プロトコルの設定をグループ化します。 |
SMB |
任意。 SMB の設定をグループにします。 |
Multichannel |
任意。 SMB マルチチャネルの設定が含まれています。 SMB マルチチャネルには、SMB マルチチャネルの状態を切り替える Enabled ブール型プロパティが含まれています。 |
Versions |
バージョン 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 つのルールを格納できます。
要求のすべての CORS ルール設定の最大サイズ (XML タグを除く) は、2 KiB を超えないようにしてください。
許可されるヘッダー、公開されたヘッダー、または許可される配信元の長さは、256 文字を超えないようにしてください。
許可されるヘッダーと公開されるヘッダーは、次のいずれかになります。
x-ms-meta-processedなど、正確なヘッダー名が指定されているリテラル ヘッダー。 要求では、最大 64 個のリテラル ヘッダーを指定できます。プレフィックス付きヘッダー。ヘッダーのプレフィックスが提供されます (
x-ms-meta-data*など)。 この方法でプレフィックスを指定すると、そのプレフィックスで始まるヘッダーが許可または公開されます。 要求では、プレフィックス付きヘッダーを最大 2 つ指定できます。
AllowedMethods要素で指定されるメソッド (または HTTP 動詞) は、Azure Storage サービス API でサポートされているメソッドに準拠している必要があります。 サポートされているメソッドは、DELETE、GET、HEAD、MERGE、POST、OPTIONS、およびPUTです。
要求に対する CORS 規則の指定は省略可能です。 要求本文で CORS 要素を指定せずに Set File Service Properties を呼び出すと、既存の CORS 規則が維持されます。
CORS を無効にするには、空の CORS 規則設定 (つまり、</Cors>) を使用してSet File Service Propertiesを呼び出し、内部 CORS 規則は呼び出しません。 この呼び出しは、既存の規則をすべて削除し、File サービスの CORS を無効にします。
CorsRule要素が指定されている場合は、すべての CORS ルール要素が必要です。 要素がない場合、要求はエラー コード 400 (無効な要求) で失敗します。
CORS ルールと評価ロジックの詳細については、 Azure Storage サービスのクロスオリジン リソース共有のサポートに関するページを参照してください。
要求と応答の例
次のサンプル URI は、 myaccount という名前のストレージ アカウントの File サービス プロパティを変更する要求を行います。
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」を参照してください。