network_groups

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

Overview

Name	network_groups
Type	Resource
Id	azure.network.network_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
description	string	A description of the network group.
etag	string	A unique read-only string that changes whenever the resource is updated.
memberType	string	The type of the group member. Known values are: "VirtualNetwork" and "Subnet". (VirtualNetwork, Subnet)
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
description	string	A description of the network group.
etag	string	A unique read-only string that changes whenever the resource is updated.
memberType	string	The type of the group member. Known values are: "VirtualNetwork" and "Subnet". (VirtualNetwork, Subnet)
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
systemData	object	The system metadata related to this resource.
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, network_manager_name, network_group_name, subscription_id		Gets the specified network group.
list	select	resource_group_name, network_manager_name, subscription_id	$top, $skipToken	Lists the specified network group.
create_or_update	insert	resource_group_name, network_manager_name, network_group_name, subscription_id		Creates or updates a network group.
create_or_update	replace	resource_group_name, network_manager_name, network_group_name, subscription_id		Creates or updates a network group.
delete	delete	resource_group_name, network_manager_name, network_group_name, subscription_id	force	Deletes a network group.

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
network_group_name	string	The name of the network group. Required.
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.
force	boolean	Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

SELECT examples

get

Gets the specified network group.

SELECT
id,
name,
description,
etag,
memberType,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.network_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND network_group_name = '{{ network_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the specified network group.

SELECT
id,
name,
description,
etag,
memberType,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.network_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a network group.

INSERT INTO azure.network.network_groups (
properties,
resource_group_name,
network_manager_name,
network_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ network_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_groups resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the network_groups resource.
  - name: network_group_name
    value: "{{ network_group_name }}"
    description: Required parameter for the network_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_groups resource.
  - name: properties
    description: |
      The Network Group properties.
    value:
      description: "{{ description }}"
      memberType: "{{ memberType }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"

REPLACE examples

create_or_update

Creates or updates a network group.

REPLACE azure.network.network_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND network_group_name = '{{ network_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a network group.

DELETE FROM azure.network.network_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND network_group_name = '{{ network_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;