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

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
eTag	string	Etag identifies change in the resource.
identity	object	Managed service identity of the factory.
location	string	The resource location.
properties	object	Properties of the factory.
tags	object	The resource tags.
type	string	The resource type.

list_by_resource_group

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
eTag	string	Etag identifies change in the resource.
identity	object	Managed service identity of the factory.
location	string	The resource location.
properties	object	Properties of the factory.
tags	object	The resource tags.
type	string	The resource type.

list

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
eTag	string	Etag identifies change in the resource.
identity	object	Managed service identity of the factory.
location	string	The resource location.
properties	object	Properties of the factory.
tags	object	The resource tags.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName	api-version, If-None-Match	Gets a factory.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Lists factories.
list	select	subscriptionId	api-version	Lists factories under the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName	api-version, If-Match	Creates or updates a factory.
update	update	subscriptionId, resourceGroupName, factoryName	api-version	Updates a factory.
delete	delete	subscriptionId, resourceGroupName, factoryName	api-version	Deletes a factory.
configure_factory_repo	exec	subscriptionId, locationId	api-version	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
factoryName	string	The factory name.
locationId	string	The location identifier.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
If-Match	string	ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
api-version	string	The API version.

SELECT examples

get

Gets a factory.

SELECT
id,
name,
eTag,
identity,
location,
properties,
tags,
type
FROM azure.data_factory.factories
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_resource_group

Lists factories.

SELECT
id,
name,
eTag,
identity,
location,
properties,
tags,
type
FROM azure.data_factory.factories
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists factories under the specified subscription.

SELECT
id,
name,
eTag,
identity,
location,
properties,
tags,
type
FROM azure.data_factory.factories
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a factory.

INSERT INTO azure.data_factory.factories (
data__location,
data__tags,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
api-version,
If-Match
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
eTag,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: factories
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the factories resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the factories resource.
    - name: factoryName
      value: string
      description: Required parameter for the factories resource.
    - name: location
      value: string
      description: |
        The resource location.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: identity
      value: object
      description: |
        Managed service identity of the factory.
    - name: properties
      value: object
      description: |
        Properties of the factory.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

UPDATE examples

update

Updates a factory.

UPDATE azure.data_factory.factories
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
eTag,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a factory.

DELETE FROM azure.data_factory.factories
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

configure_factory_repo

Updates a factory's repo information.

EXEC azure.data_factory.factories.configure_factory_repo 
@subscriptionId='{{ subscriptionId }}' --required, 
@locationId='{{ locationId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"factoryResourceId": "{{ factoryResourceId }}", 
"repoConfiguration": "{{ repoConfiguration }}"
}'
;