factories

Creates, updates, deletes, gets or lists a factories resource.

Overview

Name	factories
Type	Resource
Id	azure.data_factory.factories

Fields

The following fields are returned by SELECT queries:

get_github_access_token

Name	Datatype	Description
gitHubAccessToken	string	GitHub access token.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createTime	string (date-time)	Time the factory was created in ISO8601 format.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
encryption	object	Properties to enable Customer Managed Key for the factory.
globalParameters	object	List of parameters for factory.
identity	object	Managed service identity of the factory.
location	string	The resource location.
provisioningState	string	Factory provisioning state, example Succeeded.
publicNetworkAccess	string	Whether or not public network access is allowed for the data factory. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
purviewConfiguration	object	Purview information of the factory.
repoConfiguration	object	Git repo information of the factory.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the factory.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createTime	string (date-time)	Time the factory was created in ISO8601 format.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
encryption	object	Properties to enable Customer Managed Key for the factory.
globalParameters	object	List of parameters for factory.
identity	object	Managed service identity of the factory.
location	string	The resource location.
provisioningState	string	Factory provisioning state, example Succeeded.
publicNetworkAccess	string	Whether or not public network access is allowed for the data factory. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
purviewConfiguration	object	Purview information of the factory.
repoConfiguration	object	Git repo information of the factory.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the factory.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createTime	string (date-time)	Time the factory was created in ISO8601 format.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
encryption	object	Properties to enable Customer Managed Key for the factory.
globalParameters	object	List of parameters for factory.
identity	object	Managed service identity of the factory.
location	string	The resource location.
provisioningState	string	Factory provisioning state, example Succeeded.
publicNetworkAccess	string	Whether or not public network access is allowed for the data factory. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
purviewConfiguration	object	Purview information of the factory.
repoConfiguration	object	Git repo information of the factory.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the factory.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_github_access_token	select	resource_group_name, factory_name, subscription_id		Get GitHub Access Token.
get	select	resource_group_name, factory_name, subscription_id		Gets a factory.
list_by_resource_group	select	resource_group_name, subscription_id		Lists factories.
list	select	subscription_id		Lists factories under the specified subscription.
create_or_update	insert	resource_group_name, factory_name, subscription_id		Creates or updates a factory.
update	update	resource_group_name, factory_name, subscription_id		Updates a factory.
create_or_update	replace	resource_group_name, factory_name, subscription_id		Creates or updates a factory.
delete	delete	resource_group_name, factory_name, subscription_id		Deletes a factory.
get_data_plane_access	exec	resource_group_name, factory_name, subscription_id		Get Data Plane access.
configure_factory_repo	exec	location_id, subscription_id		Updates a factory's repo information.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
factory_name	string	The factory name. Required.
location_id	string	The location identifier. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_github_access_token

Get GitHub Access Token.

SELECT
gitHubAccessToken
FROM azure.data_factory.factories
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets a factory.

SELECT
id,
name,
createTime,
eTag,
encryption,
globalParameters,
identity,
location,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
repoConfiguration,
systemData,
tags,
type,
version
FROM azure.data_factory.factories
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists factories.

SELECT
id,
name,
createTime,
eTag,
encryption,
globalParameters,
identity,
location,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
repoConfiguration,
systemData,
tags,
type,
version
FROM azure.data_factory.factories
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists factories under the specified subscription.

SELECT
id,
name,
createTime,
eTag,
encryption,
globalParameters,
identity,
location,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
repoConfiguration,
systemData,
tags,
type,
version
FROM azure.data_factory.factories
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a factory.

INSERT INTO azure.data_factory.factories (
properties,
identity,
location,
tags,
resource_group_name,
factory_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: factories
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the factories resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the factories resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the factories resource.
  - name: properties
    description: |
      Properties of the factory.
    value:
      provisioningState: "{{ provisioningState }}"
      createTime: "{{ createTime }}"
      version: "{{ version }}"
      purviewConfiguration:
        purviewResourceId: "{{ purviewResourceId }}"
      repoConfiguration:
        type: "{{ type }}"
        accountName: "{{ accountName }}"
        repositoryName: "{{ repositoryName }}"
        collaborationBranch: "{{ collaborationBranch }}"
        rootFolder: "{{ rootFolder }}"
        lastCommitId: "{{ lastCommitId }}"
        disablePublish: {{ disablePublish }}
      globalParameters: "{{ globalParameters }}"
      encryption:
        keyName: "{{ keyName }}"
        vaultBaseUrl: "{{ vaultBaseUrl }}"
        keyVersion: "{{ keyVersion }}"
        identity:
          userAssignedIdentity: "{{ userAssignedIdentity }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
  - name: identity
    description: |
      Managed service identity of the factory.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.

UPDATE examples

update

Updates a factory.

UPDATE azure.data_factory.factories
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a factory.

REPLACE azure.data_factory.factories
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a factory.

DELETE FROM azure.data_factory.factories
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_data_plane_access

Get Data Plane access.

EXEC azure.data_factory.factories.get_data_plane_access 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"permissions": "{{ permissions }}", 
"accessResourcePath": "{{ accessResourcePath }}", 
"profileName": "{{ profileName }}", 
"startTime": "{{ startTime }}", 
"expireTime": "{{ expireTime }}"
}'
;

configure_factory_repo

Updates a factory's repo information.

EXEC azure.data_factory.factories.configure_factory_repo 
@location_id='{{ location_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"factoryResourceId": "{{ factoryResourceId }}", 
"repoConfiguration": "{{ repoConfiguration }}"
}'
;