variable_values

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

Overview

Name	variable_values
Type	Resource
Id	azure.resource.variable_values

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.
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".
values	array	Variable value column value array. Required.

get_at_management_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.
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".
values	array	Variable value column value array. Required.

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.
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".
values	array	Variable value column value array. Required.

list_for_management_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.
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".
values	array	Variable value column value array. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	variable_name, variable_value_name, subscription_id		Retrieves a variable value. This operation retrieves a single variable value; given its name, subscription it was created at and the variable it's created for.
get_at_management_group	select	management_group_id, variable_name, variable_value_name		Retrieves a variable value. This operation retrieves a single variable value; given its name, management group it was created at and the variable it's created for.
list	select	variable_name, subscription_id		List variable values for a variable. This operation retrieves the list of all variable values associated with the given variable that is at a subscription level.
list_for_management_group	select	management_group_id, variable_name		List variable values at management group level. This operation retrieves the list of all variable values applicable the variable indicated at the management group scope.
create_or_update	insert	variable_name, variable_value_name, subscription_id		Creates or updates a variable value. This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.
create_or_update_at_management_group	insert	management_group_id, variable_name, variable_value_name		Creates or updates a variable value. This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.
create_or_update	replace	variable_name, variable_value_name, subscription_id		Creates or updates a variable value. This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.
create_or_update_at_management_group	replace	management_group_id, variable_name, variable_value_name		Creates or updates a variable value. This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.
delete	delete	variable_name, variable_value_name, subscription_id		Deletes a variable value. This operation deletes a variable value, given its name, the subscription it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
delete_at_management_group	delete	management_group_id, variable_name, variable_value_name		Deletes a variable value. This operation deletes a variable value, given its name, the management group it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.

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
management_group_id	string	The ID of the management group. Required.
subscription_id	string
variable_name	string	The name of the variable to operate on. Required.
variable_value_name	string	The name of the variable value to operate on. Required.

SELECT examples

get

Retrieves a variable value. This operation retrieves a single variable value; given its name, subscription it was created at and the variable it's created for.

SELECT
id,
name,
systemData,
type,
values
FROM azure.resource.variable_values
WHERE variable_name = '{{ variable_name }}' -- required
AND variable_value_name = '{{ variable_value_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_at_management_group

Retrieves a variable value. This operation retrieves a single variable value; given its name, management group it was created at and the variable it's created for.

SELECT
id,
name,
systemData,
type,
values
FROM azure.resource.variable_values
WHERE management_group_id = '{{ management_group_id }}' -- required
AND variable_name = '{{ variable_name }}' -- required
AND variable_value_name = '{{ variable_value_name }}' -- required
;

list

List variable values for a variable. This operation retrieves the list of all variable values associated with the given variable that is at a subscription level.

SELECT
id,
name,
systemData,
type,
values
FROM azure.resource.variable_values
WHERE variable_name = '{{ variable_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_for_management_group

List variable values at management group level. This operation retrieves the list of all variable values applicable the variable indicated at the management group scope.

SELECT
id,
name,
systemData,
type,
values
FROM azure.resource.variable_values
WHERE management_group_id = '{{ management_group_id }}' -- required
AND variable_name = '{{ variable_name }}' -- required
;

INSERT examples

create_or_update

Creates or updates a variable value. This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.

INSERT INTO azure.resource.variable_values (
properties,
variable_name,
variable_value_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ variable_name }}',
'{{ variable_value_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_or_update_at_management_group

Creates or updates a variable value. This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.

INSERT INTO azure.resource.variable_values (
properties,
management_group_id,
variable_name,
variable_value_name
)
SELECT 
'{{ properties }}',
'{{ management_group_id }}',
'{{ variable_name }}',
'{{ variable_value_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: variable_values
props:
  - name: variable_name
    value: "{{ variable_name }}"
    description: Required parameter for the variable_values resource.
  - name: variable_value_name
    value: "{{ variable_value_name }}"
    description: Required parameter for the variable_values resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the variable_values resource.
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the variable_values resource.
  - name: properties
    description: |
      Properties for the variable value.
    value:
      values:
        - columnName: "{{ columnName }}"
          columnValue: "{{ columnValue }}"

REPLACE examples

create_or_update

Creates or updates a variable value. This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.

REPLACE azure.resource.variable_values
SET 
properties = '{{ properties }}'
WHERE 
variable_name = '{{ variable_name }}' --required
AND variable_value_name = '{{ variable_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

create_or_update_at_management_group

Creates or updates a variable value. This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.

REPLACE azure.resource.variable_values
SET 
properties = '{{ properties }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND variable_name = '{{ variable_name }}' --required
AND variable_value_name = '{{ variable_value_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a variable value. This operation deletes a variable value, given its name, the subscription it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.

DELETE FROM azure.resource.variable_values
WHERE variable_name = '{{ variable_name }}' --required
AND variable_value_name = '{{ variable_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_at_management_group

Deletes a variable value. This operation deletes a variable value, given its name, the management group it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.

DELETE FROM azure.resource.variable_values
WHERE management_group_id = '{{ management_group_id }}' --required
AND variable_name = '{{ variable_name }}' --required
AND variable_value_name = '{{ variable_value_name }}' --required
;