Factories - List

Lists factories under the specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories?api-version=2018-06-01

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The API version.

Responses

Name Type Description
200 OK

FactoryListResponse

OK.

Other Status Codes

CloudError

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_List

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/providers/Microsoft.DataFactory/factories?api-version=2018-06-01

Sample response

Date: Tue, 19 Jun 2018 05:41:51 GMT
x-ms-ratelimit-remaining-subscription-reads: 14992
x-ms-request-id: 533da6af-ad1a-4f89-ae04-d55e9c72b89d
x-ms-correlation-request-id: 533da6af-ad1a-4f89-ae04-d55e9c72b89d
X-Content-Type-Options: nosniff
{
  "value": [
    {
      "name": "rpV2OrigDF-72c7d3d4-5e17-4ec6-91de-9ab433f15e79",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "399c3de2-6072-4326-bfa9-4d0c116f1a7b",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/rpv2origdf-72c7d3d4-5e17-4ec6-91de-9ab433f15e79",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-05-29T13:39:35.615921Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"0000aa0d-0000-0000-0000-5b0d58170000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "name": "df-dogfood-yanzhang-we",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e8dd6df9-bad5-4dea-8fb8-0d13d1845d9e",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/df-dogfood-yanzhang-we",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-14T00:06:04.6667461Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"0000f301-0000-0000-0000-5b21b16c0000\"",
      "location": "West Europe",
      "tags": {}
    },
    {
      "name": "exampleFactoryName-linked",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "10743799-44d2-42fe-8c4d-5bc5c51c0684",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName-linked",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-15T08:56:07.1828318Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"00008a02-0000-0000-0000-5b237f270000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "name": "FactoryToUpgrade",
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/factorytoupgrade",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-19T05:35:35.7133828Z",
        "version": "2018-06-01"
      },
      "eTag": "\"00003d04-0000-0000-0000-5b28962f0000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "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",
        "purviewConfiguration": {
          "purviewResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Purview/accounts/examplePurview"
        },
        "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"
      }
    },
    {
      "name": "rpV2OrigDF-72c7d3d4-5e17-4ec6-91de-9ab433f15e79",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "399c3de2-6072-4326-bfa9-4d0c116f1a7b",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/rpv2origdf-72c7d3d4-5e17-4ec6-91de-9ab433f15e79",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-05-29T13:39:35.615921Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"0000aa0d-0000-0000-0000-5b0d58170000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "name": "df-dogfood-yanzhang-we",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e8dd6df9-bad5-4dea-8fb8-0d13d1845d9e",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/df-dogfood-yanzhang-we",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-14T00:06:04.6667461Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"0000f301-0000-0000-0000-5b21b16c0000\"",
      "location": "West Europe",
      "tags": {}
    },
    {
      "name": "exampleFactoryName-linked",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "10743799-44d2-42fe-8c4d-5bc5c51c0684",
        "tenantId": "12345678-1234-1234-1234-123456789abc"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName-linked",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-15T08:56:07.1828318Z",
        "version": "2017-09-01-preview"
      },
      "eTag": "\"00008a02-0000-0000-0000-5b237f270000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "name": "FactoryToUpgrade",
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/factorytoupgrade",
      "type": "Microsoft.DataFactory/factories",
      "properties": {
        "provisioningState": "Succeeded",
        "createTime": "2018-06-19T05:35:35.7133828Z",
        "version": "2018-06-01"
      },
      "eTag": "\"00003d04-0000-0000-0000-5b28962f0000\"",
      "location": "East US",
      "tags": {}
    },
    {
      "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",
        "purviewConfiguration": {
          "purviewResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Purview/accounts/examplePurview"
        },
        "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

Name Description
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.

FactoryListResponse

A list of factory resources.

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.

PurviewConfiguration

Purview configuration.

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

CloudError[]

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

CMKIdentityDefinition

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

FactoryIdentity

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

EncryptionConfiguration

Properties to enable Customer Managed Key for the factory.

properties.globalParameters

<string,  GlobalParameterSpecification>

List of parameters for factory.

properties.provisioningState

string

Factory provisioning state, example Succeeded.

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.purviewConfiguration

PurviewConfiguration

Purview information of the 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

GitHubClientSecret

GitHub bring your own app client secret information.

collaborationBranch

string

Collaboration branch.

disablePublish

boolean

Disable manual publish operation in ADF studio to favor automated publish.

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:

FactoryGitHubConfiguration

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

FactoryIdentityType

The identity type.

userAssignedIdentities

<string,  UserAssignedIdentitySpecification>

List of user assigned identities for the factory.

FactoryIdentityType

The identity type.

Name Type Description
SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

FactoryListResponse

A list of factory resources.

Name Type Description
nextLink

string

The link to the next page of results, if any remaining results exist.

value

Factory[]

List of factories.

FactoryVSTSConfiguration

Factory's VSTS repo information.

Name Type Description
accountName

string

Account name.

collaborationBranch

string

Collaboration branch.

disablePublish

boolean

Disable manual publish operation in ADF studio to favor automated publish.

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:

FactoryVSTSConfiguration

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

GlobalParameterType

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

PurviewConfiguration

Purview configuration.

Name Type Description
purviewResourceId

string

Purview resource id.

UserAssignedIdentitySpecification

Definition of a single user assigned identity for a factory.