ファイル名の変更

  • [アーティクル]

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

プロトコルの可用性

有効なファイル共有プロトコル 利用できる
SMB はい
NFS なし

依頼

Rename File 要求は次のように構築できます。 HTTPS をお勧めします。

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

次のように、要求 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 必須。 名前を変更するファイルの完全な URI。
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: { preserve ¦ <SDDL> ¦ <binary> } x-ms-file-permission-key が指定されていない場合は省略可能です。 このアクセス許可は、セキュリティ記述子定義言語 (SDDL) または (バージョン 2024-11-04 以降) base64 でエンコードされたバイナリ セキュリティ記述子形式で指定されたファイル セキュリティ記述子です。 x-ms-file-permission-format ヘッダーで使用する形式を指定できます。 このヘッダーは、アクセス許可のサイズが 8 kibibytes (KiB) 以下の場合に使用できます。 それ以外の場合は、x-ms-file-permission-keyを使用できます。 指定する場合、このアクセス許可には、所有者、グループ、および随意アクセス制御リスト 必要があります。 既存の値を変更しない場合は、preserve の値を渡すことができます。

両方ではなく、x-ms-file-permission または x-ms-file-permission-keyを指定できます。
x-ms-file-permission-format: { sddl ¦ binary } 随意。 バージョン 2024-11-04 以降。 x-ms-file-permission で渡される値が SDDL 形式かバイナリ形式かを指定します。 x-ms-file-permission-key が preserveに設定されている場合は、このヘッダーを設定しないでください。 x-ms-file-permission-key が preserve以外の値に設定されていて、このヘッダーが設定されていない場合は、sddl の既定値が使用されます。
x-ms-file-permission-key x-ms-file-permission が指定されていない場合は省略可能です。 ファイルに設定するアクセス許可のキー。 これは、Create-Permission API を使用して作成できます。

両方ではなく、x-ms-file-permission または x-ms-file-permission-keyを指定できます。
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) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Blob Storage」を参照してください。
x-ms-meta-name:value 随意。 ファイルの名前と値のペアを設定します。

この操作を呼び出すたびに、ファイルにアタッチされているすべての既存のメタデータが置き換えられます。

メタデータ名は、C# 識別子の名前付け規則に従う必要があります。
x-ms-file-request-intent ヘッダー Authorization OAuth トークンを指定する場合は必須です。 許容される値は backupです。 このヘッダーは、Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action または Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action が、Authorization ヘッダーを使用して承認された ID に割り当てられた RBAC ポリシーに含まれている場合に付与されるように指定します。 バージョン 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 File の場合にのみ指定する必要があります。 このヘッダーは、他のコピー ソースの種類ではサポートされていません。 詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。

要求本文

何一つ。

応答

応答には、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 との互換性を提供するために表示されます。

備考

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

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

手記

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

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

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

関連項目

ファイルに対する操作