ipam_pools

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

Overview

Name	ipam_pools
Type	Resource
Id	azure.network.ipam_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	List of IP address prefixes of the resource. Required.
description	string	:vartype description: str
displayName	string	String representing a friendly name for the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipAddressType	array	List of IP address type for the IpamPool.
location	string	The geo-location where the resource lives. Required.
parentPoolName	string	String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	List of IP address prefixes of the resource. Required.
description	string	:vartype description: str
displayName	string	String representing a friendly name for the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipAddressType	array	List of IP address type for the IpamPool.
location	string	The geo-location where the resource lives. Required.
parentPoolName	string	String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, network_manager_name, pool_name, subscription_id		Gets the specific Pool resource. Gets the specific Pool resource.
list	select	resource_group_name, network_manager_name, subscription_id	skipToken, skip, top, sortKey, sortValue	Gets list of Pool resources at Network Manager level. Gets list of Pool resources at Network Manager level.
create	insert	resource_group_name, network_manager_name, pool_name, subscription_id, location, properties		Creates/Updates the Pool resource. Creates/Updates the Pool resource.
update	update	resource_group_name, network_manager_name, pool_name, subscription_id		Updates the specific Pool resource. Updates the specific Pool resource.
delete	delete	resource_group_name, network_manager_name, pool_name, subscription_id		Delete the Pool resource. Delete the Pool resource.
list_associated_resources	exec	resource_group_name, network_manager_name, pool_name, subscription_id		List Associated Resource in the Pool. List Associated Resource in the Pool.
get_pool_usage	exec	resource_group_name, network_manager_name, pool_name, subscription_id		Get the Pool Usage. Get the Pool Usage.

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
network_manager_name	string	The name of the network manager. Required.
pool_name	string	Pool resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
skip	integer	Optional num entries to skip. Default value is 0.
skipToken	string	Optional skip token. Default value is None.
sortKey	string	Optional key by which to sort. Default value is None.
sortValue	string	Optional sort value for pagination. Default value is None.
top	integer	Optional num entries to show. Default value is 50.

SELECT examples

get

Gets the specific Pool resource. Gets the specific Pool resource.

SELECT
id,
name,
addressPrefixes,
description,
displayName,
etag,
ipAddressType,
location,
parentPoolName,
provisioningState,
systemData,
tags,
type
FROM azure.network.ipam_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets list of Pool resources at Network Manager level. Gets list of Pool resources at Network Manager level.

SELECT
id,
name,
addressPrefixes,
description,
displayName,
etag,
ipAddressType,
location,
parentPoolName,
provisioningState,
systemData,
tags,
type
FROM azure.network.ipam_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND skip = '{{ skip }}'
AND top = '{{ top }}'
AND sortKey = '{{ sortKey }}'
AND sortValue = '{{ sortValue }}'
;

INSERT examples

create

Creates/Updates the Pool resource. Creates/Updates the Pool resource.

INSERT INTO azure.network.ipam_pools (
tags,
location,
properties,
resource_group_name,
network_manager_name,
pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ipam_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ipam_pools resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the ipam_pools resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the ipam_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ipam_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of IpamPool resource properties which are specific to the Pool resource. Required.
    value:
      description: "{{ description }}"
      displayName: "{{ displayName }}"
      ipAddressType:
        - "{{ ipAddressType }}"
      parentPoolName: "{{ parentPoolName }}"
      addressPrefixes:
        - "{{ addressPrefixes }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates the specific Pool resource. Updates the specific Pool resource.

UPDATE azure.network.ipam_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the Pool resource. Delete the Pool resource.

DELETE FROM azure.network.ipam_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_associated_resources

List Associated Resource in the Pool. List Associated Resource in the Pool.

EXEC azure.network.ipam_pools.list_associated_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_manager_name='{{ network_manager_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_pool_usage

Get the Pool Usage. Get the Pool Usage.

EXEC azure.network.ipam_pools.get_pool_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_manager_name='{{ network_manager_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;