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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
isDefault	boolean	Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
p2SConnectionConfigurations	array	List of references to P2SConnectionConfigurations.
policyMembers	array	Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority	integer	Priority for VpnServerConfigurationPolicyGroup.
provisioningState	string	The provisioning state of the VpnServerConfigurationPolicyGroup resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list_by_vpn_server_configuration

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
isDefault	boolean	Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
p2SConnectionConfigurations	array	List of references to P2SConnectionConfigurations.
policyMembers	array	Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority	integer	Priority for VpnServerConfigurationPolicyGroup.
provisioningState	string	The provisioning state of the VpnServerConfigurationPolicyGroup resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vpn_server_configuration_name, configuration_policy_group_name, subscription_id		Retrieves the details of a ConfigurationPolicyGroup.
list_by_vpn_server_configuration	select	resource_group_name, vpn_server_configuration_name, subscription_id		Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.
create_or_update	insert	resource_group_name, vpn_server_configuration_name, configuration_policy_group_name, subscription_id		Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.
create_or_update	replace	resource_group_name, vpn_server_configuration_name, configuration_policy_group_name, subscription_id		Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.
delete	delete	resource_group_name, vpn_server_configuration_name, configuration_policy_group_name, subscription_id		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
configuration_policy_group_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vpn_server_configuration_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

SELECT examples

get

Retrieves the details of a ConfigurationPolicyGroup.

SELECT
id,
name,
etag,
isDefault,
p2SConnectionConfigurations,
policyMembers,
priority,
provisioningState,
type
FROM azure.network.configuration_policy_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' -- required
AND configuration_policy_group_name = '{{ configuration_policy_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_vpn_server_configuration

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

SELECT
id,
name,
etag,
isDefault,
p2SConnectionConfigurations,
policyMembers,
priority,
provisioningState,
type
FROM azure.network.configuration_policy_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
id,
name,
properties,
resource_group_name,
vpn_server_configuration_name,
configuration_policy_group_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vpn_server_configuration_name }}',
'{{ configuration_policy_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_policy_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_policy_groups resource.
  - name: vpn_server_configuration_name
    value: "{{ vpn_server_configuration_name }}"
    description: Required parameter for the configuration_policy_groups resource.
  - name: configuration_policy_group_name
    value: "{{ configuration_policy_group_name }}"
    description: Required parameter for the configuration_policy_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_policy_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the VpnServerConfigurationPolicyGroup.
    value:
      isDefault: {{ isDefault }}
      priority: {{ priority }}
      policyMembers:
        - name: "{{ name }}"
          attributeType: "{{ attributeType }}"
          attributeValue: "{{ attributeValue }}"
      p2SConnectionConfigurations:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

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

REPLACE azure.network.configuration_policy_groups
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' --required
AND configuration_policy_group_name = '{{ configuration_policy_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a ConfigurationPolicyGroup.

DELETE FROM azure.network.configuration_policy_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' --required
AND configuration_policy_group_name = '{{ configuration_policy_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;