subgroups

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

Overview

Name	subgroups
Type	Resource
Id	azure.network.subgroups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
interconnectBlock	object	Reference to another subresource.
internalSubgroupId	string	The unique identifier of the subgroup.
provisioningState	string	The provisioning state of the subgroup. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.
virtualMachines	array	A list of virtual machine references.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
interconnectBlock	object	Reference to another subresource.
internalSubgroupId	string	The unique identifier of the subgroup.
provisioningState	string	The provisioning state of the subgroup. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.
virtualMachines	array	A list of virtual machine references.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, interconnect_group_name, subgroup_name, subscription_id		Gets the specified subgroup in an interconnect group.
list	select	resource_group_name, interconnect_group_name, subscription_id		Gets all subgroups in an interconnect 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
interconnect_group_name	string	The name of the interconnect group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subgroup_name	string	The name of the subgroup. Required.
subscription_id	string

SELECT examples

get

Gets the specified subgroup in an interconnect group.

SELECT
id,
name,
interconnectBlock,
internalSubgroupId,
provisioningState,
type,
virtualMachines
FROM azure.network.subgroups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND interconnect_group_name = '{{ interconnect_group_name }}' -- required
AND subgroup_name = '{{ subgroup_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all subgroups in an interconnect group.

SELECT
id,
name,
interconnectBlock,
internalSubgroupId,
provisioningState,
type,
virtualMachines
FROM azure.network.subgroups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND interconnect_group_name = '{{ interconnect_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;