ディレクトリ プロパティの取得
この操作はGet Directory Properties、指定したディレクトリのすべてのシステム プロパティを返します。また、ディレクトリの存在をチェックするためにも使用できます。 返されるデータには、ディレクトリまたはサブディレクトリ内のファイルは含まれません。
プロトコルの可用性
| 有効なファイル共有プロトコル | 使用可能 |
|---|---|
| SMB |
|
| NFS |
|
要求
Get Directory Properties 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare/myparentdirectorypath/mydirectory?restype=directory |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare/ myparentdirectorypath/mydirectory?restype=directory&sharesnapshot=<DateTime> |
HTTP/1.1 |
次のように、要求 URI に表示されるパス コンポーネントを独自のパス コンポーネントに置き換えます。
| パス コンポーネント | 説明 |
|---|---|
myaccount |
ご利用のストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
myparentdirectorypath |
省略可能。 親ディレクトリへのパス。 |
mydirectory |
ディレクトリの名前。 |
パスの名前付け制限の詳細については、「 名前と参照共有、ディレクトリ、ファイル、およびメタデータ」を参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 説明 |
|---|---|
sharesnapshot |
省略可能。 バージョン 2017-04-17 以降。 パラメーターはsharesnapshot不透明な DateTime 値であり、存在する場合は、ディレクトリ プロパティに対してクエリを実行する共有スナップショットを指定します。 |
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-file-request-intent |
ヘッダーが OAuth トークンを指定する場合 Authorization は必須。 許容される値は です backup。 このヘッダーは、 ヘッダーをMicrosoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action使用してAuthorization承認された ID に割り当てられた RBAC ポリシーに 含まれている場合に、 または Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action を許可するように指定します。 バージョン 2022-11-02 以降で使用できます。 |
x-ms-allow-trailing-dot: { <Boolean> } |
省略可能。 バージョン 2022-11-02 以降。 ブール値は、要求 URL に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
要求本文
[なし] :
要求のサンプル
HEAD https://myaccount.file.core.windows.net/myshare/myparentdirectorypath/mydirectory?restype=directory HTTP/1.1
Request Headers:
x-ms-version: 2015-02-21
x-ms-date: <date>
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
status code
操作に成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 説明 |
|---|---|
ETag |
ETag には、条件に基づく操作の実行に使用できる値が含まれます。 値は引用符で囲まれています。 |
Last-Modified |
ディレクトリが最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダーの日付/時刻値を表す」を参照してください。 ディレクトリ内のファイルに対する操作は、ディレクトリの最終変更時刻には影響しません。 |
x-ms-meta-name:value |
ディレクトリのメタデータを含む名前と値のペアのセット。 |
x-ms-request-id |
要求の一意識別子を返します。これは、要求のトラブルシューティングに役立ちます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されたサービス バージョンを示します。 |
Date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-server-encrypted: true/false |
バージョン 2017-04-17 以降。 指定したアルゴリズムを true 使用してディレクトリ メタデータが完全に暗号化されている場合、このヘッダーの値は に設定されます。 メタデータが暗号化されていない場合、値は に false設定されます。 |
x-ms-file-permission-key |
バージョン 2019-02-02 以降。 ディレクトリのアクセス許可のキー。 |
x-ms-file-attributes |
バージョン 2019-02-02 以降。 ディレクトリ上のファイル システム属性。 詳細については、 使用可能な属性の一覧を参照してください。 |
x-ms-file-creation-time |
バージョン 2019-02-02 以降。 ディレクトリの作成時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-last-write-time |
バージョン 2019-02-02 以降。 ディレクトリの最後の書き込み時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-change-time |
バージョン 2019-02-02 以降。 ディレクトリの変更時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-file-id |
バージョン 2019-02-02 以降。 ディレクトリのファイル ID。 |
x-ms-file-parent-id |
バージョン 2019-02-02 以降。 ディレクトリの親ファイル ID。 |
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
Date: <date>
ETag: "0x8CAFB82EFF70C46"
Last-Modified: <date>
x-ms-version: 2015-02-21
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
承認
この操作を呼び出すことができるのはアカウント所有者のみです。
注釈
指定したディレクトリ パスが存在しない場合、要求は状態コード 404 (Not Found) で失敗します。