IFileStagingArtifact インターフェイス

定義

public interface IFileStagingArtifact

type IFileStagingArtifact = interface

Public Interface IFileStagingArtifact

派生

Microsoft.Azure.Batch.FileStaging.SequentialFileStagingArtifact

注釈

IFileStagingArtifact を使用すると、 JobOperations.AddTaskAsync や CloudJob.AddTaskAsync などのタスク関連操作の一部として、アプリケーションでファイルをクラウドにアップロードするプロセスに関する情報をカスタマイズして取得できます。 たとえば、アプリケーションはこの情報を使用して、アップロード プロセスの一環として Azure Storage で作成されたコンテナーについて調べる場合があります。

JobOperations.AddTaskAsync が呼び出されると、Batch クライアントはコレクション内の Batch サービスにタスクを送信します。 各コレクションが処理されると、Batch クライアントは、そのコレクションに対してファイル ステージングを実行します。タスクを調べて、いずれかが を指定しているかどうかを確認し、指定 FilesToStageされている場合は FilesToStage コレクション内の の各型の IFileStagingProvider ディクショナリ エントリを作成します。 ディクショナリ エントリのキーは Type IFileStagingProvider の であり、値は IFileStagingArtifact の対応する実装のインスタンスです。 たとえば、FilesToStage に (Microsoft.Azure.Batch.FileStaging ライブラリの) 1 つ以上の FileToStage オブジェクトが含まれている場合、ディクショナリには、キーが typeof(FileToStage) で、値が SequentialFileStagingArtifact のインスタンスであるエントリが含まれます。

タスクの追加操作が完了したとき、またはアプリケーションがマルチスレッドの場合はタスクの追加操作中に、ディクショナリを調べて、各 IFileStagingArtifact を適切な型に変換して、型固有の情報を取得できます。 たとえば、タスクの追加操作で 1 つ以上の FileToStage オブジェクトが指定されている場合は、typeof(FileToStage) でキー付けされたディクショナリ エントリを見つけ、値を SequentialFileStagingArtifact にキャストし、SequentialFileStagingArtifact.BlobContainerCreated プロパティを調べて、アップロード プロセスによって Azure Storage に BLOB コンテナーが作成されたかどうか、そのコンテナーの名前を確認できます。 この例は、自動的に作成されたコンテナーをクリーンアップする場合に役立ちます。

(単一タスクのタスクの追加操作も同様に機能しますが、マルチタスクのタスクの追加操作では、タスクのコレクションごとにディクショナリがあり、ディクショナリは で ConcurrentBag<T>収集されますが、単一タスクのタスクの追加操作では 1 つのディクショナリしかありません)。

単一タスクのタスクの追加操作では、ディクショナリを使用して、適切なエントリを事前に設定することで、ファイルのステージング プロセスをカスタマイズすることもできます。 たとえば、FileToStage オブジェクトのグループの を NamingFragment 制御するとします。 その後、AddTaskAsync に渡す前に、 で { typeof(FileToStage), new SequentialFileStagingArtifact { NamingFragment = "myname" } } ディクショナリを初期化できます。 IFileStagingProvider の FileToStage 実装では、独自のファイルを作成する代わりに、SequentialFileStagingArtifact を使用します。 (この機能は、複数タスクのタスクの追加操作では使用できません。

カスタム IFileStagingProviderを開発している場合は、IFileStagingArtifact が発生する可能性もあります。 この場合は、通常、IFileStagingArtifact のカスタム実装を作成して、ファイルのステージング プロセスに関する実装固有の情報を報告します。

プロパティ

適用対象