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

Factories - Get Data Plane Access

获取数据平面访问权限。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess?api-version=2018-06-01

URI 参数

名称 必需 类型 说明
factoryName
path True

string

工厂名称。

正则表达式模式: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

资源组名称。

正则表达式模式: ^[-\w\._\(\)]+$

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

API 版本。

请求正文

名称 类型 说明
accessResourcePath

string

获取相对于工厂的访问权限的资源路径。 目前仅支持与工厂资源对应的空字符串。

expireTime

string

令牌的过期时间。 令牌的最大持续时间为 8 小时,默认情况下,令牌将在 8 小时后过期。

permissions

string

具有数据平面访问权限的字符串。 目前仅支持授予只读访问权限的“r”。

profileName

string

配置文件的名称。 目前仅支持默认值。 默认值为 DefaultProfile。

startTime

string

令牌的开始时间。 如果未指定,将使用当前时间。

响应

名称 类型 说明
200 OK

AccessPolicyResponse

没问题。

Other Status Codes

CloudError

从Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Factories_GetDataPlaneAccess

示例请求

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/getDataPlaneAccess?api-version=2018-06-01

{
  "permissions": "r",
  "accessResourcePath": "",
  "profileName": "DefaultProfile",
  "startTime": "2018-11-10T02:46:20.2659347Z",
  "expireTime": "2018-11-10T09:46:20.2659347Z"
}

示例响应

Date: Wed, 07 Nov 2018 03:41:57 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11996
x-ms-request-id: 82bc20d2-4bec-496d-a1c8-3f7746fed307
x-ms-correlation-request-id: 82bc20d2-4bec-496d-a1c8-3f7746fed307
{
  "policy": {
    "permissions": "r",
    "accessResourcePath": "",
    "profileName": "DefaultProfile",
    "startTime": "2018-11-10T02:46:20.2659347Z",
    "expireTime": "2018-11-10T09:46:20.2659347Z"
  },
  "dataPlaneUrl": "https://rpeastus.svc.datafactory.azure.com:4433",
  "accessToken": "**********"
}

定义

名称 说明
AccessPolicyResponse

获取数据平面只读令牌响应定义。

CloudError

定义Azure 数据工厂错误响应结构的对象。

UserAccessPolicy

获取数据平面只读令牌请求定义。

AccessPolicyResponse

获取数据平面只读令牌响应定义。

名称 类型 说明
accessToken

string

数据平面只读访问令牌。

dataPlaneUrl

string

数据平面服务基 URL。

policy

UserAccessPolicy

用户访问策略。

CloudError

定义Azure 数据工厂错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。

error.details

CloudError[]

包含其他错误详细信息的数组。

error.message

string

错误消息。

error.target

string

与错误关联的请求中的属性名称/路径。

UserAccessPolicy

获取数据平面只读令牌请求定义。

名称 类型 说明
accessResourcePath

string

获取相对于工厂的访问权限的资源路径。 目前仅支持与工厂资源对应的空字符串。

expireTime

string

令牌的过期时间。 令牌的最大持续时间为 8 小时,默认情况下,令牌将在 8 小时后过期。

permissions

string

具有数据平面访问权限的字符串。 目前仅支持授予只读访问权限的“r”。

profileName

string

配置文件的名称。 目前仅支持默认值。 默认值为 DefaultProfile。

startTime

string

令牌的开始时间。 如果未指定,将使用当前时间。