Abort Copy File
操作は Abort Copy File 保留中 Copy File の操作を取り消し、コピー先ファイルの長さと完全なメタデータを残します。 この操作は、バージョン 2015-02-21 以降に適用されます。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用可能 |
|---|---|
| SMB |
|
| NFS |
|
Request
要求は Abort Copy File 次のように構築できます。 HTTPS が推奨されます。
バージョン 2013-08-15 以降では、コピー先ファイルがソース ファイルと同じアカウントにある場合は、コピー先ファイルの共有アクセス署名を指定できます。 バージョン 2015-04-05 以降では、コピー先ファイルが別のストレージ アカウントにある場合は、共有アクセス署名を指定することもできます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=copy©id=<id> |
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 |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 この操作は、バージョン 2015-02-21 以降でのみ使用できます。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-copy-action:abort |
必須。 |
x-ms-lease-id:<ID> |
コピー先ファイルにアクティブなリースがある場合は必須です。 バージョン 2019-02-02 以降で使用できます。 |
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 に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
要求本文
[なし] :
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
status code
操作が正常に終了すると、ステータス コード 204 (No Content) が返されます。 状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答には追加の標準 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 場合は、ヘッダーの値と同じです。 この値は、表示可能な ASCII 文字が最大 1024 文字です。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、このヘッダーは応答に存在しません。 |
応答本文
[なし] :
承認
この操作を呼び出すことができるのは、アカウント所有者だけです。
解説
保留中 Copy File の操作を取り消すと、コピー先ファイルの x-ms-copy-status ヘッダーが に aborted設定されます。 コピー操作を取り消すと、コピー先ファイルの長さが 0 になります。 ただし、コピー先ファイルのメタデータには、ソース BLOB またはファイルからコピーされた新しい値が含まれるか、操作呼び出しで明示的に設定されます Copy File 。
キャンセルできるのは、保留中のコピー操作のみです。 完了または失敗したコピーを取り消そうとすると、競合エラーが発生します。 正しくないコピー ID を使用してコピー操作を取り消そうとすると、競合エラーも発生します。