ファイルのコピーを中止する
Abort Copy File
操作は、保留中の Copy File
操作を取り消し、コピー先ファイルの長さと完全なメタデータを残します。 この操作は、SMB プロトコルが有効なファイル共有ではバージョン 2015-02-21 以降でサポートされ、NFS プロトコルが有効なファイル共有ではバージョン 2025-05-05 以降でサポートされています。
プロトコルの可用性
有効なファイル共有プロトコル | 利用できる |
---|---|
SMB |
![]() |
NFS |
![]() |
依頼
Abort Copy File
要求は次のように構成されます。 HTTPS を使用することをお勧めします。
バージョン 2013-08-15 以降では、コピー先ファイルがソース ファイルと同じアカウントにある場合は、共有アクセス署名を指定できます。 バージョン 2015-04-05 以降では、コピー先ファイルが別のストレージ アカウントにある場合は、共有アクセス署名を指定することもできます。
方式 | 要求 URI | HTTP バージョン |
---|---|---|
置く | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=copy©id=<id> |
HTTP/1.1 |
次のように、要求 URI に表示されているパス コンポーネントを独自のコンポーネントに置き換えます。
パス コンポーネント | 形容 |
---|---|
myaccount |
ストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
mydirectorypath |
随意。 親ディレクトリへのパス。 |
myfile |
ファイルの名前。 |
パスの名前付け制限の詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
パラメーター | 形容 |
---|---|
timeout |
随意。 タイムアウト パラメーターは秒単位で表されます。 詳細については、「Azure Files 操作のタイムアウトの設定」を参照してください。 |
要求ヘッダー
必須および省略可能な要求ヘッダーについては、次の表で説明します。
一般的な要求ヘッダー
要求ヘッダー | 形容 |
---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
Date または x-ms-date |
必須。 要求の世界協定時刻 (UTC) を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 この操作は、SMB プロトコルが有効なファイル共有ではバージョン 2015-02-21 以降でサポートされ、NFS プロトコルが有効なファイル共有ではバージョン 2025-05-05 以降でサポートされています。 詳細については、Azure Storage サービス のバージョン管理のに関するページを参照してください。 |
x-ms-copy-action:abort |
必須。 |
x-ms-lease-id:<ID> |
コピー先ファイルにアクティブなリースがある場合に必要です。 バージョン 2019-02-02 以降で使用できます。 このヘッダーは、NFS プロトコルが有効になっているファイル共有に宛先ファイルがある場合は無視され、ファイル リースはサポートされません。 |
x-ms-client-request-id |
随意。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Files」を参照してください。 |
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 に存在する末尾のドットをトリミングするかどうかを指定します。 ターゲットが NFS プロトコルが有効なファイル共有上にある場合、このヘッダーは無視され、既定では末尾のドットがサポートされます。 詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
SMB のみの要求ヘッダー
何一つ。
NFS 要求ヘッダーのみ
何一つ。
要求本文
何一つ。
応答
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
状態コード
操作が成功すると、状態コード 204 (コンテンツなし) が返されます。 状態コードの詳細については、「状態コードとエラー コードを参照してください。
応答ヘッダー
この操作の応答には、次の表のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーも含まれる場合があります。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。
一般的な応答ヘッダー
応答ヘッダー | 形容 |
---|---|
x-ms-request-id |
このヘッダーは、作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 |
x-ms-version |
要求の実行に使用される Azure Files のバージョンを示します。 |
Date または x-ms-date |
応答が開始された時刻を示す UTC 日付/時刻値。 サービスによってこの値が生成されます。 |
x-ms-client-request-id |
このヘッダーを使用して、要求と対応する応答のトラブルシューティングを行うことができます。 このヘッダーの値は、要求に存在する場合、x-ms-client-request-id ヘッダーの値と同じです。 値は最大 1024 文字の ASCII 文字です。
x-ms-client-request-id ヘッダーが要求に存在しない場合、このヘッダーは応答に存在しません。 |
SMB のみの応答ヘッダー
何一つ。
NFS のみの応答ヘッダー
何一つ。
応答本文
何一つ。
認可
アカウント所有者のみがこの操作を呼び出すことができます。
備考
保留中の Copy File
操作を取り消すと、宛先ファイルの x-ms-copy-status
ヘッダーが aborted
に設定されます。 コピー操作をキャンセルすると、コピー先ファイルの長さが 0 になります。 ただし、コピー先ファイルのメタデータには、ソース BLOB またはファイルからコピーされた新しい値が含まれるか、Copy File
操作呼び出しで明示的に設定されます。
キャンセルできるのは、保留中のコピー操作のみです。 完了または失敗したコピーを取り消そうとすると、競合エラーが発生します。 正しくないコピー ID を使用してコピー操作を取り消そうとすると、競合エラーも発生します。