Scenes - Create Satellite Data Ingestion Job

リファレンス

サービス:: Azure Data Manager for Agriculture

API バージョン:: 2023-11-01-preview

サテライトデータインジェストジョブを作成します。

PUT {endpoint}/scenes/satellite/ingest-data/{jobId}?api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
jobId	path	True	string	ユーザーによって提供される JobId。
api-version	query	True	string	要求された API バージョン

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに対して有効なベアラートークンを指定してください。以前に認証されていない呼び出しを試した場合は、ブラウザーキャッシュをクリアする必要がある場合があることに注意してください。

要求本文

名前	必須	型	説明
associatedResource	True	GeoResource	リソースの種類とリソース ID を格納するためのスキーマ。
collection	True	string	サテライトデータの収集。使用可能な値: sentinel-2-l2a、sentinel-2-l1c。
partyId	True	string	パーティ ID。
credentials		OAuthClientCredentials	clientId clientSecret 認証の OAuthClientCredentials。
data		SatelliteData	SatelliteIngestionJobRequest のデータモデル。
description		string	リソースの説明テキスト。
endDateTime		string	[終了日]。
itemId		string	Sentinel ハブからシーンを取得するために使用される項目 ID。
name		string	リソースを識別する名前
properties			リソースに属するキー値ペアのコレクション。各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。
provider		SatelliteDataProvider	サテライトデータのプロバイダー。使用可能な値: SentinelHub。
startDateTime		string	[開始日]。

応答

名前	型	説明
202 Accepted	SatelliteDataIngestionJob	同意
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

202 Accepted

SatelliteDataIngestionJob

同意

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに対して有効なベアラートークンを指定してください。以前に認証されていない呼び出しを試した場合は、ブラウザーキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

Scenes_CreateSatelliteDataIngestionJob

要求のサンプル

HTTP

PUT {endpoint}/scenes/satellite/ingest-data/JOB123?api-version=2023-11-01-preview

{
  "associatedResource": {
    "type": "Field",
    "id": "Field123"
  },
  "partyId": "PARTY123",
  "startDateTime": "2020-04-16T10:14:12Z",
  "endDateTime": "2021-04-16T10:14:12Z",
  "provider": "SentinelHub",
  "credentials": {
    "kind": "OAuthClientCredentials",
    "clientId": "string",
    "clientSecret": {
      "keyVaultUri": "https://<keyvaultname>.vault.azure.net/",
      "keyName": "string",
      "keyVersion": "string"
    }
  },
  "collection": "sentinel-2-l2a",
  "name": "North Farm 2019 satellite imagery",
  "description": "Test job",
  "data": {
    "imageFormats": [
      "Tif"
    ],
    "imageNames": [
      "NDVI"
    ],
    "imageResolutions": [
      10
    ]
  },
  "properties": {
    "Region": "Asia"
  }
}

応答のサンプル

状態コード:: 202

{
  "durationInSeconds": 12.4,
  "id": "satellite-job",
  "status": "Created",
  "message": "Created job 'satellite-job' to fetch satellite data for boundary 'BOUNDARY123' for startDate '01/01/2019 00:00:00' and endDate '03/30/2019 00:00:00' (both inclusive)",
  "createdDateTime": "2021-04-16T07:56:05Z",
  "lastActionDateTime": "2021-04-16T07:56:05Z",
  "startDateTime": "2021-04-16T07:56:05Z",
  "endDateTime": "2021-04-16T07:56:05Z",
  "partyId": "PARTY123",
  "associatedResource": {
    "type": "Field",
    "id": "Field123"
  },
  "credentials": {
    "kind": "OAuthClientCredentials",
    "clientId": "string",
    "clientSecret": {
      "keyVaultUri": "string",
      "keyName": "string",
      "keyVersion": "string"
    }
  },
  "collection": "sentinel-2-l2a",
  "provider": "SentinelHub",
  "name": "North Farm 2019 satellite imagery",
  "description": "Test job",
  "properties": {
    "Region": "Asia"
  }
}

定義

名前	説明
AuthCredentialsKind	サポートされているさまざまな種類の AuthCredentials の列挙型。
Error	Azure AgPlatform サービスからのエラー。
ErrorResponse	Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。
FarmHierarchyGeoResourceType	リソースの種類。
GeoResource	リソースの種類とリソース ID を格納するためのスキーマ。
InnerError	エラーの一覧を含む内部エラー。InnerError リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
KeyVaultProperties	キーコンテナーのプロパティ。
OAuthClientCredentials	clientId clientSecret 認証の OAuthClientCredentials。
SatelliteData	SatelliteIngestionJobRequest のデータモデル。
SatelliteDataIngestionJob	サテライトデータインジェストジョブのスキーマ。
SatelliteDataProvider	サテライトデータのプロバイダー。使用可能な値: SentinelHub。

AuthCredentialsKind

サポートされているさまざまな種類の AuthCredentials の列挙型。

名前	型	説明
ApiKeyAuthCredentials	string
OAuthClientCredentials	string

Error

Azure AgPlatform サービスからのエラー。

名前	型	説明
code	string	サーバー定義のエラーコードのセット。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
message	string	人が判読できるエラーの表現。
target	string	エラーのターゲット。

ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。

名前	型	説明
error	Error	Azure AgPlatform サービスからのエラー。
traceId	string	一意のトレース ID。

FarmHierarchyGeoResourceType

リソースの種類。

名前	型	説明
ApplicationData	string
Field	string
HarvestData	string
PlantTissueAnalysis	string
PlantingData	string
Prescription	string
SeasonalField	string
TillageData	string
Zone	string

GeoResource

リソースの種類とリソース ID を格納するためのスキーマ。

名前	型	説明
id	string	リソース ID。
type	FarmHierarchyGeoResourceType	リソースの種類。

InnerError

エラーの一覧を含む内部エラー。InnerError リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前	型	説明
code	string	を含むエラーによって提供されたエラーコードよりも具体的なエラーコード。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError リファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

KeyVaultProperties

キーコンテナーのプロパティ。

名前	型	説明
keyName	string	Key Vault キーの名前。
keyVaultUri	string	キーコンテナーの URI。
keyVersion	string	Key Vault キーのバージョン。

OAuthClientCredentials

clientId clientSecret 認証の OAuthClientCredentials。

名前	型	説明
clientId	string	プロバイダーに関連付けられている ClientId。
clientSecret	KeyVaultProperties	キーコンテナーのプロパティ。
kind	string: OAuthClientCredentials	サポートされているさまざまな種類の AuthCredentials の列挙型。

SatelliteData

SatelliteIngestionJobRequest のデータモデル。

名前	型	説明
imageFormats	string[]	ImageFormats の一覧。使用可能な値: TIF。
imageNames	string[]	ImageNames の一覧。
imageResolutions	number[]	ImageResolutions の一覧 (メートル単位)。使用可能な値: 10、20、60。

SatelliteDataIngestionJob

サテライトデータインジェストジョブのスキーマ。

名前	型	説明
associatedResource	GeoResource	リソースの種類とリソース ID を格納するためのスキーマ。
collection	string	サテライトデータの収集。使用可能な値: sentinel-2-l2a、sentinel-2-l1c。
createdBy	string	ユーザー/テナント ID によって作成されます。
createdDateTime	string	dateTime で作成されたジョブ。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
credentials	OAuthClientCredentials	clientId clientSecret 認証の OAuthClientCredentials。
data	SatelliteData	SatelliteIngestionJobRequest のデータモデル。
description	string	リソースの説明テキスト。
durationInSeconds	number	ジョブの実行時間 (秒単位)。
endDateTime	string	[終了日]。
endTime	string	ジョブの終了時刻 (使用可能な場合)。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
errorCode	string	ジョブが失敗した場合のエラーコード。
id	string	一意のジョブ ID。
itemId	string	Sentinel ハブからシーンを取得するために使用される項目 ID。
lastActionDateTime	string	ジョブは dateTime で最後に処理されました。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
message	string	ジョブの詳細をキャプチャするステータスメッセージ。
modifiedBy	string	ユーザー/テナント ID によって変更されます。
name	string	リソースを識別する名前
partyId	string	パーティ ID。
properties		リソースに属するキー値ペアのコレクション。各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。
provider	SatelliteDataProvider	サテライトデータのプロバイダー。使用可能な値: SentinelHub。
startDateTime	string	[開始日]。
startTime	string	ジョブの開始時刻 (使用可能な場合)。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
status	string	ジョブの状態。指定できる値は、'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled' です。

SatelliteDataProvider

サテライトデータのプロバイダー。使用可能な値: SentinelHub。

名前	型	説明
SentinelHub	string

次の方法で共有

Scenes - Create Satellite Data Ingestion Job

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

Scenes_CreateSatelliteDataIngestionJob

要求のサンプル

応答のサンプル

定義

AuthCredentialsKind

Error

ErrorResponse

FarmHierarchyGeoResourceType

GeoResource

InnerError

KeyVaultProperties

OAuthClientCredentials

SatelliteData

SatelliteDataIngestionJob

SatelliteDataProvider

その他のリソース