Factories - Configure Factory Repo

Updates a factory's repo information.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo?api-version=2018-06-01

URI Parameters

Name In Required Type Description
locationId
path True
  • string

The location identifier.

subscriptionId
path True
  • string

The subscription identifier.

api-version
query True
  • string

The API version.

Request Body

Name Type Description
factoryResourceId
  • string

The factory resource id.

repoConfiguration FactoryRepoConfiguration:

Git repo information of the factory.

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_ConfigureFactoryRepo

Sample Request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/providers/Microsoft.DataFactory/locations/East US/configureFactoryRepo?api-version=2018-06-01
{
  "factoryResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
  "repoConfiguration": {
    "type": "FactoryVSTSConfiguration",
    "projectName": "project",
    "tenantId": "",
    "accountName": "ADF",
    "repositoryName": "repo",
    "collaborationBranch": "master",
    "rootFolder": "/",
    "lastCommitId": ""
  }
}

Sample Response

Date: Tue, 19 Jun 2018 05:41:50 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1191
x-ms-request-id: c63640bd-3e5f-4ee0-bae1-cea74f761a7d
x-ms-correlation-request-id: c63640bd-3e5f-4ee0-bae1-cea74f761a7d
{
  "name": "exampleFactoryName",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
  "type": "Microsoft.DataFactory/factories",
  "properties": {
    "provisioningState": "Succeeded",
    "createTime": "2018-06-19T05:41:50.0041314Z",
    "version": "2018-06-01",
    "repoConfiguration": {
      "type": "FactoryVSTSConfiguration",
      "projectName": "project",
      "tenantId": "",
      "accountName": "ADF",
      "repositoryName": "repo",
      "collaborationBranch": "master",
      "rootFolder": "/",
      "lastCommitId": ""
    }
  },
  "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"",
  "location": "East US",
  "tags": {
    "exampleTag": "exampleValue"
  }
}

Definitions

CloudError

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

CMKIdentityDefinition

Managed Identity used for CMK.

EncryptionConfiguration

Definition of CMK for the factory.

Factory

Factory resource type.

FactoryGitHubConfiguration

Factory's GitHub repo information.

FactoryIdentity

Identity properties of the factory resource.

FactoryIdentityType

The identity type.

FactoryRepoUpdate

Factory's git repo information.

FactoryVSTSConfiguration

Factory's VSTS repo information.

GitHubClientSecret

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

GlobalParameterSpecification

Definition of a single parameter for an entity.

GlobalParameterType

Global Parameter type.

PublicNetworkAccess

Whether or not public network access is allowed for the data factory.

UserAssignedIdentitySpecification

Definition of a single user assigned identity for a factory.

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.

CMKIdentityDefinition

Managed Identity used for CMK.

Name Type Description
userAssignedIdentity
  • string

The resource id of the user assigned identity to authenticate to customer's key vault.

EncryptionConfiguration

Definition of CMK for the factory.

Name Type Description
identity

User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.

keyName
  • string

The name of the key in Azure Key Vault to use as Customer Managed Key.

keyVersion
  • string

The version of the key used for CMK. If not provided, latest version will be used.

vaultBaseUrl
  • string

The url of the Azure Key Vault used for CMK.

Factory

Factory resource type.

Name Type Description
eTag
  • string

Etag identifies change in the resource.

id
  • string

The resource identifier.

identity

Managed service identity of the factory.

location
  • string

The resource location.

name
  • string

The resource name.

properties.createTime
  • string

Time the factory was created in ISO8601 format.

properties.encryption

Properties to enable Customer Managed Key for the factory.

properties.globalParameters

List of parameters for factory.

properties.provisioningState
  • string

Factory provisioning state, example Succeeded.

properties.publicNetworkAccess

Whether or not public network access is allowed for the data factory.

properties.repoConfiguration FactoryRepoConfiguration:

Git repo information of the factory.

properties.version
  • string

Version of the factory.

tags
  • object

The resource tags.

type
  • string

The resource type.

FactoryGitHubConfiguration

Factory's GitHub repo information.

Name Type Description
accountName
  • string

Account name.

clientId
  • string

GitHub bring your own app client id.

clientSecret

GitHub bring your own app client secret information.

collaborationBranch
  • string

Collaboration branch.

hostName
  • string

GitHub Enterprise host name. For example: https://github.mydomain.com

lastCommitId
  • string

Last commit id.

repositoryName
  • string

Repository name.

rootFolder
  • string

Root folder.

type string:

Type of repo configuration.

FactoryIdentity

Identity properties of the factory resource.

Name Type Description
principalId
  • string

The principal id of the identity.

tenantId
  • string

The client tenant id of the identity.

type

The identity type.

userAssignedIdentities

List of user assigned identities for the factory.

FactoryIdentityType

The identity type.

Name Type Description
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

FactoryRepoUpdate

Factory's git repo information.

Name Type Description
factoryResourceId
  • string

The factory resource id.

repoConfiguration FactoryRepoConfiguration:

Git repo information of the factory.

FactoryVSTSConfiguration

Factory's VSTS repo information.

Name Type Description
accountName
  • string

Account name.

collaborationBranch
  • string

Collaboration branch.

lastCommitId
  • string

Last commit id.

projectName
  • string

VSTS project name.

repositoryName
  • string

Repository name.

rootFolder
  • string

Root folder.

tenantId
  • string

VSTS tenant id.

type string:

Type of repo configuration.

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.

GlobalParameterSpecification

Definition of a single parameter for an entity.

Name Type Description
type

Global Parameter type.

value
  • object

Value of parameter.

GlobalParameterType

Global Parameter type.

Name Type Description
Array
  • string
Bool
  • string
Float
  • string
Int
  • string
Object
  • string
String
  • string

PublicNetworkAccess

Whether or not public network access is allowed for the data factory.

Name Type Description
Disabled
  • string
Enabled
  • string

UserAssignedIdentitySpecification

Definition of a single user assigned identity for a factory.