configuration_group_values

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

Overview

Name	configuration_group_values
Type	Resource
Id	azure.hybrid_network.configuration_group_values

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting hybrid configuration group resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Hybrid configuration group value properties.
tags	object	Resource tags.

list_by_resource_group

Request is successful. The operation returns a list of hybrid configuration group value resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Hybrid configuration group value properties.
tags	object	Resource tags.

list_by_subscription

Request is successful. The operation returns a list of hybrid network site resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Hybrid configuration group value properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, configurationGroupValueName		Gets information about the specified hybrid configuration group values.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the hybrid network configurationGroupValues in a resource group.
list_by_subscription	select	subscriptionId		Lists all sites in the configuration group value in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, configurationGroupValueName		Creates or updates a hybrid configuration group value.
delete	delete	subscriptionId, resourceGroupName, configurationGroupValueName		Deletes the specified hybrid configuration group value.
update_tags	exec	subscriptionId, resourceGroupName, configurationGroupValueName		Updates a hybrid configuration group tags.

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
configurationGroupValueName	string	The name of the configuration group value.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified hybrid configuration group values.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.configuration_group_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configurationGroupValueName = '{{ configurationGroupValueName }}' -- required
;

list_by_resource_group

Lists all the hybrid network configurationGroupValues in a resource group.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.configuration_group_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all sites in the configuration group value in a subscription.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.configuration_group_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a hybrid configuration group value.

INSERT INTO azure.hybrid_network.configuration_group_values (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
configurationGroupValueName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ configurationGroupValueName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: configuration_group_values
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the configuration_group_values resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_group_values resource.
    - name: configurationGroupValueName
      value: string
      description: Required parameter for the configuration_group_values resource.
    - name: properties
      value: object
      description: |
        Hybrid configuration group value properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes the specified hybrid configuration group value.

DELETE FROM azure.hybrid_network.configuration_group_values
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND configurationGroupValueName = '{{ configurationGroupValueName }}' --required
;

Lifecycle Methods

update_tags

Updates a hybrid configuration group tags.

EXEC azure.hybrid_network.configuration_group_values.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@configurationGroupValueName='{{ configurationGroupValueName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;