ファイル名の変更

  • [アーティクル]

操作によって Rename File ファイルの名前が変更され、必要に応じてファイルのシステム プロパティを設定できます。 この API は、バージョン 2021-04-10 以降で使用できます。

プロトコルの可用性

有効なファイル共有プロトコル 利用可能
SMB はい
NFS いいえ

Request

要求は Rename File 次のように構築できます。 HTTPS が推奨されます。

Method 要求 URI HTTP バージョン
PUT https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename HTTP/1.1

次のように、要求 URI に示されたパス コンポーネントを独自の URI に置き換えます。

パス コンポーネント 説明
myaccount ご利用のストレージ アカウントの名前。
myshare ファイル共有の名前。
mydirectorypath 省略可能。 親ターゲット ディレクトリへのパス。
myfile ターゲット ファイルの名前。

パスの名前付け制限の詳細については、「 共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。

URI パラメーター

要求 URI には、次の追加パラメーターを指定できます。

パラメーター 説明
timeout 省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトの設定」を参照してください。

要求ヘッダー

必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求ヘッダー 説明
Authorization 必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
Date または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
x-ms-version すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-file-rename-source:name 必須。 名前を変更するファイルの名前。
x-ms-file-rename-replace-if-exists 省略可能。 コピー先ファイルが既に存在する場合は、ファイルを上書きします。
x-ms-file-rename-ignore-readonly 省略可能。 属性を持つ宛先ファイルが存在する場合は readonly 、ファイルを上書きします。

true の場合は、 x-ms-file-rename-replace-if-exists も true である必要があります。
x-ms-content-Type 省略可能。 ファイルのコンテンツの種類を設定します。

要求でこのプロパティが指定されていない場合、プロパティはファイルに対して保持されます。
x-ms-file-permission が指定されていない場合 x-ms-file-permission-key は省略可能です。 このアクセス許可は、 セキュリティ記述子定義言語 (SDDL) で指定されたファイルのセキュリティ記述子です。 アクセス許可のサイズが 8 kibibytes (KiB) 以下の場合は、このヘッダーを使用できます。 それ以外の場合は、 を使用 x-ms-file-permission-keyできます。 指定した場合、このアクセス許可には、所有者、グループ、および 随意アクセス制御リストが必要です。 既存の値を変更しない場合は、 の preserve 値を渡すことができます。

両方ではなく、 または x-ms-file-permission-keyのいずれかをx-ms-file-permission指定できます。
x-ms-file-permission-key が指定されていない場合 x-ms-file-permission は省略可能です。 ファイルに設定するアクセス許可のキー。 これは、API を使用 Create-Permission して作成できます。

両方ではなく、 または x-ms-file-permission-keyのいずれかをx-ms-file-permission指定できます。
x-ms-file-attributes 省略可能。 ファイルに設定するファイル システム属性。 使用可能な属性の一覧を参照してください。 既存の値を変更しない場合は、 の preserve 値を渡すことができます。 要求でこのプロパティを指定しない場合、プロパティはファイルに対して保持されます。
x-ms-file-creation-time 省略可能。 ファイルの UTC 作成時刻プロパティ。 既存の値を変更しない場合は、 の preserve 値を渡すことができます。 要求でこのプロパティを指定しない場合、プロパティはファイルに対して保持されます。
x-ms-file-last-write-time 省略可能。 ファイルの UTC 最終書き込みプロパティ。 既存の値を変更しない場合は、 の preserve 値を渡すことができます。 要求でこのプロパティを指定しない場合、プロパティはファイルに対して保持されます。
x-ms-source-lease-id:<ID> ソース ファイルにアクティブなリースがある場合は必須です。
x-ms-destination-lease-id:<ID> コピー先ファイルにアクティブなリースがある場合は必須です。
x-ms-client-request-id 省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Blob Storageの監視」を参照してください。
x-ms-meta-name:value 省略可能。 ファイルの名前と値のペアを設定します。

この操作を呼び出すと、その都度、ファイルに関連付けられている既存のメタデータがすべて置き換えられます。

メタデータ名は 、C# 識別子の名前付け規則に従う必要があります。
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 に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。
x-ms-source-allow-trailing-dot: { <Boolean> } 省略可能。 バージョン 2022-11-02 以降。 ブール値は、ソース URL に存在する末尾のドットをトリミングするかどうかを指定します。 このヘッダーは、コピー ソースが Azure ファイルの場合にのみ指定する必要があります。 このヘッダーは、他のコピー ソースの種類ではサポートされていません。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。

要求本文

[なし] :

Response

応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。

状態コード

操作に成功すると、状態コード 200 (OK) が返されます。 状態コードの詳細については、「 状態とエラー コード」を参照してください。

応答ヘッダー

この操作の応答には、次のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーを含めることもできます。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。

応答ヘッダー 説明
ETag ファイルのバージョンを引用符で囲んで表す値を格納します。
Last-Modified ファイルが最後に更新された日時を返します。 詳細については、「 ヘッダー内の日時値の表現」を参照してください。 ディレクトリまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 ファイルに対する操作は、ディレクトリの最終変更時刻には影響しません。
x-ms-request-id 作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。
x-ms-version 要求の実行に使用Azure Filesのバージョンを示します。
Date または x-ms-date 応答が開始された時刻を示す UTC 日付/時刻値。 サービスによってこの値が生成されます。
x-ms-request-server-encrypted: true/false 指定したアルゴリズムを true 使用して要求の内容が正常に暗号化された場合、このヘッダーの値は に設定されます。 それ以外の場合、値は false に設定されます。
x-ms-file-permission-key ファイルのアクセス許可のキー。
x-ms-file-attributes ファイルのファイル システム属性。 使用可能な属性の一覧を参照してください。
x-ms-file-creation-time ファイルの作成時刻プロパティを表す UTC 日付/時刻値。
x-ms-file-last-write-time ファイルの最後の書き込み時刻プロパティを表す UTC 日付/時刻値。
x-ms-file-change-time ファイルの変更時刻プロパティを表す値の UTC 日付/時刻。
x-ms-file-file-id ファイルのファイル ID。
x-ms-file-parent-id ファイルの親ファイル ID。
x-ms-client-request-id 要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在する x-ms-client-request-id 場合、ヘッダーの値と同じです。 この値は、最大 1,024 文字の ASCII 文字で表示されます。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、応答には存在しません。

応答本文

[なし] :

承認

この操作を呼び出すことができるのは、アカウント所有者だけです。

ファイル システム属性

属性 Win32 ファイル属性 定義
ReadOnly FILE_ATTRIBUTE_READONLY 読み取り専用のファイル。 アプリケーションはファイルを読み取ることができますが、ファイルに書き込んだり削除したりすることはできません。
Hidden FILE_ATTRIBUTE_HIDDEN ファイルが非表示になっています。 通常のディレクトリ一覧には含まれません。
System FILE_ATTRIBUTE_SYSTEM オペレーティング システムが の一部を使用するファイル、または排他的に使用するファイル。
None FILE_ATTRIBUTE_NORMAL 他の属性が設定されていないファイル。 この属性は、単独で使った場合にのみ有効です。
Archive FILE_ATTRIBUTE_ARCHIVE アーカイブ ファイルであるファイル。 アプリケーションでは通常、この属性を使用して、バックアップまたは削除のためにファイルをマークします。
Temporary FILE_ATTRIBUTE_TEMPORARY 一時的なストレージとして使われているファイル。
Offline FILE_ATTRIBUTE_OFFLINE ファイルのデータはすぐには使用できません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。 Azure Filesでは、オフライン ストレージ オプションはサポートされていません。
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED ファイルは、コンテンツ インデックス作成サービスによってインデックスを作成されません。
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA ユーザー データ ストリームは、バックグラウンド データ整合性スキャナーによって読み取られるわけではありません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。

解説

ターゲットを既存のディレクトリにすることはできません。

プロパティを指定しない場合は、 または now の既定のpreserve動作が設定されます。

注意

上記のファイル プロパティは、SMB クライアントで使用できるファイル システム プロパティとは異なります。 SMB クライアントは、これらのプロパティ値の読み取り、書き込み、または変更を行うことはできません。

Rename Fileは、共有の読み取り専用コピーである共有スナップショットではサポートされていません。 共有スナップショットでこの操作を実行しようとすると、サービスはエラー状態 400 (無効なクエリ パラメーター値) を返します。

ファイルにアクティブなリースがある場合、クライアントはファイルの名前を変更するために、要求で有効なリース ID を指定する必要があります。 クライアントがリース ID を指定しない場合、または無効なリース ID を指定した場合、Azure Filesは状態コード 412 (前提条件に失敗) を返します。 クライアントがリース ID を指定していても、ファイルにアクティブなリースがない場合、Azure Filesは状態コード 412 (前提条件に失敗しました) も返します。

関連項目

ファイルに対する操作