global_parameters

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

Overview

Name	global_parameters
Type	Resource
Id	azure.data_factory.global_parameters

Fields

The following fields are returned by SELECT queries:

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.
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.").
properties	object	Properties of the global parameter. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_factory

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.
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.").
properties	object	Properties of the global parameter. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, global_parameter_name, subscription_id		Gets a Global parameter.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists Global parameters.
create_or_update	insert	resource_group_name, factory_name, global_parameter_name, subscription_id, properties		Creates or updates a Global parameter.
create_or_update	replace	resource_group_name, factory_name, global_parameter_name, subscription_id, properties		Creates or updates a Global parameter.
delete	delete	resource_group_name, factory_name, global_parameter_name, subscription_id		Deletes a Global parameter.

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.
global_parameter_name	string	The global parameter name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a Global parameter.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.data_factory.global_parameters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND global_parameter_name = '{{ global_parameter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists Global parameters.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.data_factory.global_parameters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Global parameter.

INSERT INTO azure.data_factory.global_parameters (
properties,
resource_group_name,
factory_name,
global_parameter_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ global_parameter_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: global_parameters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the global_parameters resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the global_parameters resource.
  - name: global_parameter_name
    value: "{{ global_parameter_name }}"
    description: Required parameter for the global_parameters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the global_parameters resource.
  - name: properties
    value: "{{ properties }}"
    description: |
      Properties of the global parameter. Required.

REPLACE examples

create_or_update

Creates or updates a Global parameter.

REPLACE azure.data_factory.global_parameters
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND global_parameter_name = '{{ global_parameter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a Global parameter.

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