ip_pools

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

Overview

Name	ip_pools
Type	Resource
Id	azure_stack.fabric_admin.ip_pools

Fields

vw_ip_pools

Name	Datatype	Description
id	text	URI of the resource.
name	text	Name of the resource.
address_prefix	text	field from the properties object
end_ip_address	text	field from the properties object
ipPool	text	field from the properties object
location	text	The region where the resource is located.
number_of_allocated_ip_addresses	text	field from the properties object
number_of_ip_addresses	text	field from the properties object
number_of_ip_addresses_in_transition	text	field from the properties object
resourceGroupName	text	field from the properties object
start_ip_address	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	List of key-value pairs.
type	text	Type of resource.

ip_pools

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	The region where the resource is located.
properties	object	Properties of an IpPool.
tags	object	List of key-value pairs.
type	string	Type of resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	ipPool, location, resourceGroupName, subscriptionId	Return the requested IP pool.
list	SELECT	location, resourceGroupName, subscriptionId	Returns a list of all IP pools at a certain location.
create_or_update	INSERT	ipPool, location, resourceGroupName, subscriptionId	Create an IP pool. Once created an IP pool cannot be deleted.

SELECT examples

Returns a list of all IP pools at a certain location.

vw_ip_pools

SELECT
id,
name,
address_prefix,
end_ip_address,
ipPool,
location,
number_of_allocated_ip_addresses,
number_of_ip_addresses,
number_of_ip_addresses_in_transition,
resourceGroupName,
start_ip_address,
subscriptionId,
tags,
type
FROM azure_stack.fabric_admin.vw_ip_pools
WHERE location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

ip_pools

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.fabric_admin.ip_pools
WHERE location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new ip_pools resource.

All Properties

/*+ create */
INSERT INTO azure_stack.fabric_admin.ip_pools (
ipPool,
location,
resourceGroupName,
subscriptionId,
properties,
location,
tags
)
SELECT 
'{{ ipPool }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: startIpAddress
          value: string
        - name: endIpAddress
          value: string
        - name: addressPrefix
          value: string
        - name: numberOfIpAddresses
          value: integer
        - name: numberOfAllocatedIpAddresses
          value: integer
        - name: numberOfIpAddressesInTransition
          value: integer
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object