custom_ip_prefixes

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

Overview

Name	custom_ip_prefixes
Type	Resource
Id	azure.network.custom_ip_prefixes

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting CustomIpPrefix 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.
extendedLocation	object	The extended location of the custom IP prefix.
properties	object	Custom IP prefix properties.
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"
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list

Request successful. The operation returns a list of CustomIpPrefix 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.
extendedLocation	object	The extended location of the custom IP prefix.
properties	object	Custom IP prefix properties.
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"
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list_all

Request successful. The operation returns a list of CustomIpPrefix 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.
extendedLocation	object	The extended location of the custom IP prefix.
properties	object	Custom IP prefix properties.
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"
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, customIpPrefixName, subscriptionId	$expand	Gets the specified custom IP prefix in a specified resource group.
list	select	resourceGroupName, subscriptionId		Gets all custom IP prefixes in a resource group.
list_all	select	subscriptionId		Gets all the custom IP prefixes in a subscription.
create_or_update	insert	resourceGroupName, customIpPrefixName, subscriptionId		Creates or updates a custom IP prefix.
delete	delete	resourceGroupName, customIpPrefixName, subscriptionId		Deletes the specified custom IP prefix.
update_tags	exec	resourceGroupName, customIpPrefixName, subscriptionId		Updates custom IP prefix 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
customIpPrefixName	string	The name of the custom IP prefix.
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 custom IP prefix in a specified resource group.

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

list

Gets all custom IP prefixes in a resource group.

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

list_all

Gets all the custom IP prefixes in a subscription.

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

INSERT examples

create_or_update

Creates or updates a custom IP prefix.

INSERT INTO azure.network.custom_ip_prefixes (
data__extendedLocation,
data__properties,
data__zones,
resourceGroupName,
customIpPrefixName,
subscriptionId
)
SELECT 
'{{ extendedLocation }}',
'{{ properties }}',
'{{ zones }}',
'{{ resourceGroupName }}',
'{{ customIpPrefixName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
properties,
systemData,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: custom_ip_prefixes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_ip_prefixes resource.
    - name: customIpPrefixName
      value: string
      description: Required parameter for the custom_ip_prefixes resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the custom_ip_prefixes resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the custom IP prefix.
    - name: properties
      value: object
      description: |
        Custom IP prefix properties.
    - name: zones
      value: array
      description: |
        A list of availability zones denoting the IP allocated for the resource needs to come from.

DELETE examples

delete

Deletes the specified custom IP prefix.

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

Lifecycle Methods

update_tags

Updates custom IP prefix tags.

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