ip_pools

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

Overview

Name	ip_pools
Type	Resource
Id	azure_stack.fabric_admin.ip_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Properties of an IpPool.
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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Properties of an IpPool.
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	subscriptionId, resourceGroupName, location, ipPool		Return the requested IP pool.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns a list of all IP pools at a certain location.
create_or_update	insert	subscriptionId, resourceGroupName, location, ipPool		Create an IP pool. Once created an IP pool cannot be deleted.

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
ipPool	string	IP pool name.
location	string	The name of Azure region.
resourceGroupName	string	Name of the resource group.
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.

SELECT examples

get

Return the requested IP pool.

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

list

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

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

INSERT examples

create_or_update

Create an IP pool. Once created an IP pool cannot be deleted.

INSERT INTO azure_stack.fabric_admin.ip_pools (
data__properties,
subscriptionId,
resourceGroupName,
location,
ipPool
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ location }}',
'{{ ipPool }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: ip_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the ip_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ip_pools resource.
    - name: location
      value: string
      description: Required parameter for the ip_pools resource.
    - name: ipPool
      value: string
      description: Required parameter for the ip_pools resource.
    - name: properties
      value: object
      description: |
        Properties of an IpPool.