共有プロパティを取得する
Get Share Properties 要求は、指定した共有または共有スナップショットのプロパティを返します。
この API は完全にサポートされていますが、レガシ管理 API です。 このため、代わりにストレージ リソース プロバイダー (Microsoft.Storage) によって提供される ファイル共有 - Getを使用することをお勧めします。
ストレージ リソース プロバイダーを使用して FileShare リソースをプログラムで操作する方法の詳細については、「FileSharesの操作」を参照してください。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用できる |
|---|---|
| SMB |
|
| NFS |
|
依頼
Get Share Properties 要求は、次のように構築できます。 HTTPS を使用することをお勧めします。
| 方式 | 要求 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 に表示されているパス コンポーネントを独自のコンポーネントに置き換えます。
| パス コンポーネント | 形容 |
|---|---|
myaccount |
ストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
パスの名前付けの制限については、「名前と参照共有、ディレクトリ、ファイル、およびメタデータのを参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 形容 |
|---|---|
sharesnapshot |
随意。 バージョン 2017-04-17 以降。
sharesnapshot パラメーターは不透明な日付/時刻値であり、存在する場合は、プロパティを取得するためにクエリを実行する共有スナップショットを指定します。 |
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) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Files」を参照してください。 |
x-ms-lease-id:<ID> |
随意。 バージョン 2020-02-10 以降。 ヘッダーが指定されている場合、操作は、ファイル共有のリースが現在アクティブであり、要求で指定されたリース ID がファイル共有のリース ID と一致する場合にのみ実行されます。 一致するものがない場合、操作は状態コード 412 (Precondition Failed) で失敗します。 |
要求本文
何一つ。
応答
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
状態コード
操作が成功すると、状態コード 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-enable-snapshot-virtual-directory-access: <true;false> |
バージョン 2024-08-04 以降。 NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 このヘッダーは、スナップショットではなく共有に対してのみ返されます。 |
x-ms-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、1,024 文字以下の ASCII 文字が含まれている場合、x-ms-client-request-id ヘッダーの値と同じです。
x-ms-client-request-id ヘッダーが要求に存在しない場合、応答には存在しません。 |
x-ms-share-paid-bursting-enabled: <true;false> |
バージョン 2024-11-04 以降。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ返されます。 有料バーストを有効にするかどうかを指定します。 このヘッダーは、スナップショットではなく共有に対してのみ返されます。 |
x-ms-share-paid-bursting-max-iops |
バージョン 2024-11-04 以降。 Premium ファイル共有に対してのみ返されます。 共有で許可されている最大有料バースト IOPS を返します。
x-ms-share-paid-bursting-enabled が true の場合にのみ返されます。このヘッダーは、スナップショットではなく共有に対してのみ返されます。 |
x-ms-share-paid-bursting-max-bandwidth-mibps |
バージョン 2024-11-04 以降。 Premium ファイル共有に対してのみ返されます。 共有に対して許可されている最大有料バースト MiB/秒を返します。
x-ms-share-paid-bursting-enabled が true の場合にのみ返されます。このヘッダーは、スナップショットではなく共有に対してのみ返されます。 |
応答本文
何一つ。
応答のサンプル
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
認可
アカウント所有者のみがこの操作を呼び出すことができます。
備考
何一つ。
関連項目
Azure ファイル共有に対する 操作