configuration_group_schemas

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

Overview

Name	configuration_group_schemas
Type	Resource
Id	azure_extras.hybrid_network.configuration_group_schemas

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.
description	string	Description of what schema can contain.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Configuration group schema resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
schemaDefinition	string	Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
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".
versionState	string	The configuration group schema version state. Known values are: "Unknown", "Preview", "Active", "Deprecated", "Validating", and "ValidationFailed".

list_by_publisher

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.
description	string	Description of what schema can contain.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Configuration group schema resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
schemaDefinition	string	Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
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".
versionState	string	The configuration group schema version state. Known values are: "Unknown", "Preview", "Active", "Deprecated", "Validating", and "ValidationFailed".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id		Gets information about the specified configuration group schema.
list_by_publisher	select	resource_group_name, publisher_name, subscription_id		Gets information of the configuration group schemas under a publisher.
create_or_update	insert	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id, location		Creates or updates a configuration group schema.
update	update	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id		Updates a configuration group schema resource.
create_or_update	replace	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id, location		Creates or updates a configuration group schema.
delete	delete	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id		Deletes a specified configuration group schema.
update_state	exec	resource_group_name, publisher_name, configuration_group_schema_name, subscription_id		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
configuration_group_schema_name	string	The name of the configuration group schema. Required.
publisher_name	string	The name of the publisher. 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 configuration group schema.

SELECT
id,
name,
description,
location,
provisioningState,
schemaDefinition,
systemData,
tags,
type,
versionState
FROM azure_extras.hybrid_network.configuration_group_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND configuration_group_schema_name = '{{ configuration_group_schema_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_publisher

Gets information of the configuration group schemas under a publisher.

SELECT
id,
name,
description,
location,
provisioningState,
schemaDefinition,
systemData,
tags,
type,
versionState
FROM azure_extras.hybrid_network.configuration_group_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a configuration group schema.

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

Manifest

# Description fields are for documentation purposes
- name: configuration_group_schemas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_group_schemas resource.
  - name: publisher_name
    value: "{{ publisher_name }}"
    description: Required parameter for the configuration_group_schemas resource.
  - name: configuration_group_schema_name
    value: "{{ configuration_group_schema_name }}"
    description: Required parameter for the configuration_group_schemas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_group_schemas resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Configuration group schema properties.
    value:
      provisioningState: "{{ provisioningState }}"
      versionState: "{{ versionState }}"
      description: "{{ description }}"
      schemaDefinition: "{{ schemaDefinition }}"

UPDATE examples

update

Updates a configuration group schema resource.

UPDATE azure_extras.hybrid_network.configuration_group_schemas
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND configuration_group_schema_name = '{{ configuration_group_schema_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 configuration group schema.

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

DELETE examples

delete

Deletes a specified configuration group schema.

DELETE FROM azure_extras.hybrid_network.configuration_group_schemas
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND configuration_group_schema_name = '{{ configuration_group_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_state

Update configuration group schema state.

EXEC azure_extras.hybrid_network.configuration_group_schemas.update_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@publisher_name='{{ publisher_name }}' --required, 
@configuration_group_schema_name='{{ configuration_group_schema_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"versionState": "{{ versionState }}"
}'
;