ip_groups

Creates, updates, deletes, gets or lists an ip_groups resource.

Overview

Name	ip_groups
Type	Resource
Id	azure.network.ip_groups

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting IpGroups resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpGroups.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Request successful. The operation returns a list of ipGroups resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpGroups.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of ipGroups resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpGroups.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, ipGroupsName, subscriptionId	$expand	Gets the specified ipGroups.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all IpGroups in a resource group.
list	select	subscriptionId		Gets all IpGroups in a subscription.
create_or_update	insert	resourceGroupName, ipGroupsName, subscriptionId		Creates or updates an ipGroups in a specified resource group.
update	update	resourceGroupName, ipGroupsName, subscriptionId		Updates tags of an IpGroups resource.
delete	delete	resourceGroupName, ipGroupsName, subscriptionId		Deletes the specified ipGroups.

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
ipGroupsName	string	The name of the ipGroups.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.

SELECT examples

get

Gets the specified ipGroups.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ipGroupsName = '{{ ipGroupsName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all IpGroups in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all IpGroups in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an ipGroups in a specified resource group.

INSERT INTO azure.network.ip_groups (
data__properties,
resourceGroupName,
ipGroupsName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ ipGroupsName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: ip_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ip_groups resource.
    - name: ipGroupsName
      value: string
      description: Required parameter for the ip_groups resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the ip_groups resource.
    - name: properties
      value: object
      description: |
        Properties of the IpGroups.

UPDATE examples

update

Updates tags of an IpGroups resource.

UPDATE azure.network.ip_groups
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND ipGroupsName = '{{ ipGroupsName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified ipGroups.

DELETE FROM azure.network.ip_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND ipGroupsName = '{{ ipGroupsName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;