groups

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

Overview

Name	groups
Type	Resource
Id	azure.managed_network.groups

Fields

The following fields are returned by SELECT queries:

get

Get successful. The operation returns the specified Managed Network Group resource.

Name	Datatype	Description
kind	string	Responsibility role under which this Managed Network Group will be created
properties	object	Gets or sets the properties of a network group

list_by_managed_network

Get successful. The operation returns all Managed Network Group resources under the specified Managed Network in a paginated format.

Name	Datatype	Description
kind	string	Responsibility role under which this Managed Network Group will be created
properties	object	Gets or sets the properties of a network group

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkGroupName		The Get ManagedNetworkGroups operation gets a Managed Network Group specified by the resource group, Managed Network name, and group name
list_by_managed_network	select	subscriptionId, resourceGroupName, managedNetworkName	$top, $skiptoken	The ListByManagedNetwork ManagedNetworkGroup operation retrieves all the Managed Network Groups in a specified Managed Networks in a paginated format.
create_or_update	insert	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkGroupName		The Put ManagedNetworkGroups operation creates or updates a Managed Network Group resource
delete	delete	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkGroupName		The Delete ManagedNetworkGroups operation deletes a Managed Network Group specified by the resource group, Managed Network name, and group name

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
managedNetworkGroupName	string	The name of the Managed Network Group.
managedNetworkName	string	The name of the Managed Network.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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	May be used to limit the number of results in a page for list queries.

SELECT examples

get

The Get ManagedNetworkGroups operation gets a Managed Network Group specified by the resource group, Managed Network name, and group name

SELECT
kind,
properties
FROM azure.managed_network.groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedNetworkName = '{{ managedNetworkName }}' -- required
AND managedNetworkGroupName = '{{ managedNetworkGroupName }}' -- required
;

list_by_managed_network

The ListByManagedNetwork ManagedNetworkGroup operation retrieves all the Managed Network Groups in a specified Managed Networks in a paginated format.

SELECT
kind,
properties
FROM azure.managed_network.groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedNetworkName = '{{ managedNetworkName }}' -- required
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

The Put ManagedNetworkGroups operation creates or updates a Managed Network Group resource

INSERT INTO azure.managed_network.groups (
data__properties,
data__kind,
subscriptionId,
resourceGroupName,
managedNetworkName,
managedNetworkGroupName
)
SELECT 
'{{ properties }}',
'{{ kind }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managedNetworkName }}',
'{{ managedNetworkGroupName }}'
RETURNING
kind,
properties
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the groups resource.
    - name: managedNetworkName
      value: string
      description: Required parameter for the groups resource.
    - name: managedNetworkGroupName
      value: string
      description: Required parameter for the groups resource.
    - name: properties
      value: object
      description: |
        Gets or sets the properties of a network group
    - name: kind
      value: string
      description: |
        Responsibility role under which this Managed Network Group will be created
      valid_values: ['Connectivity']

DELETE examples

delete

The Delete ManagedNetworkGroups operation deletes a Managed Network Group specified by the resource group, Managed Network name, and group name

DELETE FROM azure.managed_network.groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managedNetworkName = '{{ managedNetworkName }}' --required
AND managedNetworkGroupName = '{{ managedNetworkGroupName }}' --required
;