ファイル サービスのプロパティの取得
この操作では Get File Service Properties
、FileREST API を FileService
使用してリソースのプロパティを取得します。 この API は完全にサポートされていますが、レガシ管理 API です。 代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される File Services - Get Service Properties を使用することをお勧めします。 ストレージ リソース プロバイダーを使用してプログラムでリソースを FileService
操作する方法の詳細については、「 FileService リソースに対する操作」を参照してください。
プロトコルの可用性
有効なファイル共有プロトコル | 利用可能 |
---|---|
SMB | |
NFS |
要求
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 |
省略可能。 ログ記録の構成時に Azure Storage Analytics ログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。 |
要求本文
なし。
[応答]
応答には、HTTP 状態コード、一連の応答ヘッダー、および応答本文が含まれています。
状態コード
操作に成功すると、状態コード 200 (OK) が返されます。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 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 要求に存在しない場合は、応答に存在しません。 |
応答本文
バージョン 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>
応答本文の要素を次の表に示します。
名前 | Description |
---|---|
HourMetrics |
Storage AnalyticsHourMetrics 設定をグループにします。 この設定では HourMetrics 、API ごとに 1 時間ごとの集計でグループ化された要求統計の概要が提供されます。 |
MinuteMetrics |
Storage AnalyticsMinuteMetrics 設定をグループにします。 この設定では MinuteMetrics 、1 分ごとの要求統計が提供されます。 |
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 マルチチャネルの設定が含まれます。 この設定には、enabled/disabled という 1 つのプロパティがあります。 |
Version |
バージョン 2020-04-08 以降で使用できます。 許可されている SMB バージョンのコンマ区切りの一覧。 指定できる値: SMB2.1 、SMB3.0 、SMB3.1.1 。 が指定されていない場合 Version 、既定ではすべてのバージョンが有効になります。 ただし、SMB 2.1 はストレージ アカウントの require secure transit プロパティが無効になっている場合にのみ使用できます。SMB 2.1 では暗号化がサポートされていないためです。 |
AuthenticationMethods |
バージョン 2020-04-08 以降で使用できます。 許可される認証方法のコンマ区切りの一覧。 有効値は、NTLMv2 、Kerberos です。 が指定されていない場合 AuthenticationMethods 、既定では、すべての認証方法が許可されます。 |
KerberosTicketEncryption |
バージョン 2020-04-08 以降で使用できます。 許可される Kerberos チケット暗号化アルゴリズムのコンマ区切りの一覧。 使用可能な値: RC4-HMAC および AES-256 。 が指定されていない場合 KerberosTicketEncryption 、既定では、すべての Kerberos チケット暗号化アルゴリズムがサポートされます。 |
ChannelEncryption |
バージョン 2020-04-08 以降で使用できます。 許可される SMB チャネル暗号化プロトコルのコンマ区切りの一覧。 指定できる値: AES-128-CCM 、AES-128-GCM 、AES-256-GCM 。 が指定されていない場合 ChannelEncryption 、既定では、すべてのチャネル暗号化値がサポートされます。 ストレージ アカウントの require secure transit プロパティが無効になっている場合は、暗号化されていない SMB アクセスも許可されます。 |
承認
この操作を呼び出すことができるのはストレージ アカウント所有者のみです。
要求と応答の例
次のサンプル URI は、 myaccount という名前のストレージ アカウントのファイル サービス プロパティを取得する要求を行います。
Method | 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>
注釈
CORS ルールと評価ロジックの詳細については、「 Azure Storage サービスの CORS サポート」を参照してください。
詳細については、「Storage Analytics」を参照してください。