configuration_group_schemas

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

Overview

Name	configuration_group_schemas
Type	Resource
Id	azure.hybrid_network.configuration_group_schemas

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting publisher network function definition group resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Configuration group schema properties.
tags	object	Resource tags.

list_by_publisher

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Configuration group schema properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, publisherName, configurationGroupSchemaName, subscriptionId		Gets information about the specified configuration group schema.
list_by_publisher	select	resourceGroupName, publisherName, subscriptionId		Gets information of the configuration group schemas under a publisher.
create_or_update	insert	resourceGroupName, publisherName, configurationGroupSchemaName, subscriptionId		Creates or updates a configuration group schema.
update	update	resourceGroupName, publisherName, configurationGroupSchemaName, subscriptionId		Updates a configuration group schema resource.
delete	delete	resourceGroupName, publisherName, configurationGroupSchemaName, subscriptionId		Deletes a specified configuration group schema.
update_state	exec	subscriptionId, resourceGroupName, publisherName, configurationGroupSchemaName		Update configuration group schema state.

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
configurationGroupSchemaName	string	The name of the configuration group schema.
publisherName	string	The name of the publisher.
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 configuration group schema.

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

list_by_publisher

Gets information of the configuration group schemas under a publisher.

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

INSERT examples

create_or_update

Creates or updates a configuration group schema.

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

Manifest

# Description fields are for documentation purposes
- name: configuration_group_schemas
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_group_schemas resource.
    - name: publisherName
      value: string
      description: Required parameter for the configuration_group_schemas resource.
    - name: configurationGroupSchemaName
      value: string
      description: Required parameter for the configuration_group_schemas resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the configuration_group_schemas resource.
    - name: properties
      value: object
      description: |
        Configuration group schema properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a configuration group schema resource.

UPDATE azure.hybrid_network.configuration_group_schemas
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND configurationGroupSchemaName = '{{ configurationGroupSchemaName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a specified configuration group schema.

DELETE FROM azure.hybrid_network.configuration_group_schemas
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND configurationGroupSchemaName = '{{ configurationGroupSchemaName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_state

Update configuration group schema state.

EXEC azure.hybrid_network.configuration_group_schemas.update_state 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@publisherName='{{ publisherName }}' --required, 
@configurationGroupSchemaName='{{ configurationGroupSchemaName }}' --required 
@@json=
'{
"versionState": "{{ versionState }}"
}'
;