Filesystem - Set Properties

リファレンス

Service:: Storage Services

API Version:: 2023-08-03

ファイルシステムのプロパティを設定する
ファイルシステムのプロパティを設定します。この操作では、条件付き HTTP 要求がサポートされます。詳細については、「BLOB サービス操作の条件ヘッダーの指定」を参照してください。

PATCH https://{accountName}.{dnsSuffix}/{filesystem}?resource=filesystem

With optional parameters:

PATCH https://{accountName}.{dnsSuffix}/{filesystem}?resource=filesystem&timeout={timeout}

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Azure Storage のアカウント名。
dnsSuffix	path	True	string	Azure Data Lake Storage エンドポイントの DNS サフィックス。
filesystem	path	True	string	ファイルシステム識別子。値の先頭と末尾は文字または数字で、文字、数字、ダッシュ (-) 文字のみを含める必要があります。連続するダッシュは使用できません。すべての文字は小文字にする必要があります。値は 3 ~ 63 文字にする必要があります。 Regex pattern: `^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$`
resource	query	True	FilesystemResourceType	値は、すべてのファイルシステム操作に対して "filesystem" である必要があります。
timeout	query		integer int32	オプションの操作タイムアウト値 (秒単位)。期間は、サービスが要求を受信したときに開始されます。操作が完了する前にタイムアウト値が経過すると、操作は失敗します。

要求ヘッダー

名前	型	説明
x-ms-properties	string	省略可能。ファイルシステムと共に格納されるユーザー定義プロパティは、名前と値のペアのコンマ区切りのリスト "n1=v1, n2=v2, ..." の形式で格納されます。各値は base64 でエンコードされた文字列です。文字列には、ISO-8859-1 文字セット内の ASCII 文字のみを含める場合があることに注意してください。ファイルシステムが存在する場合、リストに含まれていないプロパティはすべて削除されます。ヘッダーを省略すると、すべてのプロパティが削除されます。新規および既存のプロパティをマージするには、まず既存のすべてのプロパティと現在の E-Tag を取得してから、E-Tag を使用して条件付き要求を行い、すべてのプロパティの値を含めます。
If-Modified-Since	string	省略可能。日付と時刻の値。指定した日時以降にリソースが変更された場合にのみ、このヘッダーを指定して操作を実行します。
If-Unmodified-Since	string	省略可能。日付と時刻の値。指定した日時以降にリソースが変更されていない場合にのみ、このヘッダーを指定して操作を実行します。
x-ms-client-request-id	string	トラブルシューティングと関連付けのために分析ログに記録された UUID。 Regex pattern: `^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$`
x-ms-date	string	要求に対して協定世界時 (UTC) を指定します。これは、共有キーの承認を使用する場合に必要です。
x-ms-version	string	要求の処理に使用される REST プロトコルのバージョンを指定します。これは、共有キーの承認を使用する場合に必要です。

応答

名前	型	説明
200 OK		[OK] Headers Date: string ETag: string Last-Modified: string x-ms-request-id: string x-ms-version: string
Other Status Codes	DataLakeStorageError	エラーが発生しました。使用可能な HTTP 状態、コード、およびメッセージ文字列を次に示します。 400 Bad Request、ContentLengthMustBeZero、"Content-Length 要求ヘッダーは 0 である必要があります。 400 Bad Request、InvalidAuthenticationInfo、"認証情報が正しい形式で指定されていません。 Authorization ヘッダーの値を確認してください。 400 Bad Request、InvalidFlushPosition、"アップロードされたデータが連続していないか、位置クエリパラメーターの値が、アップロードされたデータを追加した後のファイルの長さと等しくありません。" 400 Bad Request、InvalidHeaderValue、"HTTP ヘッダーの 1 つの値が正しい形式ではありません。" 400 Bad Request、InvalidHttpVerb、"指定された HTTP 動詞は無効です。サーバーによって認識されません。 400 Bad Request、InvalidInput、"要求入力の 1 つが無効です。 400 Bad Request、InvalidPropertyName、"プロパティ名を空にすることはできません"。 400 Bad Request、InvalidPropertyName、"プロパティ名に無効な文字が含まれています。 400 Bad Request、InvalidQueryParameterValue、"要求 URI で指定されたクエリパラメーターの 1 つの値が無効です。 400 Bad Request、InvalidResourceName、"指定されたリソース名に無効な文字が含まれています。 400 無効な要求、InvalidSourceUri、"ソース URI が無効です。 400 Bad Request、InvalidUri、"要求 URI が無効です。 400 Bad Request、MissingRequiredHeader、"この要求に必須の HTTP ヘッダーが指定されていません。 400 Bad Request、MissingRequiredQueryParameter、"この要求に必須のクエリパラメーターが指定されていません。 400 Bad Request、MultipleConditionHeadersNotSupported、"複数の条件ヘッダーはサポートされていません。 400 Bad Request、OutOfRangeInput、"要求入力の 1 つが範囲外です。 400 Bad Request、OutOfRangeQueryParameterValue、"要求 URI で指定されたクエリパラメーターの 1 つが許容範囲外です。 400 Bad Request、UnsupportedHeader、"要求で指定されたヘッダーの 1 つがサポートされていません。" 400 Bad Request、UnsupportedQueryParameter、"要求 URI で指定されたクエリパラメーターの 1 つがサポートされていません。 400 Bad Request、UnsupportedRestVersion、"指定された Rest バージョンはサポートされていません。 403 Forbidden、AccountIsDisabled、"指定されたアカウントが無効になっています。 403 Forbidden、AuthorizationFailure、"この要求は、この操作を実行する権限がありません。 403 Forbidden、InsufficientAccountPermissions、"アクセスされているアカウントには、この操作を実行するための十分なアクセス許可がありません。" 404 見つかりません。FilesystemNotFound、"指定されたファイルシステムが存在しません。 404 見つかりません。PathNotFound、"指定したパスが存在しません。 404 Not Found, RenameDestinationParentPathNotFound, "宛先パスの親ディレクトリが存在しません。" 404 見つかりません。ResourceNotFound、"指定されたリソースが存在しません。 404 Not Found, SourcePathNotFound, "名前変更操作のソースパスが存在しません。" 405 メソッド Not Allowed、UnsupportedHttpVerb、"リソースは指定された HTTP 動詞をサポートしていません。" 409 競合、DestinationPathIsBeingDeleted、"指定した宛先パスは削除対象としてマークされています。 409 Conflict,DirectoryNotEmpty, "空でないディレクトリを削除するには、再帰的なクエリパラメーター値が true である必要があります。 409 競合、FilesystemAlreadyExists、"指定されたファイルシステムは既に存在します。 409 競合、FilesystemBeingDeleted、"指定されたファイルシステムが削除されています。 409 Conflict、InvalidDestinationPath、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。* 409 Conflict, InvalidFlushOperation, "リソースは Blob Service API によって作成または変更され、Data Lake Storage Service API によって書き込むことができません。" 409 Conflict, InvalidRenameSourcePath, "ソースディレクトリをコピー先ディレクトリと同じにすることも、コピー先をソースディレクトリのサブディレクトリにすることもできません。" 409 Conflict、InvalidSourceOrDestinationResourceType、"ソースとターゲットのリソースの種類は同じである必要があります。 409 競合、LeaseAlreadyPresent、"既にリースが存在します。 409 Conflict, LeaseIdMismatchWithLeaseOperation, "指定されたリース ID は、指定されたリース操作を持つリソースのリース ID と一致しませんでした。" 409 Conflict, LeaseIsAlreadyBroken, "リースは既に破損しており、再び壊すことはできません。" 409 競合、LeaseIsBreakingAndCannotBeAcquired、"リース ID は一致しましたが、リースは現在中断状態であり、破損するまで取得できません"。 409 競合、LeaseIsBreakingAndCannotBeChanged、"リース ID は一致しましたが、リースは現在中断状態であり、変更できません"。 409 競合、LeaseIsBrokenAndCannotBeRenewed、"リース ID は一致しましたが、リースは明示的に破損しており、更新できません"。 409 Conflict, LeaseNameMismatch, "指定されたリース名が既存のリース名と一致しませんでした。 409 競合、LeaseNotPresentWithLeaseOperation、"リース ID が指定されたリース操作と一緒に存在しません。 409 Conflict,PathAlreadyExists, "指定されたパスは既に存在します。 409 Conflict、PathConflict、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。 409 競合、SourcePathIsBeingDeleted、"指定したソースパスは削除対象としてマークされています。 409 競合、ResourceTypeMismatch、"要求で指定されたリソースの種類がリソースの種類と一致しません。" 412 前提条件に失敗しました。ConditionNotMet、「HTTP 条件付きヘッダーを使用して指定された条件が満たされていません。」 412 前提条件に失敗しました。LeaseIdMismatch、「指定されたリース ID がリソースのリース ID と一致しませんでした。」 412 前提条件に失敗しました。LeaseIdMissing、「現在、リソースにリースがあり、要求でリース ID が指定されていません。 412 前提条件に失敗しました。LeaseNotPresent、「現在、リソースにリースはありません。」 412 前提条件に失敗しました。LeaseLost、「リース ID が指定されましたが、リソースのリースの有効期限が切れています。」 412 Precondition Failed,SourceConditionNotMet, "HTTP 条件付きヘッダーを使用して指定されたソース条件が満たされていません。" 413 要求エンティティが大きすぎる、RequestBodyTooLarge、「要求本文が大きすぎて、許容される上限を超えています。」 416 要求された範囲が満たされない、InvalidRange、"指定された範囲は、リソースの現在のサイズに対して無効です。 500 内部サーバーエラー、InternalError、"サーバーで内部エラーが発生しました。要求を再試行してください。" 500 内部サーバーエラー、OperationTimedOut、"許可された時間内に操作を完了できませんでした。" 503 サービス利用不可、ServerBusy、"エグレスがアカウント制限を超えています。" 503 サービス利用不可、ServerBusy、"イングレスがアカウント制限を超えています。" 503 サービス利用不可、ServerBusy、「1 秒あたりの操作数がアカウントの制限を超えています。」 503 サービス利用不可、ServerBusy、"サーバーは現在要求を受信できません。要求を再試行してください。" Headers x-ms-request-id: string x-ms-version: string

名前

型

説明

200 OK

[OK]

Headers

Date: string
ETag: string
Last-Modified: string
x-ms-request-id: string
x-ms-version: string

Other Status Codes

DataLakeStorageError

エラーが発生しました。使用可能な HTTP 状態、コード、およびメッセージ文字列を次に示します。

400 Bad Request、ContentLengthMustBeZero、"Content-Length 要求ヘッダーは 0 である必要があります。
400 Bad Request、InvalidAuthenticationInfo、"認証情報が正しい形式で指定されていません。 Authorization ヘッダーの値を確認してください。
400 Bad Request、InvalidFlushPosition、"アップロードされたデータが連続していないか、位置クエリパラメーターの値が、アップロードされたデータを追加した後のファイルの長さと等しくありません。"
400 Bad Request、InvalidHeaderValue、"HTTP ヘッダーの 1 つの値が正しい形式ではありません。"
400 Bad Request、InvalidHttpVerb、"指定された HTTP 動詞は無効です。サーバーによって認識されません。
400 Bad Request、InvalidInput、"要求入力の 1 つが無効です。
400 Bad Request、InvalidPropertyName、"プロパティ名を空にすることはできません"。
400 Bad Request、InvalidPropertyName、"プロパティ名に無効な文字が含まれています。
400 Bad Request、InvalidQueryParameterValue、"要求 URI で指定されたクエリパラメーターの 1 つの値が無効です。
400 Bad Request、InvalidResourceName、"指定されたリソース名に無効な文字が含まれています。
400 無効な要求、InvalidSourceUri、"ソース URI が無効です。
400 Bad Request、InvalidUri、"要求 URI が無効です。
400 Bad Request、MissingRequiredHeader、"この要求に必須の HTTP ヘッダーが指定されていません。
400 Bad Request、MissingRequiredQueryParameter、"この要求に必須のクエリパラメーターが指定されていません。
400 Bad Request、MultipleConditionHeadersNotSupported、"複数の条件ヘッダーはサポートされていません。
400 Bad Request、OutOfRangeInput、"要求入力の 1 つが範囲外です。
400 Bad Request、OutOfRangeQueryParameterValue、"要求 URI で指定されたクエリパラメーターの 1 つが許容範囲外です。
400 Bad Request、UnsupportedHeader、"要求で指定されたヘッダーの 1 つがサポートされていません。"
400 Bad Request、UnsupportedQueryParameter、"要求 URI で指定されたクエリパラメーターの 1 つがサポートされていません。
400 Bad Request、UnsupportedRestVersion、"指定された Rest バージョンはサポートされていません。
403 Forbidden、AccountIsDisabled、"指定されたアカウントが無効になっています。
403 Forbidden、AuthorizationFailure、"この要求は、この操作を実行する権限がありません。
403 Forbidden、InsufficientAccountPermissions、"アクセスされているアカウントには、この操作を実行するための十分なアクセス許可がありません。"
404 見つかりません。FilesystemNotFound、"指定されたファイルシステムが存在しません。
404 見つかりません。PathNotFound、"指定したパスが存在しません。
404 Not Found, RenameDestinationParentPathNotFound, "宛先パスの親ディレクトリが存在しません。"
404 見つかりません。ResourceNotFound、"指定されたリソースが存在しません。
404 Not Found, SourcePathNotFound, "名前変更操作のソースパスが存在しません。"
405 メソッド Not Allowed、UnsupportedHttpVerb、"リソースは指定された HTTP 動詞をサポートしていません。"
409 競合、DestinationPathIsBeingDeleted、"指定した宛先パスは削除対象としてマークされています。
409 Conflict,DirectoryNotEmpty, "空でないディレクトリを削除するには、再帰的なクエリパラメーター値が true である必要があります。
409 競合、FilesystemAlreadyExists、"指定されたファイルシステムは既に存在します。
409 競合、FilesystemBeingDeleted、"指定されたファイルシステムが削除されています。
409 Conflict、InvalidDestinationPath、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。* 409 Conflict, InvalidFlushOperation, "リソースは Blob Service API によって作成または変更され、Data Lake Storage Service API によって書き込むことができません。"
409 Conflict, InvalidRenameSourcePath, "ソースディレクトリをコピー先ディレクトリと同じにすることも、コピー先をソースディレクトリのサブディレクトリにすることもできません。"
409 Conflict、InvalidSourceOrDestinationResourceType、"ソースとターゲットのリソースの種類は同じである必要があります。
409 競合、LeaseAlreadyPresent、"既にリースが存在します。
409 Conflict, LeaseIdMismatchWithLeaseOperation, "指定されたリース ID は、指定されたリース操作を持つリソースのリース ID と一致しませんでした。"
409 Conflict, LeaseIsAlreadyBroken, "リースは既に破損しており、再び壊すことはできません。"
409 競合、LeaseIsBreakingAndCannotBeAcquired、"リース ID は一致しましたが、リースは現在中断状態であり、破損するまで取得できません"。
409 競合、LeaseIsBreakingAndCannotBeChanged、"リース ID は一致しましたが、リースは現在中断状態であり、変更できません"。
409 競合、LeaseIsBrokenAndCannotBeRenewed、"リース ID は一致しましたが、リースは明示的に破損しており、更新できません"。
409 Conflict, LeaseNameMismatch, "指定されたリース名が既存のリース名と一致しませんでした。
409 競合、LeaseNotPresentWithLeaseOperation、"リース ID が指定されたリース操作と一緒に存在しません。
409 Conflict,PathAlreadyExists, "指定されたパスは既に存在します。
409 Conflict、PathConflict、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。
409 競合、SourcePathIsBeingDeleted、"指定したソースパスは削除対象としてマークされています。
409 競合、ResourceTypeMismatch、"要求で指定されたリソースの種類がリソースの種類と一致しません。"
412 前提条件に失敗しました。ConditionNotMet、「HTTP 条件付きヘッダーを使用して指定された条件が満たされていません。」
412 前提条件に失敗しました。LeaseIdMismatch、「指定されたリース ID がリソースのリース ID と一致しませんでした。」
412 前提条件に失敗しました。LeaseIdMissing、「現在、リソースにリースがあり、要求でリース ID が指定されていません。
412 前提条件に失敗しました。LeaseNotPresent、「現在、リソースにリースはありません。」
412 前提条件に失敗しました。LeaseLost、「リース ID が指定されましたが、リソースのリースの有効期限が切れています。」
412 Precondition Failed,SourceConditionNotMet, "HTTP 条件付きヘッダーを使用して指定されたソース条件が満たされていません。"
413 要求エンティティが大きすぎる、RequestBodyTooLarge、「要求本文が大きすぎて、許容される上限を超えています。」
416 要求された範囲が満たされない、InvalidRange、"指定された範囲は、リソースの現在のサイズに対して無効です。
500 内部サーバーエラー、InternalError、"サーバーで内部エラーが発生しました。要求を再試行してください。"
500 内部サーバーエラー、OperationTimedOut、"許可された時間内に操作を完了できませんでした。"
503 サービス利用不可、ServerBusy、"エグレスがアカウント制限を超えています。"
503 サービス利用不可、ServerBusy、"イングレスがアカウント制限を超えています。"
503 サービス利用不可、ServerBusy、「1 秒あたりの操作数がアカウントの制限を超えています。」
503 サービス利用不可、ServerBusy、"サーバーは現在要求を受信できません。要求を再試行してください。"

Headers

x-ms-request-id: string
x-ms-version: string

定義

名前	説明
DataLakeStorageError
Error	サービスエラー応答オブジェクト。
FilesystemResourceType	値は、すべてのファイルシステム操作に対して "filesystem" である必要があります。

DataLakeStorageError

名前	型	説明
error	Error	サービスエラー応答オブジェクト。

Error

サービスエラー応答オブジェクト。

名前	型	説明
code	string	サービスエラーコード。
message	string	サービスエラーメッセージ。

FilesystemResourceType

値は、すべてのファイルシステム操作に対して "filesystem" である必要があります。

名前	型	説明
filesystem	string

Filesystem - Set Properties

URI パラメーター

要求ヘッダー

応答

定義

DataLakeStorageError

Error

FilesystemResourceType

その他のリソース