diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index ba0711ebb626..54f3381539eb 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -446,6 +446,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess": { + "post": { + "tags": [ + "factories" + ], + "operationId": "Factories_GetDataPlaneAccess", + "x-ms-examples": { + "Factories_GetDataPlaneAccess": { + "$ref": "./examples/Factories_GetDataPlaneAccess.json" + } + }, + "description": "Get Data Plane access.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "policy", + "description": "Data Plane user access policy definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserAccessPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AccessPolicyResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { "get": { "tags": [ @@ -3541,6 +3592,48 @@ } } }, + "UserAccessPolicy": { + "description": "Get Data Plane read only token request definition.", + "properties": { + "permissions" : { + "description": "The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access.", + "type": "string" + }, + "accessResourcePath" : { + "description": "The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource.", + "type": "string" + }, + "profileName" : { + "description": "The name of the profile. Currently only the default is supported. The default value is DefaultProfile.", + "type": "string" + }, + "startTime": { + "description": "Start time for the token. If not specified the current time will be used.", + "type": "string" + }, + "expireTime": { + "description": "Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours.", + "type": "string" + } + } + }, + "AccessPolicyResponse": { + "description": "Get Data Plane read only token response definition.", + "properties": { + "policy" : { + "description": "The user access policy.", + "$ref": "#/definitions/UserAccessPolicy" + }, + "accessToken": { + "description": "Data Plane read only access token.", + "type": "string" + }, + "dataPlaneUrl": { + "description": "Data Plane service base URL.", + "type": "string" + } + } + }, "FactoryProperties": { "description": "Factory resource properties.", "properties": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json new file mode 100644 index 000000000000..4f1da8e9e906 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "policy": { + "permissions": "r", + "accessResourcePath": "", + "profileName": "DefaultProfile", + "startTime": "2018-11-10T02:46:20.2659347Z", + "expireTime": "2018-11-10T09:46:20.2659347Z" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "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" + }, + "body": { + "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": "**********" + } + } + } +} \ No newline at end of file