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

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the global parameter.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the global parameter.
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, globalParameterName	api-version	Gets a Global parameter
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists Global parameters
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, globalParameterName, data__properties	api-version	Creates or updates a Global parameter
delete	delete	subscriptionId, resourceGroupName, factoryName, globalParameterName	api-version	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
factoryName	string	The factory name.
globalParameterName	string	The global parameter name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
api-version	string	The API version.

SELECT examples

get

Gets a Global parameter

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.global_parameters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND globalParameterName = '{{ globalParameterName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_factory

Lists Global parameters

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.global_parameters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a Global parameter

INSERT INTO azure.data_factory.global_parameters (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
globalParameterName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ globalParameterName }}',
'{{ api-version }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: global_parameters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the global_parameters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the global_parameters resource.
    - name: factoryName
      value: string
      description: Required parameter for the global_parameters resource.
    - name: globalParameterName
      value: string
      description: Required parameter for the global_parameters resource.
    - name: properties
      value: object
      description: |
        Properties of the global parameter.
    - name: api-version
      value: string
      description: The API version.

DELETE examples

delete

Deletes a Global parameter

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