你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Connector - Validate

验证连接器。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/validate?api-version=2022-11-01-preview

URI 参数

名称 必需 类型 说明
connectorName
path True

string

资源的名称。

location
path True

string

Azure 区域的名称。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

ValidateOperationResult

没问题。 请求已成功。

202 Accepted

接受 - 在异步操作完成之前返回此状态。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ValidateConnectorSuccess

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/connectors/connectorName/validate?api-version=2022-11-01-preview

示例响应

{
  "properties": {
    "isConnectionAvailable": true,
    "reportStartTimeUtc": "2020-07-12T22:05:09Z",
    "reportEndTimeUtc": "2020-07-12T22:06:09Z",
    "authType": "secret",
    "validationDetail": [
      {
        "name": "TargetExistence",
        "description": "The target existence is validated",
        "result": "success"
      },
      {
        "name": "TargetNetworkAccess",
        "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.",
        "result": "warning"
      }
    ]
  }
}
azure-AsyncOperation: http://azure.async.operation/status

定义

名称 说明
AuthType

身份验证类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ValidateOperationResult

链接器验证操作结果。

ValidationResultItem

链接器验证项。

ValidationResultStatus

验证结果

AuthType

身份验证类型。

名称 类型 说明
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ValidateOperationResult

链接器验证操作结果。

名称 类型 说明
properties.authType

AuthType

身份验证类型。

properties.isConnectionAvailable

boolean

一个布尔值,指示连接是否可用

properties.linkerName

string

链接器名称。

properties.reportEndTimeUtc

string

验证报告的结束时间。

properties.reportStartTimeUtc

string

验证报告的开始时间。

properties.sourceId

string

链接器源应用程序的资源 ID。

properties.targetId

string

目标服务的资源 ID。

properties.validationDetail

ValidationResultItem[]

验证结果的详细信息

resourceId

string

已验证链接器 ID。

status

string

验证操作状态。

ValidationResultItem

链接器验证项。

名称 类型 说明
description

string

验证项的显示名称

errorCode

string

验证结果的错误代码

errorMessage

string

验证结果的错误消息

name

string

验证项名称。

result

ValidationResultStatus

验证结果

ValidationResultStatus

验证结果

名称 类型 说明
failure

string

success

string

warning

string