Factories - Get Data Plane Access
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 Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string |
The factory name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
The subscription identifier. |
api-version
|
query | True |
string |
The API version. |
Request Body
Name | Type | Description |
---|---|---|
accessResourcePath |
string |
The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. |
expireTime |
string |
Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. |
permissions |
string |
The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. |
profileName |
string |
The name of the profile. Currently only the default is supported. The default value is DefaultProfile. |
startTime |
string |
Start time for the token. If not specified the current time will be used. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Data Factory service. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Factories_GetDataPlaneAccess
Sample request
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"
}
Sample response
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": "**********"
}
Definitions
Name | Description |
---|---|
Access |
Get Data Plane read only token response definition. |
Cloud |
The object that defines the structure of an Azure Data Factory error response. |
User |
Get Data Plane read only token request definition. |
AccessPolicyResponse
Get Data Plane read only token response definition.
Name | Type | Description |
---|---|---|
accessToken |
string |
Data Plane read only access token. |
dataPlaneUrl |
string |
Data Plane service base URL. |
policy |
The user access policy. |
CloudError
The object that defines the structure of an Azure Data Factory error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
UserAccessPolicy
Get Data Plane read only token request definition.
Name | Type | Description |
---|---|---|
accessResourcePath |
string |
The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. |
expireTime |
string |
Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. |
permissions |
string |
The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. |
profileName |
string |
The name of the profile. Currently only the default is supported. The default value is DefaultProfile. |
startTime |
string |
Start time for the token. If not specified the current time will be used. |