O Auth Tokens - Create Cascade Delete Job

  • リファレンス
サービス:
Azure Data Manager for Agriculture
API バージョン:
2023-11-01-preview

OAuth トークンの削除ジョブを作成します。

PUT {endpoint}/oauth/tokens/remove/{jobId}?partyId={partyId}&oauthProviderId={oauthProviderId}&api-version=2023-11-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

uri

名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
jobId
 path True

string

エンド ユーザーによって提供されるジョブ ID。
api-version
 query True

string

要求された API バージョン
oauthProviderId
 query True

string

OAuthProvider の ID。
partyId
 query True

string

パーティの ID。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

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

応答

名前 型 説明
202 Accepted

CascadeDeleteJob

同意
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

OAuthTokens_CreateCascadeDeleteJob

要求のサンプル

PUT {endpoint}/oauth/tokens/remove/JOB123?partyId=PARTY123&oauthProviderId=OAUTHPROVIDER123&api-version=2023-11-01-preview

応答のサンプル

状態コード:
202 
{
  "id": "JOB123",
  "status": "Waiting",
  "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'OAUTHPROVIDER123' and partyId 'PARTY123'.",
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z",
  "partyId": "PARTY123",
  "resourceId": "OAUTHPROVIDER123",
  "resourceType": "oauthtokeninfo"
}

定義

名前 説明
CascadeDeleteJob

連鎖削除ジョブのスキーマ。
Error

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

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

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

ジョブの状態。 使用可能な値: 'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled'。

CascadeDeleteJob

連鎖削除ジョブのスキーマ。

名前 型 説明
createdDateTime

string

dateTime に作成されたジョブ。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
durationInSeconds

number

ジョブの期間 (秒単位)。
endTime

string

ジョブの終了時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
errorCode

string

ジョブが失敗したときのエラー コード。
id

string

一意のジョブ ID。
lastActionDateTime

string

ジョブは dateTime で最後に実行されました。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
message

string

ジョブの詳細をキャプチャするステータス メッセージ。
partyId

string

パーティ ID。
resourceId

string

リソースの ID。
resourceType

string

リソースの型。
startTime

string

ジョブの開始時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
status

JobStatus

ジョブの状態。 使用可能な値: 'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled'。

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。

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 してください。

JobStatus

ジョブの状態。 使用可能な値: 'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled'。

名前 型 説明
Cancelled

string

Failed

string

Running

string

Succeeded

string

Waiting

string