configuration_group_values

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

Overview

Name	configuration_group_values
Type	Resource
Id	azure_extras.hybrid_network.configuration_group_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.
configurationGroupSchemaName	string	The configuration group schema name.
configurationGroupSchemaOfferingLocation	string	The location of the configuration group schema offering.
configurationGroupSchemaResourceReference	object	The configuration group schema resource reference.
configurationType	string	The value which indicates if configuration values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the site resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the configuration group schema.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_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.
configurationGroupSchemaName	string	The configuration group schema name.
configurationGroupSchemaOfferingLocation	string	The location of the configuration group schema offering.
configurationGroupSchemaResourceReference	object	The configuration group schema resource reference.
configurationType	string	The value which indicates if configuration values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the site resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the configuration group schema.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
configurationGroupSchemaName	string	The configuration group schema name.
configurationGroupSchemaOfferingLocation	string	The location of the configuration group schema offering.
configurationGroupSchemaResourceReference	object	The configuration group schema resource reference.
configurationType	string	The value which indicates if configuration values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the site resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the configuration group schema.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, configuration_group_value_name, subscription_id		Gets information about the specified hybrid configuration group values.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the hybrid network configurationGroupValues in a resource group.
list_by_subscription	select	subscription_id		Lists all sites in the configuration group value in a subscription.
create_or_update	insert	resource_group_name, configuration_group_value_name, subscription_id, location		Creates or updates a hybrid configuration group value.
update_tags	update	resource_group_name, configuration_group_value_name, subscription_id		Updates a hybrid configuration group tags.
create_or_update	replace	resource_group_name, configuration_group_value_name, subscription_id, location		Creates or updates a hybrid configuration group value.
delete	delete	resource_group_name, configuration_group_value_name, subscription_id		Deletes the specified hybrid configuration group value.

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
configuration_group_value_name	string	The name of the configuration group value. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified hybrid configuration group values.

SELECT
id,
name,
configurationGroupSchemaName,
configurationGroupSchemaOfferingLocation,
configurationGroupSchemaResourceReference,
configurationType,
location,
provisioningState,
publisherName,
publisherScope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.configuration_group_values
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND configuration_group_value_name = '{{ configuration_group_value_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the hybrid network configurationGroupValues in a resource group.

SELECT
id,
name,
configurationGroupSchemaName,
configurationGroupSchemaOfferingLocation,
configurationGroupSchemaResourceReference,
configurationType,
location,
provisioningState,
publisherName,
publisherScope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.configuration_group_values
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
configurationGroupSchemaName,
configurationGroupSchemaOfferingLocation,
configurationGroupSchemaResourceReference,
configurationType,
location,
provisioningState,
publisherName,
publisherScope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.configuration_group_values
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a hybrid configuration group value.

INSERT INTO azure_extras.hybrid_network.configuration_group_values (
tags,
location,
properties,
resource_group_name,
configuration_group_value_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ configuration_group_value_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_group_values
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_group_values resource.
  - name: configuration_group_value_name
    value: "{{ configuration_group_value_name }}"
    description: Required parameter for the configuration_group_values resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_group_values resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Hybrid configuration group value properties.
    value:
      provisioningState: "{{ provisioningState }}"
      publisherName: "{{ publisherName }}"
      publisherScope: "{{ publisherScope }}"
      configurationGroupSchemaName: "{{ configurationGroupSchemaName }}"
      configurationGroupSchemaOfferingLocation: "{{ configurationGroupSchemaOfferingLocation }}"
      configurationGroupSchemaResourceReference:
        idType: "{{ idType }}"
      configurationType: "{{ configurationType }}"

UPDATE examples

update_tags

Updates a hybrid configuration group tags.

UPDATE azure_extras.hybrid_network.configuration_group_values
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND configuration_group_value_name = '{{ configuration_group_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a hybrid configuration group value.

REPLACE azure_extras.hybrid_network.configuration_group_values
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND configuration_group_value_name = '{{ configuration_group_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified hybrid configuration group value.

DELETE FROM azure_extras.hybrid_network.configuration_group_values
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND configuration_group_value_name = '{{ configuration_group_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;