你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
O Auth Providers - Create Cascade Delete Job
为 oauthProvider 资源创建级联删除作业。
PUT {endpoint}/oauth/providers/cascade-delete/{jobId}?oauthProviderId={oauthProviderId}&api-version=2023-11-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net |
job
|
path | True |
string |
最终用户提供的作业 ID。 |
api-version
|
query | True |
string |
请求的 API 版本 |
oauth
|
query | True |
string |
应用程序数据的 ID。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
响应
名称 | 类型 | 说明 |
---|---|---|
202 Accepted |
已接受 |
|
Other Status Codes |
错误 Headers x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
Type:
apiKey
In:
header
示例
OAuthProviders_CreateCascadeDeleteJob
Sample Request
PUT {endpoint}/oauth/providers/cascade-delete/JOB123?oauthProviderId=OAuthProvider123&api-version=2023-11-01-preview
Sample Response
{
"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"
}
定义
名称 | 说明 |
---|---|
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
OAuth |
oauth 提供程序级联删除作业的架构。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
|
message |
string |
错误的用户可读表示形式。 |
target |
string |
错误的目标。 |
ErrorResponse
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。
名称 | 类型 | 说明 |
---|---|---|
error |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含的错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
OAuthProviderCascadeDeleteJob
oauth 提供程序级联删除作业的架构。
名称 | 类型 | 说明 |
---|---|---|
createdBy |
string |
由用户/租户 ID 创建。 |
createdDateTime |
string |
在 dateTime 创建的作业。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
description |
string |
资源的文本说明。 |
durationInSeconds |
number |
作业的持续时间(以秒为单位)。 |
endTime |
string |
作业结束时间(如果可用)。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
errorCode |
string |
作业失败时的错误代码。 |
id |
string |
唯一的作业 ID。 |
lastActionDateTime |
string |
上次执行作业的时间是 dateTime。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
message |
string |
用于捕获更多作业详细信息的状态消息。 |
modifiedBy |
string |
由用户/租户 ID 修改。 |
name |
string |
用于标识资源的名称。 |
oauthProviderId |
string |
oauth 提供程序的 ID。 |
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。 |
|
startTime |
string |
作业开始时间(如果可用)。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
status |
string |
作业的状态。 可能的值:“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。 |