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

vw_public_ip_prefixes

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
custom_ip_prefix	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
extended_location	text	field from the properties object
ip_prefix	text	field from the properties object
ip_tags	text	field from the properties object
load_balancer_frontend_ip_configuration	text	field from the properties object
location	text	Resource location.
nat_gateway	text	field from the properties object
prefix_length	text	field from the properties object
provisioning_state	text	field from the properties object
publicIpPrefixName	text	field from the properties object
public_ip_address_version	text	field from the properties object
public_ip_addresses	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guid	text	field from the properties object
sku	text	SKU of a public IP prefix.
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
zones	text	A list of availability zones denoting the IP allocated for the resource needs to come from.

public_ip_prefixes

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.
extendedLocation	object	ExtendedLocation complex type.
location	string	Resource location.
properties	object	Public IP prefix properties.
sku	object	SKU of a public IP prefix.
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

Name	Accessible by	Required Params	Description
get	SELECT	publicIpPrefixName, resourceGroupName, subscriptionId	Gets the specified public IP prefix in a specified resource group.
list	SELECT	resourceGroupName, subscriptionId	Gets all public IP prefixes in a resource group.
list_all	SELECT	subscriptionId	Gets all the public IP prefixes in a subscription.
create_or_update	INSERT	publicIpPrefixName, resourceGroupName, subscriptionId	Creates or updates a static or dynamic public IP prefix.
delete	DELETE	publicIpPrefixName, resourceGroupName, subscriptionId	Deletes the specified public IP prefix.
update_tags	EXEC	publicIpPrefixName, resourceGroupName, subscriptionId	Updates public IP prefix tags.

SELECT examples

Gets all the public IP prefixes in a subscription.

vw_public_ip_prefixes

SELECT
id,
name,
custom_ip_prefix,
etag,
extended_location,
ip_prefix,
ip_tags,
load_balancer_frontend_ip_configuration,
location,
nat_gateway,
prefix_length,
provisioning_state,
publicIpPrefixName,
public_ip_address_version,
public_ip_addresses,
resourceGroupName,
resource_guid,
sku,
subscriptionId,
tags,
type,
zones
FROM azure.network.vw_public_ip_prefixes
WHERE subscriptionId = '{{ subscriptionId }}';

public_ip_prefixes

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.public_ip_prefixes (
publicIpPrefixName,
resourceGroupName,
subscriptionId,
extendedLocation,
sku,
properties,
zones,
id,
location,
tags
)
SELECT 
'{{ publicIpPrefixName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ extendedLocation }}',
'{{ sku }}',
'{{ properties }}',
'{{ zones }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: properties
      value:
        - name: publicIPAddressVersion
          value: []
        - name: ipTags
          value:
            - - name: ipTagType
                value: string
              - name: tag
                value: string
        - name: prefixLength
          value: integer
        - name: ipPrefix
          value: string
        - name: publicIPAddresses
          value:
            - - name: id
                value: string
        - name: loadBalancerFrontendIpConfiguration
          value:
            - name: id
              value: string
        - name: resourceGuid
          value: string
        - name: provisioningState
          value: []
        - name: natGateway
          value:
            - name: sku
              value:
                - name: name
                  value: string
            - name: properties
              value:
                - name: idleTimeoutInMinutes
                  value: integer
                - name: publicIpAddresses
                  value:
                    - - name: id
                        value: string
                - name: publicIpPrefixes
                  value:
                    - - name: id
                        value: string
                - name: subnets
                  value:
                    - - name: id
                        value: string
                - name: resourceGuid
                  value: string
            - name: zones
              value:
                - string
            - name: etag
              value: string
            - name: id
              value: string
            - name: name
              value: string
            - name: type
              value: string
            - name: location
              value: string
            - name: tags
              value: object
    - name: etag
      value: string
    - name: zones
      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 public_ip_prefixes resource.

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