ip_allocations

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

Overview

Name	ip_allocations
Type	Resource
Id	azure.network.ip_allocations

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting IpAllocation resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpAllocation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Request successful. The operation returns a list of IpAllocation resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpAllocation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of IpAllocation resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the IpAllocation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resourceGroupName, ipAllocationName, subscriptionId	$expand	Gets the specified IpAllocation by resource group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all IpAllocations in a resource group.
list	select	subscriptionId		Gets all IpAllocations in a subscription.
create_or_update	insert	resourceGroupName, ipAllocationName, subscriptionId		Creates or updates an IpAllocation in the specified resource group.
delete	delete	resourceGroupName, ipAllocationName, subscriptionId		Deletes the specified IpAllocation.
update_tags	exec	resourceGroupName, ipAllocationName, subscriptionId		Updates a IpAllocation tags.

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
ipAllocationName	string	The name of the IpAllocation.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified IpAllocation by resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_allocations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ipAllocationName = '{{ ipAllocationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all IpAllocations in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_allocations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all IpAllocations in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ip_allocations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an IpAllocation in the specified resource group.

INSERT INTO azure.network.ip_allocations (
data__properties,
resourceGroupName,
ipAllocationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ ipAllocationName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: ip_allocations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ip_allocations resource.
    - name: ipAllocationName
      value: string
      description: Required parameter for the ip_allocations resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the ip_allocations resource.
    - name: properties
      value: object
      description: |
        Properties of the IpAllocation.

DELETE examples

delete

Deletes the specified IpAllocation.

DELETE FROM azure.network.ip_allocations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND ipAllocationName = '{{ ipAllocationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a IpAllocation tags.

EXEC azure.network.ip_allocations.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@ipAllocationName='{{ ipAllocationName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;