FarmOperationsDataIngestion.CreateJobAsync メソッド

リファレンス

定義

名前空間:: Azure.Verticals.AgriFood.Farming

アセンブリ:: Azure.Verticals.AgriFood.Farming.dll

パッケージ:: Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

ソース:: FarmOperationsDataIngestion.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ファーム操作データインジェストジョブを作成します。

public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CreateJobAsync (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CreateJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>

Public Overridable Function CreateJobAsync (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))

パラメーター

waitUntil: WaitUntil

Completed メソッドがサービスで実行時間の長い操作が完了するまで戻るのを待機する必要がある場合。 Started 操作を開始した後にが返される場合は。実行時間の長い操作の詳細については、「 Azure.Core Long-Running 操作のサンプル」を参照してください。

jobId: String

ユーザーが指定したジョブ ID。

content: RequestContent

要求の本文として送信するコンテンツ。要求本文スキーマの詳細については、以下の「解説」セクションを参照してください。

context: RequestContext

要求コンテキスト。これは、呼び出しごとにクライアントパイプラインの既定の動作をオーバーライドできます。

戻り値

Task<Operation<BinaryData>>

Operation<T>サービスに対する非同期操作が完了すると、 BinaryData オブジェクトを格納するサービスの。操作の最終値の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

jobId または content が null です。

ArgumentException

jobId は空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターと要求コンテンツを使用して CreateJobAsync を呼び出す方法と、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetFarmOperationsDataIngestionClient(<2022-11-01-preview>);

var data = new {
    partyId = "<partyId>",
    authProviderId = "<authProviderId>",
    startYear = 1234,
};

var operation = await client.CreateJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data));

BinaryData data = operation.Value;
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("authProviderId").ToString());
Console.WriteLine(result.GetProperty("startYear").ToString());

このサンプルでは、すべてのパラメーターと要求コンテンツを使用して CreateJobAsync を呼び出す方法と、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetFarmOperationsDataIngestionClient(<2022-11-01-preview>);

var data = new {
    partyId = "<partyId>",
    authProviderId = "<authProviderId>",
    operations = new[] {
        "<String>"
    },
    startYear = 1234,
    isIncremental = true,
    name = "<name>",
    description = "<description>",
    properties = new {
        key = new {},
    },
};

var operation = await client.CreateJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data));

BinaryData data = operation.Value;
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("authProviderId").ToString());
Console.WriteLine(result.GetProperty("operations")[0].ToString());
Console.WriteLine(result.GetProperty("startYear").ToString());
Console.WriteLine(result.GetProperty("isIncremental").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("durationInSeconds").ToString());
Console.WriteLine(result.GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errorCode").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
Console.WriteLine(result.GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("modifiedBy").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());

注釈

要求と応答のペイロードの JSON スキーマを次に示します。

要求本文:

の FarmOperationDataIngestionJobスキーマ:

{
  partyId: string, # Required. Party Id.
  authProviderId: string, # Required. Authentication provider Id.
  operations: [string], # Optional. List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.
  startYear: number, # Required. Start Year (Minimum = 2000, Maximum = CurrentYear).
  isIncremental: boolean, # Optional. Use this to pull only the incremental changes from the last run.
  id: string, # Optional. Unique job id.
  status: string, # Optional. Status of the job.
Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  durationInSeconds: number, # Optional. Duration of the job in seconds.
  message: string, # Optional. Status message to capture more details of the job.
  errorCode: string, # Optional. Error Code when job failed.
  createdDateTime: string (ISO 8601 Format), # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  lastActionDateTime: string (ISO 8601 Format), # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  startTime: string (ISO 8601 Format), # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  endTime: string (ISO 8601 Format), # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}

応答本文:

の FarmOperationDataIngestionJobスキーマ:

{
  partyId: string, # Required. Party Id.
  authProviderId: string, # Required. Authentication provider Id.
  operations: [string], # Optional. List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.
  startYear: number, # Required. Start Year (Minimum = 2000, Maximum = CurrentYear).
  isIncremental: boolean, # Optional. Use this to pull only the incremental changes from the last run.
  id: string, # Optional. Unique job id.
  status: string, # Optional. Status of the job.
Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  durationInSeconds: number, # Optional. Duration of the job in seconds.
  message: string, # Optional. Status message to capture more details of the job.
  errorCode: string, # Optional. Error Code when job failed.
  createdDateTime: string (ISO 8601 Format), # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  lastActionDateTime: string (ISO 8601 Format), # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  startTime: string (ISO 8601 Format), # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  endTime: string (ISO 8601 Format), # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}

適用対象

次の方法で共有

FarmOperationsDataIngestion.CreateJobAsync メソッド

定義

パラメーター

戻り値

例外

例

注釈

適用対象

その他のリソース