Factories - Get Git Hub Access Token

Get GitHub Access Token.

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

URI Parameters

Name In Required Type Description
factoryName
path True
  • string

The factory name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

The resource group name.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The subscription identifier.

api-version
query True
  • string

The API version.

Request Body

Name Required Type Description
gitHubAccessCode True
  • string

GitHub access code.

gitHubAccessTokenBaseUrl True
  • string

GitHub access token base URL.

gitHubClientId
  • string

GitHub application client ID.

gitHubClientSecret

GitHub bring your own app client secret information.

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_GetGitHubAccessToken

Sample Request

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

{
  "gitHubAccessCode": "some",
  "gitHubClientId": "some",
  "gitHubAccessTokenBaseUrl": "some"
}

Sample Response

Date: Fri, 7 Sep 2018 18: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
{
  "gitHubAccessToken": "myAccessTokenExample"
}

Definitions

CloudError

The object that defines the structure of an Azure Data Factory error response.

GitHubAccessTokenRequest

Get GitHub access token request definition.

GitHubAccessTokenResponse

Get GitHub access token response definition.

GitHubClientSecret

Client secret information for factory's bring your own app repository configuration.

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.

GitHubAccessTokenRequest

Get GitHub access token request definition.

Name Type Description
gitHubAccessCode
  • string

GitHub access code.

gitHubAccessTokenBaseUrl
  • string

GitHub access token base URL.

gitHubClientId
  • string

GitHub application client ID.

gitHubClientSecret

GitHub bring your own app client secret information.

GitHubAccessTokenResponse

Get GitHub access token response definition.

Name Type Description
gitHubAccessToken
  • string

GitHub access token.

GitHubClientSecret

Client secret information for factory's bring your own app repository configuration.

Name Type Description
byoaSecretAkvUrl
  • string

Bring your own app client secret AKV URL.

byoaSecretName
  • string

Bring your own app client secret name in AKV.