ファイル サービスのプロパティの取得

操作は、 Get File Service Properties FileService FileREST API を使用してリソースのプロパティを取得します。 この API は完全にサポートされていますが、これは従来の管理 API です。 代わりに、ファイルサービスを使用することをお勧めします。代わりに、ストレージリソースプロバイダー (Microsoft Storage) によって提供されるサービスプロパティを取得します。 プログラムによって FileService ストレージリソースプロバイダーを使用してリソースを操作する方法の詳細については、 FileService に対する操作に関するページを参照してください。

プロトコルの可用性

有効なファイル共有プロトコル 利用可能
SMB はい
NFS はい

Request

Get File Service Properties要求は、次のように指定できます。 HTTPS が推奨されます。 <account-name> はストレージ アカウントの名前に置き換えます。

Method 要求 URI HTTP バージョン
GET 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 または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「 Azure Storage 要求を承認する」を参照してください。
x-ms-version すべての承認された要求に必須です。 この要求に使用する操作のバージョンを指定します。 この操作は、バージョン2015-02-21 以降でのみ使用できます。 ファイルサービスのメトリックのプロパティを取得するには、バージョン2015-04-05 以降を指定する必要があります。

詳細については、「 Azure Storage サービスのバージョン管理」を参照してください。
x-ms-client-request-id 任意。 ストレージ分析ログが有効になっている場合に analytics ログに記録される、クライアントによって生成される非透過の値を 1 KiB 文字の制限付きで提供します。 クライアント側のアクティビティをサーバーが受信した要求と関連付けるには、このヘッダーを使用することが強く推奨されます。 詳細については、「 Azure Blob ストレージの監視」を参照してください。

要求本文

[なし] :

Response

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

status code

操作に成功すると、状態コード 200 (OK) が返されます。

応答ヘッダー

この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 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ヘッダーが要求内に存在しない場合、このヘッダーは応答に存在しません。

応答本文

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

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

Name 説明
HourMetrics Storage Analytics の設定をグループ化 HourMetrics します。 この HourMetrics 設定により、API 別に1時間ごとの集計でグループ化された要求統計の概要が提供されます。
MinuteMetrics Azure Analytics の MinuteMetrics 設定をグループ化します。 この設定は、毎 MinuteMetrics 分の要求の統計情報を提供します。
Version 現在使用中の Storage Analytics のバージョン。
Enabled ファイルサービスに対してメトリックが有効になっているかどうかを示します。
IncludeAPIs メトリックで、呼び出された API 操作の概要統計情報を生成するかどうかを示します。
RetentionPolicy/Enabled ファイルサービスに対して保持ポリシーが有効になっているかどうかを示します。
RetentionPolicy/Days メトリックデータを保持する日数を示します。 この値より古いデータはすべて、ベストエフォートで削除されます。
Cors すべての CORS ルールをグループ化します。
CorsRule CORS ルールの設定をグループ化します。
AllowedOrigins CORS または "" を使用して許可される元のドメインのコンマ区切りのリストです ("" はすべてのドメインを許可します)。
ExposedHeaders CORS クライアントに公開されている応答ヘッダーのコンマ区切りのリストです。
MaxAgeInSeconds クライアント/ブラウザーがプレフライト応答をキャッシュする秒数。
AllowedHeaders クロス オリジン要求の一部として許可されるヘッダーのコンマ区切りのリストです。
AllowedMethods 元のドメインによる実行が許可される HTTP メソッドのコンマ区切りのリストです。 Azure Files の場合、許可されるメソッドは、DELETE、GET、HEAD、MERGE、POST、OPTIONS、PUT です。
ShareDeleteRetentionPolicy このストレージアカウント内の Azure ファイル共有の論理的な削除プロパティ。
Days Azure ファイル共有を保持する日数 (論理的に削除) を示します。 指定できる最小値は1で、最大値は365です。
Enabled ストレージアカウントの Azure Files に対して論理的な削除が有効になっているかどうか。
ProtocolSettings ファイル システム プロトコルの設定をグループにします。
SMB SMB の設定をグループにします。
Multichannel SMB マルチチャネルの設定を格納します。 この設定には、有効/無効という 1 つのプロパティがあります。
Version から使用できます 2020-04-08 。 許可される SMB バージョンのコンマ区切りの一覧。 指定できる値: SMB2.1 SMB3.0 SMB3.1.1 、、。 指定されていない場合の既定値は、すべてのバージョンが有効になっていますが、SMB 2.1 では暗号化がサポートされていないので、ストレージ アカウントの "安全な転送が必要" プロパティが無効になっている場合にのみ SMB 2.1 にアクセスできます。
AuthenticationMethods から使用できます 2020-04-08 。 許可される認証方法のコンマ区切りの一覧。 有効値は、NTLMv2Kerberos です。 指定されていない場合の既定値は、すべての認証方法が許可されます。
KerberosTicketEncryption から使用できます 2020-04-08 。 許可される Kerberos チケット暗号化アルゴリズムのコンマ区切りリスト。 有効値は、RC4-HMACAES-256 です。 指定されていない場合の既定値は、すべての Kerberos チケット暗号化アルゴリズムがサポートされています。
ChannelEncryption から使用できます 2020-04-08 。 許可される SMB チャネル暗号化プロトコルのコンマ区切りリスト。 指定できる値: AES-128-CCM AES-128-GCM AES-256-GCM 、、。 指定されていない場合の既定値は、すべてのチャネル暗号化値がサポートされています。 ストレージ アカウントの "安全な転送が必要" プロパティが無効になっている場合は、暗号化されていない SMB アクセスも許可されます。

承認

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

要求と応答の例

次のサンプル URI は、myaccount という名前のストレージ アカウントの File サービス プロパティを取得する 要求を行います

方法 URL Protocol
GET 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  

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

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
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  

応答には、次の 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>  

Remarks

CORS ルールと評価ロジックの詳細については、「CORS Support for the Storage Services 」を参照してください

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