groups
Creates, updates, deletes, gets or lists a groups
resource.
Overview
Name | groups |
Type | Resource |
Id | azure.network.groups |
Fields
- vw_groups
- groups
Name | Datatype | Description |
---|---|---|
id | text | Resource ID. |
name | text | Resource name. |
description | text | field from the properties object |
etag | text | A unique read-only string that changes whenever the resource is updated. |
member_type | text | field from the properties object |
networkGroupName | text | field from the properties object |
networkManagerName | text | field from the properties object |
provisioning_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
resource_guid | text | field from the properties object |
subscriptionId | text | field from the properties object |
system_data | text | field from the properties object |
type | text | Resource type. |
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 | Properties of network group |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
type | string | Resource type. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | networkGroupName, networkManagerName, resourceGroupName, subscriptionId | Gets the specified network group. |
list | SELECT | networkManagerName, resourceGroupName, subscriptionId | Lists the specified network group. |
create_or_update | INSERT | networkGroupName, networkManagerName, resourceGroupName, subscriptionId | Creates or updates a network group. |
delete | DELETE | networkGroupName, networkManagerName, resourceGroupName, subscriptionId | Deletes a network group. |
SELECT
examples
Lists the specified network group.
- vw_groups
- groups
SELECT
id,
name,
description,
etag,
member_type,
networkGroupName,
networkManagerName,
provisioning_state,
resourceGroupName,
resource_guid,
subscriptionId,
system_data,
type
FROM azure.network.vw_groups
WHERE networkManagerName = '{{ networkManagerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.groups
WHERE networkManagerName = '{{ networkManagerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new groups
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.network.groups (
networkGroupName,
networkManagerName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ networkGroupName }}',
'{{ networkManagerName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: description
value: string
- name: memberType
value: []
- name: provisioningState
value: []
- name: resourceGuid
value: string
- name: systemData
value:
- name: createdBy
value: string
- name: createdByType
value: string
- name: createdAt
value: string
- name: lastModifiedBy
value: string
- name: lastModifiedByType
value: string
- name: lastModifiedAt
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: etag
value: string
DELETE
example
Deletes the specified groups
resource.
/*+ delete */
DELETE FROM azure.network.groups
WHERE networkGroupName = '{{ networkGroupName }}'
AND networkManagerName = '{{ networkManagerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';