groups

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

Overview

Name	groups
Type	Resource
Id	azure.network.groups

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the network group.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The Network Group properties
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

OK - Returns information about the network group.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The Network Group properties
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			Gets the specified network group.
list	select	subscriptionId, resourceGroupName, networkManagerName	$top, $skipToken	Lists the specified network group.
create_or_update	insert		If-Match	Creates or updates a network group.
delete	delete		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
networkManagerName	string	The name of the network manager.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$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.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned by the server.
If-Match	string	The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
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.

SELECT examples

get

Gets the specified network group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.groups
;

list

Lists the specified network group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkManagerName = '{{ networkManagerName }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a network group.

INSERT INTO azure.network.groups (
data__properties,
If-Match
)
SELECT 
'{{ properties }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: properties
      value: object
      description: |
        The Network Group properties
    - name: If-Match
      value: string
      description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

DELETE examples

delete

Deletes a network group.

DELETE FROM azure.network.groups
WHERE force = '{{ force }}'
;