O Auth Providers - Create Cascade Delete Job

  • Reference
Service:
Azure Data Manager for Agriculture
API Version:
2023-11-01-preview

Create cascade delete job for oauthProvider resource.

PUT {endpoint}/oauth/providers/cascade-delete/{jobId}?oauthProviderId={oauthProviderId}&api-version=2023-11-01-preview

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
jobId
 path True

string

Job Id supplied by end user.
api-version
 query True

string

The requested API version
oauthProviderId
 query True

string

Id of the application data.

Request Header

Name Required Type Description
Authorization True

string

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name Type Description
202 Accepted

OAuthProviderCascadeDeleteJob

Accepted
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

OAuthProviders_CreateCascadeDeleteJob

Sample request

PUT {endpoint}/oauth/providers/cascade-delete/JOB123?oauthProviderId=OAuthProvider123&api-version=2023-11-01-preview

Sample response

Status code:
202 
{
  "oauthProviderId": "JOB123",
  "status": "Waiting",
  "message": "Created cascade delete job for 'oauthprovider' resource with id 'OAuthProvider123'.",
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z"
}

Definitions

Name Description
Error

An error from the Azure AgPlatform service.
ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
OAuthProviderCascadeDeleteJob

Schema of oauth provider cascade delete job.

Error

An error from the Azure AgPlatform service.

Name Type Description
code

string

Server-defined set of error codes.
details

Error[]

Array of details about specific errors that led to this reported error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message

string

Human-readable representation of the error.
target

string

Target of the error.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name Type Description
error

Error

An error from the Azure AgPlatform service.
traceId

string

Unique trace Id.

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name Type Description
code

string

Specific error code than was provided by the containing error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

OAuthProviderCascadeDeleteJob

Schema of oauth provider cascade delete job.

Name Type Description
createdBy

string

Created by user/tenant id.
createdDateTime

string

Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
description

string

Textual description of the resource.
durationInSeconds

number

Duration of the job in seconds.
endTime

string

Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
errorCode

string

Error Code when job failed.
id

string

Unique job id.
lastActionDateTime

string

Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
message

string

Status message to capture more details of the job.
modifiedBy

string

Modified by user/tenant id.
name

string

Name to identify resource.
oauthProviderId

string

The id of the oauth provider.
properties

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.
startTime

string

Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
status

string

Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.