Get File Service Properties
操作は、FileREST API を使用してFileService
リソースのプロパティを取得します。 この API は完全にサポートされていますが、レガシ管理 API です。 代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される File Services - Get Service Properties を使用することをお勧めします。 ストレージ リソース プロバイダーを使用して FileService
リソースをプログラムで操作する方法の詳細については、「 FileService リソースに対する操作」を参照してください。
プロトコルの可用性
有効なファイル共有プロトコル | 在庫有り |
---|---|
中小企業 |
![]() |
ネットワークファイルシステム(NFS) |
![]() |
リクエスト
Get File Service Properties
要求は、次のように指定できます。 HTTPS を使用することをお勧めします。
<account-name>
をストレージ アカウントの名前に置き換えます。
メソッド | 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 または 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 ファイルを監視する」をご覧ください。 |
リクエストの本文
なし。
[応答]
応答には、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-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>
応答本文の要素を次の表に示します。
名前 | 説明 |
---|---|
HourMetrics |
Storage Analytics HourMetrics 設定をグループにします。
HourMetrics 設定では、API ごとに時間単位の集計でグループ化された要求の統計情報の概要が提供されます。 |
MinuteMetrics |
Storage Analytics MinuteMetrics 設定をグループにします。
MinuteMetrics 設定では、1 分ごとに要求の統計情報が提供されます。 |
Version |
現在使用されている Storage Analytics のバージョン。 |
Enabled |
File サービスに対してメトリックが有効になっているかどうかを示します。 |
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 つのプロパティがあります。 |
Versions |
バージョン 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 という名前のストレージ アカウントの File サービス プロパティを取得する要求を行います。
メソッド | URL | プロトコル |
---|---|---|
取得する | 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」を参照してください。