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

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.
firewallPolicies	array	List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls	array	List of references to Firewall resources that this IpGroups is associated with.
ipAddresses	array	IpAddresses/IpAddressPrefixes in the IpGroups resource.
location	string	Resource location.
provisioningState	string	The provisioning state of the IpGroups resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_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.
firewallPolicies	array	List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls	array	List of references to Firewall resources that this IpGroups is associated with.
ipAddresses	array	IpAddresses/IpAddressPrefixes in the IpGroups resource.
location	string	Resource location.
provisioningState	string	The provisioning state of the IpGroups resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.

list

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.
firewallPolicies	array	List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls	array	List of references to Firewall resources that this IpGroups is associated with.
ipAddresses	array	IpAddresses/IpAddressPrefixes in the IpGroups resource.
location	string	Resource location.
provisioningState	string	The provisioning state of the IpGroups resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, ip_groups_name, subscription_id	$expand	Gets the specified ipGroups.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all IpGroups in a resource group.
list	select	subscription_id		Gets all IpGroups in a subscription.
create_or_update	insert	resource_group_name, ip_groups_name, subscription_id		Creates or updates an ipGroups in a specified resource group.
create_or_update	replace	resource_group_name, ip_groups_name, subscription_id		Creates or updates an ipGroups in a specified resource group.
delete	delete	resource_group_name, ip_groups_name, subscription_id		Deletes the specified ipGroups.
update_groups	exec	resource_group_name, ip_groups_name, subscription_id		Updates tags of an IpGroups resource.

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
ip_groups_name	string	The name of the ipGroups. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource. Default value is None.

SELECT examples

get

Gets the specified ipGroups.

SELECT
id,
name,
etag,
firewallPolicies,
firewalls,
ipAddresses,
location,
provisioningState,
tags,
type
FROM azure.network.ip_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND ip_groups_name = '{{ ip_groups_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all IpGroups in a resource group.

SELECT
id,
name,
etag,
firewallPolicies,
firewalls,
ipAddresses,
location,
provisioningState,
tags,
type
FROM azure.network.ip_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all IpGroups in a subscription.

SELECT
id,
name,
etag,
firewallPolicies,
firewalls,
ipAddresses,
location,
provisioningState,
tags,
type
FROM azure.network.ip_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an ipGroups in a specified resource group.

INSERT INTO azure.network.ip_groups (
id,
location,
tags,
properties,
resource_group_name,
ip_groups_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ ip_groups_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ip_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ip_groups resource.
  - name: ip_groups_name
    value: "{{ ip_groups_name }}"
    description: Required parameter for the ip_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ip_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the IpGroups.
    value:
      provisioningState: "{{ provisioningState }}"
      ipAddresses:
        - "{{ ipAddresses }}"
      firewalls:
        - id: "{{ id }}"
      firewallPolicies:
        - id: "{{ id }}"

REPLACE examples

create_or_update

Creates or updates an ipGroups in a specified resource group.

REPLACE azure.network.ip_groups
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ip_groups_name = '{{ ip_groups_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified ipGroups.

DELETE FROM azure.network.ip_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND ip_groups_name = '{{ ip_groups_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_groups

Updates tags of an IpGroups resource.

EXEC azure.network.ip_groups.update_groups 
@resource_group_name='{{ resource_group_name }}' --required, 
@ip_groups_name='{{ ip_groups_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;