public_ip_prefixes

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

Overview

Name	public_ip_prefixes
Type	Resource
Id	azure.network.public_ip_prefixes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
customIPPrefix	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the public ip address.
ipPrefix	string	The allocated Prefix.
ipTags	array	The list of tags associated with the public IP prefix.
loadBalancerFrontendIpConfiguration	object	Reference to another subresource.
location	string	Resource location.
natGateway	object	NatGateway of Public IP Prefix.
prefixLength	integer	The Length of the Public IP Prefix.
provisioningState	string	The provisioning state of the public IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddressVersion	string	The public IP address version. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
publicIPAddresses	array	The list of all referenced PublicIPAddresses.
resourceGuid	string	The resource GUID property of the public IP prefix resource.
sku	object	The public IP prefix SKU.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
customIPPrefix	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the public ip address.
ipPrefix	string	The allocated Prefix.
ipTags	array	The list of tags associated with the public IP prefix.
loadBalancerFrontendIpConfiguration	object	Reference to another subresource.
location	string	Resource location.
natGateway	object	NatGateway of Public IP Prefix.
prefixLength	integer	The Length of the Public IP Prefix.
provisioningState	string	The provisioning state of the public IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddressVersion	string	The public IP address version. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
publicIPAddresses	array	The list of all referenced PublicIPAddresses.
resourceGuid	string	The resource GUID property of the public IP prefix resource.
sku	object	The public IP prefix SKU.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
customIPPrefix	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the public ip address.
ipPrefix	string	The allocated Prefix.
ipTags	array	The list of tags associated with the public IP prefix.
loadBalancerFrontendIpConfiguration	object	Reference to another subresource.
location	string	Resource location.
natGateway	object	NatGateway of Public IP Prefix.
prefixLength	integer	The Length of the Public IP Prefix.
provisioningState	string	The provisioning state of the public IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddressVersion	string	The public IP address version. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
publicIPAddresses	array	The list of all referenced PublicIPAddresses.
resourceGuid	string	The resource GUID property of the public IP prefix resource.
sku	object	The public IP prefix SKU.
tags	object	Resource tags.
type	string	Resource type.
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	resource_group_name, public_ip_prefix_name, subscription_id	$expand	Gets the specified public IP prefix in a specified resource group.
list	select	resource_group_name, subscription_id		Gets all public IP prefixes in a resource group.
list_all	select	subscription_id		Gets all the public IP prefixes in a subscription.
create_or_update	insert	resource_group_name, public_ip_prefix_name, subscription_id		Creates or updates a static or dynamic public IP prefix.
update_tags	update	resource_group_name, public_ip_prefix_name, subscription_id		Updates public IP prefix tags.
create_or_update	replace	resource_group_name, public_ip_prefix_name, subscription_id		Creates or updates a static or dynamic public IP prefix.
delete	delete	resource_group_name, public_ip_prefix_name, subscription_id		Deletes the specified public IP prefix.

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
public_ip_prefix_name	string	The name of the public IP prefix. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified public IP prefix in a specified resource group.

SELECT
id,
name,
customIPPrefix,
etag,
extendedLocation,
ipPrefix,
ipTags,
loadBalancerFrontendIpConfiguration,
location,
natGateway,
prefixLength,
provisioningState,
publicIPAddressVersion,
publicIPAddresses,
resourceGuid,
sku,
tags,
type,
zones
FROM azure.network.public_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND public_ip_prefix_name = '{{ public_ip_prefix_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all public IP prefixes in a resource group.

SELECT
id,
name,
customIPPrefix,
etag,
extendedLocation,
ipPrefix,
ipTags,
loadBalancerFrontendIpConfiguration,
location,
natGateway,
prefixLength,
provisioningState,
publicIPAddressVersion,
publicIPAddresses,
resourceGuid,
sku,
tags,
type,
zones
FROM azure.network.public_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the public IP prefixes in a subscription.

SELECT
id,
name,
customIPPrefix,
etag,
extendedLocation,
ipPrefix,
ipTags,
loadBalancerFrontendIpConfiguration,
location,
natGateway,
prefixLength,
provisioningState,
publicIPAddressVersion,
publicIPAddresses,
resourceGuid,
sku,
tags,
type,
zones
FROM azure.network.public_ip_prefixes
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a static or dynamic public IP prefix.

INSERT INTO azure.network.public_ip_prefixes (
id,
location,
tags,
properties,
extendedLocation,
sku,
zones,
resource_group_name,
public_ip_prefix_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ sku }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ public_ip_prefix_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
sku,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: public_ip_prefixes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the public_ip_prefixes resource.
  - name: public_ip_prefix_name
    value: "{{ public_ip_prefix_name }}"
    description: Required parameter for the public_ip_prefixes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the public_ip_prefixes resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Public IP prefix properties.
    value:
      publicIPAddressVersion: "{{ publicIPAddressVersion }}"
      ipTags:
        - ipTagType: "{{ ipTagType }}"
          tag: "{{ tag }}"
      prefixLength: {{ prefixLength }}
      ipPrefix: "{{ ipPrefix }}"
      publicIPAddresses:
        - id: "{{ id }}"
      loadBalancerFrontendIpConfiguration:
        id: "{{ id }}"
      customIPPrefix:
        id: "{{ id }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      natGateway:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
          publicIpAddresses:
            - id: "{{ id }}"
          publicIpAddressesV6:
            - id: "{{ id }}"
          publicIpPrefixes:
            - id: "{{ id }}"
          publicIpPrefixesV6:
            - id: "{{ id }}"
          subnets:
            - id: "{{ id }}"
          sourceVirtualNetwork:
            id: "{{ id }}"
          serviceGateway:
            id: "{{ id }}"
          nat64: "{{ nat64 }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
        sku:
          name: "{{ name }}"
        zones:
          - "{{ zones }}"
        etag: "{{ etag }}"
  - name: extendedLocation
    description: |
      The extended location of the public ip address.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: sku
    description: |
      The public IP prefix SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting the IP allocated for the resource needs to come from.

UPDATE examples

update_tags

Updates public IP prefix tags.

UPDATE azure.network.public_ip_prefixes
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_prefix_name = '{{ public_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
sku,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates a static or dynamic public IP prefix.

REPLACE azure.network.public_ip_prefixes
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
sku = '{{ sku }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_prefix_name = '{{ public_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
sku,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified public IP prefix.

DELETE FROM azure.network.public_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_prefix_name = '{{ public_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;