共有のプロパティの取得
要求はGet Share Properties、指定した共有または共有スナップショットのプロパティを返します。
この API は完全にサポートされていますが、レガシ管理 API です。 このため、代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される ファイル共有 - 取得を使用することをお勧めします。
ストレージ リソース プロバイダーを使用してプログラムでリソースを FileShare 操作する方法の詳細については、「 FileShares に対する操作」を参照してください。
プロトコルの可用性
| 有効なファイル共有プロトコル | 使用可能 |
|---|---|
| SMB |  |
| NFS | |
要求
Get Share Properties 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
次のように、要求 URI に示されたパス コンポーネントを独自の URI に置き換えます。
| パス コンポーネント | 説明 |
|---|---|
myaccount |
ご利用のストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
パスの名前付け制限の詳細については、「 名前と参照共有、ディレクトリ、ファイル、およびメタデータ」を参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 説明 |
|---|---|
sharesnapshot |
省略可能。 バージョン 2017-04-17 以降。 パラメーターはsharesnapshot不透明な日付/時刻値であり、存在する場合は、プロパティを取得するためにクエリを実行する共有スナップショットを指定します。 |
timeout |
省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須ヘッダーと省略可能なヘッダーについては、次の表で説明します。
| 要求ヘッダー | 説明 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-client-request-id |
省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。 |
x-ms-lease-id:<ID> |
省略可能。 バージョン 2020-02-10 以降。 ヘッダーが指定されている場合、操作は、ファイル共有のリースが現在アクティブであり、要求で指定されたリース ID がファイル共有のリース ID と一致する場合にのみ実行されます。 一致しない場合、操作は状態コード 412 (前提条件失敗) で失敗します。 |
要求本文
[なし] :
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
status code
操作に成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 説明 |
|---|---|
Last-Modified |
共有が最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダー内の Date-Time 値の表現」を参照してください。 共有またはそのプロパティを変更する操作を行うと、最終更新時刻が更新されます。 ファイルに対する操作は、共有の最終変更時刻には影響しません。 |
x-ms-meta-name:value |
共有のユーザー定義メタデータが含まれる名前と値のペアのセット。 |
ETag |
条件付きで操作を実行するために使用できる値が含まれています。 値は引用符で囲まれています。 |
x-ms-request-id |
行われた要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されたAzure Filesバージョン。 |
Date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-share-quota |
バージョン 2015-02-21 以降。 現在の共有クォータをギビバイト (GiB) 単位で返します。 |
x-ms-share-provisioned-iops |
バージョン 2019-07-07 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 Premium 共有用にプロビジョニングされた 1 秒あたりの入出力操作の数 (IOPS) を返します。 |
x-ms-share-provisioned-ingress-mbps |
バージョン 2019-07-07 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 Premium 共有用にプロビジョニングされたイングレスを 1 秒あたりのメビバイト単位 (MiB/秒) で返します。 |
x-ms-share-provisioned-egress-mbps |
バージョン 2019-07-07 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 Premium 共有用にプロビジョニングされた MiB/秒のエグレスを返します。 |
x-ms-share-provisioned-bandwidth-mibps |
バージョン 2021-02-12 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 Premium 共有用にプロビジョニングされた MiB/秒の結合 (イングレス + エグレス) 帯域幅を返します。 |
x-ms-share-next-allowed-quota-downgrade-time |
バージョン 2019-07-07 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 Premium ファイル共有のクォータの削減を許可するタイミングを指定する日付/時刻値。 日付形式は RFC 1123 に従います。 |
x-ms-access-tier |
バージョン 2019-12-12 以降。 共有の現在のアクセス層を返します。 汎用バージョン 2 (GPv2) ストレージ アカウントでは、 TransationOptimized は共有の既定の層です。 FileStorage ストレージ アカウントの種類では、 Premium は共有の既定の層です。 |
x-ms-access-tier-change-time |
バージョン 2019-12-12 以降。 共有のアクセス層が最後に変更された日時を返します。 |
x-ms-access-tier-transition-state |
バージョン 2019-12-12 以降。 共有が層の切り替えを行っている場合、このヘッダーは移行元の層を示します。 |
x-ms-lease-duration:<fixed,infinite> |
バージョン 2020-02-10 以降。 共有のリースが無限期間か固定期間かを指定します。 |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
バージョン 2020-02-10 以降。 共有がリースされると、このヘッダーは共有のリース状態を指定します。 |
x-ms-lease-status: <locked;unlocked> |
バージョン 2020-02-10 以降。 共有がリースされると、このヘッダーは共有のリース状態を指定します。 |
x-ms-enabled-protocols: <SMB;NFS> |
バージョン 2019-07-07 以降の現在の共有対応プロトコルを返します。 - SMB: 共有にアクセスできるのは、SMBv3.0、SMBv2.1、REST です。- NFS: 共有には NFSv4.1 からアクセスできます。 |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
バージョン 2019-07-07 以降の現在の共有ルート スカッシュ動作を返します。 NFS のみ。 - NoRootSquash: ルート スカッシュがオフです。- RootSquash: UID/GID 0 からの要求は、匿名 UID/GID にマップされます。- AllSquash: すべての UID と GID が匿名ユーザーにマップされます。 |
x-ms-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、応答には存在しません。 |
応答本文
[なし] :
応答のサンプル
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
承認
この操作を呼び出すことができるのはアカウント所有者のみです。
解説
[なし] :