public_ip_addresses

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

Overview

Name	public_ip_addresses
Type	Resource
Id	azure.network.public_ip_addresses

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting PublicIPAddress 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 public ip address.
properties	object	Public IP address properties.
sku	object	The public IP address SKU.
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 PublicIPAddress 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 public ip address.
properties	object	Public IP address properties.
sku	object	The public IP address SKU.
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 PublicIPAddress 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 public ip address.
properties	object	Public IP address properties.
sku	object	The public IP address SKU.
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, publicIpAddressName, subscriptionId	$expand	Gets the specified public IP address in a specified resource group.
list	select	resourceGroupName, subscriptionId		Gets all public IP addresses in a resource group.
list_all	select	subscriptionId		Gets all the public IP addresses in a subscription.
create_or_update	insert	resourceGroupName, publicIpAddressName, subscriptionId		Creates or updates a static or dynamic public IP address.
delete	delete	resourceGroupName, publicIpAddressName, subscriptionId		Deletes the specified public IP address.
update_tags	exec	resourceGroupName, publicIpAddressName, subscriptionId		Updates public IP address tags.
ddos_protection_status	exec	resourceGroupName, publicIpAddressName, subscriptionId		Gets the Ddos Protection Status of a Public IP Address

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
publicIpAddressName	string	The name of the public IP address.
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 public IP address in a specified resource group.

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

list

Gets all public IP addresses in a resource group.

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

list_all

Gets all the public IP addresses in a subscription.

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

INSERT examples

create_or_update

Creates or updates a static or dynamic public IP address.

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

Manifest

# Description fields are for documentation purposes
- name: public_ip_addresses
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the public_ip_addresses resource.
    - name: publicIpAddressName
      value: string
      description: Required parameter for the public_ip_addresses resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the public_ip_addresses resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the public ip address.
    - name: sku
      value: object
      description: |
        The public IP address SKU.
    - name: properties
      value: object
      description: |
        Public IP address 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 public IP address.

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

Lifecycle Methods

update_tags

Updates public IP address tags.

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

ddos_protection_status

Gets the Ddos Protection Status of a Public IP Address

EXEC azure.network.public_ip_addresses.ddos_protection_status 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@publicIpAddressName='{{ publicIpAddressName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;