Set File Service Properties

この Set File Service Properties 操作では FileService 、FileREST API を使用してリソースのプロパティを設定します。 この API は完全にサポートされていますが、これはレガシ管理 API です。 代わりに、File Services - Set Service Properties provided by the storage resource provider (Microsoft.Storage) を使用することをお勧めします。 ストレージ リソース プロバイダーを使用してプログラムでリソースを操作する方法の詳細については FileService 、「FileService での操作」を参照してください

プロトコルの可用性

有効なファイル共有プロトコル 利用可能
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 省略可能。 ストレージ分析ログが有効になっている場合に分析ログに記録される 1 KiB 文字制限を持つ、クライアントによって生成された非透過的な値を提供します。 クライアント側のアクティビティをサーバーが受信した要求と関連付けるには、このヘッダーを使用することが強く推奨されます。 詳細については、「Azure Blob Storage の監視」を参照してください

[要求本文]

バージョン 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>  
  

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

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

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

名前 説明
HourMetrics バージョン 2015-04-05 以降の場合は省略可能。以前のバージョンには適用できません。 分析のStorageグループ HourMetrics を設定します。 この設定では、API 別に 1 時間の集計でグループ化された要求 HourMetrics 統計情報の概要が提供されます。
MinuteMetrics バージョン 2015-04-05 以降の場合は省略可能。以前のバージョンには適用できません。 Azure Analytics の MinuteMetrics 設定をグループ化します。 設定 MinuteMetrics では、1 分ごとに要求統計が提供されます。
Version メトリックが有効になっている場合は必須です。 構成する Storage Analytics のバージョン。 この値には "1.0" を使用します。
Enabled 必須。 ファイル サービスに対してメトリックが有効かどうかを示します。
IncludeAPIs メトリックが有効な場合のみ必須です。 メトリックで、呼び出された API 操作の概要統計情報を生成するかどうかを示します。
RetentionPolicy/Enabled 必須。 ファイル サービスに対して保持ポリシーが有効かどうかを示します。 false の場合、メトリック データは保持され、ユーザーは削除の責任を負います。
RetentionPolicy/Days 保持ポリシーが有効な場合のみ必須です。 メトリック データを保持する日数を示します。 この値より古いデータは、すべて削除されます。 指定できる最小値は 1、最大値は 365 (1 年) です。 メトリック データは、保持期間の有効期限が切れた後、ベスト労力で削除されます。
Cors 省略可能。 Cors 要素は、バージョン 21.02.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 Files の場合、許可されるメソッドは、DELETE、GET、HEAD、MERGE、POST、OPTIONS、PUT です。
ShareDeleteRetentionPolicy 省略可能。 このストレージアカウント内の Azure ファイル共有の論理的な削除プロパティ。
Days 省略可能。 Azure ファイル共有を保持する日数 (論理的に削除) を示します。 指定できる最小値は1で、最大値は365です。
Enabled 省略可能。 ストレージアカウントの Azure Files に対して論理的な削除が有効になっているかどうか。
ProtocolSettings 省略可能。 ファイルシステムプロトコルの設定をグループ化します。
SMB 省略可能。 SMB の設定をグループ化します。
Multichannel 省略可能。 SMB マルチチャネルの設定が含まれます。 SMB マルチチャネルには、 Enabled smb マルチチャネルの状態を切り替えるブール型プロパティが含まれています。
Version 省略可能。から開始 2020-04-08 します。 許可される SMB バージョンのコンマ区切りの一覧。 許可値: SMB2.1SMB3.0SMB3.1.1
AuthenticationMethods 省略可能。から開始 2020-04-08 します。 許可されている認証方法のコンマ区切りの一覧。 使用できる値: NTLMv2Kerberos
KerberosTicketEncryption 省略可能。から開始 2020-04-08 します。 許可されている Kerberos チケット暗号化アルゴリズムのコンマ区切りの一覧。 使用できる値: RC4-HMACAES-256
ChannelEncryption 省略可能。から開始 2020-04-08 します。 許可される SMB チャネル暗号化プロトコルのコンマ区切りの一覧。 許可値: AES-128-CCMAES-128-GCMAES-256-GCM

[応答]

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

status code

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

応答ヘッダー

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

応答ヘッダー 説明
x-ms-request-id サービスに対して行われた要求を一意に識別する値。
x-ms-version 要求に対して使用される操作のバージョンを指定します。 詳細については、「 Azure Storage サービスのバージョン管理」を参照してください。
x-ms-client-request-id このヘッダーを使用して、要求および対応する応答のトラブルシューティングを行うことができます。 このヘッダーの値は、要求内に存在する場合はヘッダーの値と同じで、 x-ms-client-request-id 値は最大で1024の表示可能な ASCII 文字になります。 x-ms-client-request-idヘッダーが要求内に存在しない場合、このヘッダーは応答に存在しません。

応答本文

なし。

承認

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

Remarks

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

  • 最大 5 つのルールを格納できます。

  • XML タグを除く、要求のすべての CORS ルール設定の最大サイズは、2つの KiB を超えることはできません。

  • 許可されるヘッダー、公開されるヘッダー、許可される元のドメインの長さは、256 文字を超えることはできません。

  • 許可されるヘッダーと公開されるヘッダーとして、次のいずれかを使用できます。

    • リテラル ヘッダー。x-ms-meta-processed などの正確なヘッダー名を指定します。 最大 64 個のリテラル ヘッダーを要求で指定できます。
    • プレフィックスが指定されたヘッダー。x-ms-meta-data* などのヘッダーのプレフィックスを指定します。 このような方法でプレフィックスを指定した場合は、指定のプレフィックスで始まるすべてのヘッダーが許可または公開されます。 最大 2 個のプレフィックスが指定されたヘッダーを要求で指定できます。
  • AllowedMethods 要素で指定されたメソッド (または HTTP 動詞) は、Azure ストレージ サービス API でサポートされるメソッドに従っている必要があります。 サポートされているメソッドは、、、、、 DELETE GET HEAD MERGE POSTOPTIONS および PUT です。

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

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

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

CORS ルールと評価ロジックの詳細については、「 Azure Storage のクロスオリジンリソース共有 (CORS) のサポート」を参照してください。

要求と応答の例

次の 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 ルールと評価ロジックの詳細については、「 Storage サービスの cors のサポート」を参照してください。

Storage Analytics の詳細については、「 Storage Analytics」を参照してください。