Skip to content

[Datafactory]Adding get Dataplane access API #3957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anuchandy merged 5 commits into from
Nov 20, 2018
Merged

[Datafactory]Adding get Dataplane access API #3957

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd07c0c
Adding get Dataplane readonly token API
hvermis Sep 19, 2018
19c65d6
Updated the casing and the example
hvermis Sep 20, 2018
cde33e6
Updating dataplane access APIs
hvermis Nov 7, 2018
dd7057a
Merge branch 'master' of https://github.com/azure/azure-rest-api-specs
hvermis Nov 7, 2018
066ef32
Updating examples
hvermis Nov 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions ...ion/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,57 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneReadOnlyToken": {
"post": {
"tags": [
"factories"
],
"operationId": "Factories_GetDataPlaneReadOnlyToken",
"x-ms-examples": {
"Factories_GetDataPlaneReadOnlyToken": {
"$ref": "./examples/Factories_GetDataPlaneReadOnlyToken.json"
}
},
"description": "Get Data Plane read only token.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "dataPlaneReadOnlyTokenRequest",
"description": "Data Plane read only access token request definition.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DataPlaneReadOnlyTokenRequest"
}
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/DataPlaneReadOnlyTokenResponse"
}
},
"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": [
Expand Down Expand Up @@ -3258,6 +3309,40 @@
}
}
},
"DataPlaneReadOnlyTokenRequest": {
"description": "Get Data Plane read only token request definition.",
"properties": {
"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"
}
}
},
"DataPlaneReadOnlyTokenResponse": {
"description": "Get Data Plane read only token response definition.",
"properties": {
"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"
},
"accessToken": {
"description": "Data Plane read only access token.",
"type": "string"
},
"dataPlaneUrl": {
"description": "Data Plane service base URL.",
"type": "string"
}
}
},

@anuchandy anuchandy Nov 19, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this model is only used as response, we could mark properties as readonly

"FactoryProperties": {
"description": "Factory resource properties.",
"properties": {
Expand Down
29 changes: 29 additions & 0 deletions ...Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneReadOnlyToken.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"dataPlaneReadOnlyTokenRequest": {
"startTime": "2018-09-18T00:38:48.5770529Z",
"expireTime": "2018-09-18T08:38:48.5770529Z"
},
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {
"Date": "Wed, 19 Sep 2018 00:42:45 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "1199",
"x-ms-request-id": "da630ed9-35e4-41cd-9f93-be14dbcbd099",
"x-ms-correlation-request-id": "da630ed9-35e4-41cd-9f93-be14dbcbd099"
},
"body": {
"accessToken": "myReadOnlyAccessTokenExample",
"startTime": "2018-09-18T00:38:48.5770529Z",
"expireTime": "2018-09-18T08:38:48.5770529Z",
"dataPlaneUrl": "https://rpeastus2euap.svc.datafactory.azure.com:4433"
}
}
}
}