configuration_policy_groups

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

Overview

Name	configuration_policy_groups
Type	Resource
Id	azure.network.configuration_policy_groups

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the ConfigurationPolicyGroup retrieved.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the VpnServerConfigurationPolicyGroup.
type	string	Resource type.

list_by_vpn_server_configuration

Request successful. Returns the details of all the VpnServerConfigurations in the resource group.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the VpnServerConfigurationPolicyGroup.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vpnServerConfigurationName, configurationPolicyGroupName		Retrieves the details of a ConfigurationPolicyGroup.
list_by_vpn_server_configuration	select	subscriptionId, resourceGroupName, vpnServerConfigurationName		Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.
create_or_update	insert	subscriptionId, resourceGroupName, vpnServerConfigurationName, configurationPolicyGroupName		Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.
delete	delete	subscriptionId, resourceGroupName, vpnServerConfigurationName, configurationPolicyGroupName		Deletes a ConfigurationPolicyGroup.

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
configurationPolicyGroupName	string	The name of the ConfigurationPolicyGroup.
resourceGroupName	string	The resource group name of the ConfigurationPolicyGroup.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vpnServerConfigurationName	string	The name of the VpnServerConfiguration.

SELECT examples

get

Retrieves the details of a ConfigurationPolicyGroup.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.configuration_policy_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vpnServerConfigurationName = '{{ vpnServerConfigurationName }}' -- required
AND configurationPolicyGroupName = '{{ configurationPolicyGroupName }}' -- required
;

list_by_vpn_server_configuration

Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.configuration_policy_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vpnServerConfigurationName = '{{ vpnServerConfigurationName }}' -- required
;

INSERT examples

create_or_update

Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.

INSERT INTO azure.network.configuration_policy_groups (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
vpnServerConfigurationName,
configurationPolicyGroupName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vpnServerConfigurationName }}',
'{{ configurationPolicyGroupName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_policy_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the configuration_policy_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_policy_groups resource.
    - name: vpnServerConfigurationName
      value: string
      description: Required parameter for the configuration_policy_groups resource.
    - name: configurationPolicyGroupName
      value: string
      description: Required parameter for the configuration_policy_groups resource.
    - name: properties
      value: object
      description: |
        Properties of the VpnServerConfigurationPolicyGroup.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a ConfigurationPolicyGroup.

DELETE FROM azure.network.configuration_policy_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vpnServerConfigurationName = '{{ vpnServerConfigurationName }}' --required
AND configurationPolicyGroupName = '{{ configurationPolicyGroupName }}' --required
;