ip_allocations

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

Overview

Name	ip_allocations
Type	Resource
Id	azure.network.ip_allocations

Fields

vw_ip_allocations

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
allocation_tags	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
ipAllocationName	text	field from the properties object
ipam_allocation_id	text	field from the properties object
location	text	Resource location.
prefix	text	field from the properties object
prefix_length	text	field from the properties object
prefix_type	text	field from the properties object
resourceGroupName	text	field from the properties object
subnet	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_network	text	field from the properties object

ip_allocations

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.
location	string	Resource location.
properties	object	Properties of the IpAllocation.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	ipAllocationName, resourceGroupName, subscriptionId	Gets the specified IpAllocation by resource group.
list	SELECT	subscriptionId	Gets all IpAllocations in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets all IpAllocations in a resource group.
create_or_update	INSERT	ipAllocationName, resourceGroupName, subscriptionId	Creates or updates an IpAllocation in the specified resource group.
delete	DELETE	ipAllocationName, resourceGroupName, subscriptionId	Deletes the specified IpAllocation.
update_tags	EXEC	ipAllocationName, resourceGroupName, subscriptionId	Updates a IpAllocation tags.

SELECT examples

Gets all IpAllocations in a subscription.

vw_ip_allocations

SELECT
id,
name,
allocation_tags,
etag,
ipAllocationName,
ipam_allocation_id,
location,
prefix,
prefix_length,
prefix_type,
resourceGroupName,
subnet,
subscriptionId,
tags,
type,
virtual_network
FROM azure.network.vw_ip_allocations
WHERE subscriptionId = '{{ subscriptionId }}';

ip_allocations

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.ip_allocations
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.ip_allocations (
ipAllocationName,
resourceGroupName,
subscriptionId,
properties,
id,
location,
tags
)
SELECT 
'{{ ipAllocationName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: subnet
          value:
            - name: id
              value: string
        - name: type
          value: []
        - name: prefix
          value: string
        - name: prefixLength
          value: integer
        - name: prefixType
          value: []
        - name: ipamAllocationId
          value: string
        - name: allocationTags
          value: object
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified ip_allocations resource.

/*+ delete */
DELETE FROM azure.network.ip_allocations
WHERE ipAllocationName = '{{ ipAllocationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';