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_cloud_service_public_ip_address
- get_virtual_machine_scale_set_public_ip_address
- list_cloud_service_role_instance_public_ip_addresses
- list_virtual_machine_scale_set_vm_public_ip_addresses
- get
- list_cloud_service_public_ip_addresses
- list_virtual_machine_scale_set_public_ip_addresses
- list
- list_all
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
ddosSettings | object | The DDoS protection custom policy associated with the public IP address. |
deleteOption | string | Specify what happens to the public IP address when the VM using it is deleted. Known values are: "Delete" and "Detach". (Delete, Detach) |
dnsSettings | object | The FQDN of the DNS record associated with the public IP address. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | The extended location of the public ip address. |
idleTimeoutInMinutes | integer | The idle timeout of the public IP address. |
ipAddress | string | The IP address associated with the public IP address resource. |
ipConfiguration | object | IP configuration. |
ipTags | array | The list of tags associated with the public IP address. |
linkedPublicIPAddress | object | The linked public IP address of the public IP address resource. |
location | string | Resource location. |
migrationPhase | string | Migration phase of Public IP Address. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed) |
natGateway | object | The NatGateway for the Public IP address. |
provisioningState | string | The provisioning state of the public IP address 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) |
publicIPAllocationMethod | string | The public IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic) |
publicIPPrefix | object | Reference to another subresource. |
resourceGuid | string | The resource GUID property of the public IP address resource. |
servicePublicIPAddress | object | The service public IP address of the public IP address resource. |
sku | object | The public IP address 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:
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 |
|---|---|---|
cloud_service_name | string | The name of the cloud service. Required. |
ip_configuration_name | string | Required. |
network_interface_name | string | Required. |
public_ip_address_name | string | The name of the public IP address. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
role_instance_name | string | The role instance name. Required. |
subscription_id | string | |
virtual_machine_scale_set_name | string | The name of the virtual machine scale set. Required. |
virtualmachine_index | string | Required. |
$expand | string | Expands referenced resources. Default value is None. |
SELECT examples
- get_cloud_service_public_ip_address
- get_virtual_machine_scale_set_public_ip_address
- list_cloud_service_role_instance_public_ip_addresses
- list_virtual_machine_scale_set_vm_public_ip_addresses
- get
- list_cloud_service_public_ip_addresses
- list_virtual_machine_scale_set_public_ip_addresses
- list
- list_all
Get the specified public IP address in a cloud service.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND role_instance_name = '{{ role_instance_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND public_ip_address_name = '{{ public_ip_address_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;
Get the specified public IP address in a virtual machine scale set.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND virtualmachine_index = '{{ virtualmachine_index }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND public_ip_address_name = '{{ public_ip_address_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;
Gets information about all public IP addresses in a role instance IP configuration in a cloud service.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND role_instance_name = '{{ role_instance_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND virtualmachine_index = '{{ virtualmachine_index }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets the specified public IP address in a specified resource group.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND public_ip_address_name = '{{ public_ip_address_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;
Gets information about all public IP addresses on a cloud service level.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets information about all public IP addresses on a virtual machine scale set level.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets all public IP addresses in a resource group.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets all the public IP addresses in a subscription.
SELECT
id,
name,
ddosSettings,
deleteOption,
dnsSettings,
etag,
extendedLocation,
idleTimeoutInMinutes,
ipAddress,
ipConfiguration,
ipTags,
linkedPublicIPAddress,
location,
migrationPhase,
natGateway,
provisioningState,
publicIPAddressVersion,
publicIPAllocationMethod,
publicIPPrefix,
resourceGuid,
servicePublicIPAddress,
sku,
tags,
type,
zones
FROM azure.network.public_ip_addresses
WHERE subscription_id = '{{ subscription_id }}' -- required
;
INSERT examples
- create_or_update
- Manifest
Creates or updates a static or dynamic public IP address.
INSERT INTO azure.network.public_ip_addresses (
id,
location,
tags,
properties,
extendedLocation,
sku,
zones,
resource_group_name,
public_ip_address_name,
subscription_id
)
SELECT
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ sku }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ public_ip_address_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
sku,
tags,
type,
zones
;
# Description fields are for documentation purposes
- name: public_ip_addresses
props:
- name: resource_group_name
value: "{{ resource_group_name }}"
description: Required parameter for the public_ip_addresses resource.
- name: public_ip_address_name
value: "{{ public_ip_address_name }}"
description: Required parameter for the public_ip_addresses resource.
- name: subscription_id
value: "{{ subscription_id }}"
description: Required parameter for the public_ip_addresses 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 address properties.
value:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration:
id: "{{ id }}"
properties:
privateIPAddress: "{{ privateIPAddress }}"
privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
subnet:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
properties:
addressPrefix: "{{ addressPrefix }}"
addressPrefixes: "{{ addressPrefixes }}"
networkSecurityGroup: "{{ networkSecurityGroup }}"
routeTable: "{{ routeTable }}"
natGateway: "{{ natGateway }}"
serviceEndpoints: "{{ serviceEndpoints }}"
serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
privateEndpoints: "{{ privateEndpoints }}"
ipConfigurations: "{{ ipConfigurations }}"
ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
ipAllocations: "{{ ipAllocations }}"
resourceNavigationLinks: "{{ resourceNavigationLinks }}"
serviceAssociationLinks: "{{ serviceAssociationLinks }}"
delegations: "{{ delegations }}"
purpose: "{{ purpose }}"
provisioningState: "{{ provisioningState }}"
privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
sharingScope: "{{ sharingScope }}"
defaultOutboundAccess: {{ defaultOutboundAccess }}
ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
serviceGateway: "{{ serviceGateway }}"
etag: "{{ etag }}"
publicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration: "{{ ipConfiguration }}"
dnsSettings: "{{ dnsSettings }}"
ddosSettings: "{{ ddosSettings }}"
ipTags: "{{ ipTags }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix: "{{ publicIPPrefix }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress: "{{ servicePublicIPAddress }}"
natGateway: "{{ natGateway }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
provisioningState: "{{ provisioningState }}"
name: "{{ name }}"
etag: "{{ etag }}"
dnsSettings:
domainNameLabel: "{{ domainNameLabel }}"
domainNameLabelScope: "{{ domainNameLabelScope }}"
fqdn: "{{ fqdn }}"
reverseFqdn: "{{ reverseFqdn }}"
ddosSettings:
protectionMode: "{{ protectionMode }}"
ddosCustomPolicy:
id: "{{ id }}"
ddosProtectionPlan:
id: "{{ id }}"
ipTags:
- ipTagType: "{{ ipTagType }}"
tag: "{{ tag }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix:
id: "{{ id }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration:
id: "{{ id }}"
properties:
privateIPAddress: "{{ privateIPAddress }}"
privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
subnet: "{{ subnet }}"
publicIPAddress: "{{ publicIPAddress }}"
provisioningState: "{{ provisioningState }}"
name: "{{ name }}"
etag: "{{ etag }}"
dnsSettings:
domainNameLabel: "{{ domainNameLabel }}"
domainNameLabelScope: "{{ domainNameLabelScope }}"
fqdn: "{{ fqdn }}"
reverseFqdn: "{{ reverseFqdn }}"
ddosSettings:
protectionMode: "{{ protectionMode }}"
ddosCustomPolicy:
id: "{{ id }}"
ddosProtectionPlan:
id: "{{ id }}"
ipTags:
- ipTagType: "{{ ipTagType }}"
tag: "{{ tag }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix:
id: "{{ id }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration: "{{ ipConfiguration }}"
dnsSettings: "{{ dnsSettings }}"
ddosSettings: "{{ ddosSettings }}"
ipTags: "{{ ipTags }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix: "{{ publicIPPrefix }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress: "{{ servicePublicIPAddress }}"
natGateway: "{{ natGateway }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
natGateway:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
publicIpAddresses: "{{ publicIpAddresses }}"
publicIpAddressesV6: "{{ publicIpAddressesV6 }}"
publicIpPrefixes: "{{ publicIpPrefixes }}"
publicIpPrefixesV6: "{{ publicIpPrefixesV6 }}"
subnets: "{{ subnets }}"
sourceVirtualNetwork: "{{ sourceVirtualNetwork }}"
serviceGateway: "{{ serviceGateway }}"
nat64: "{{ nat64 }}"
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
sku:
name: "{{ name }}"
zones:
- "{{ zones }}"
etag: "{{ etag }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration: "{{ ipConfiguration }}"
dnsSettings: "{{ dnsSettings }}"
ddosSettings: "{{ ddosSettings }}"
ipTags: "{{ ipTags }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix: "{{ publicIPPrefix }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress: "{{ servicePublicIPAddress }}"
natGateway: "{{ natGateway }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
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 }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration:
id: "{{ id }}"
properties:
privateIPAddress: "{{ privateIPAddress }}"
privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
subnet: "{{ subnet }}"
publicIPAddress: "{{ publicIPAddress }}"
provisioningState: "{{ provisioningState }}"
name: "{{ name }}"
etag: "{{ etag }}"
dnsSettings:
domainNameLabel: "{{ domainNameLabel }}"
domainNameLabelScope: "{{ domainNameLabelScope }}"
fqdn: "{{ fqdn }}"
reverseFqdn: "{{ reverseFqdn }}"
ddosSettings:
protectionMode: "{{ protectionMode }}"
ddosCustomPolicy:
id: "{{ id }}"
ddosProtectionPlan:
id: "{{ id }}"
ipTags:
- ipTagType: "{{ ipTagType }}"
tag: "{{ tag }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix:
id: "{{ id }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration: "{{ ipConfiguration }}"
dnsSettings: "{{ dnsSettings }}"
ddosSettings: "{{ ddosSettings }}"
ipTags: "{{ ipTags }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix: "{{ publicIPPrefix }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress: "{{ servicePublicIPAddress }}"
natGateway: "{{ natGateway }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
natGateway:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
publicIpAddresses: "{{ publicIpAddresses }}"
publicIpAddressesV6: "{{ publicIpAddressesV6 }}"
publicIpPrefixes: "{{ publicIpPrefixes }}"
publicIpPrefixesV6: "{{ publicIpPrefixesV6 }}"
subnets: "{{ subnets }}"
sourceVirtualNetwork: "{{ sourceVirtualNetwork }}"
serviceGateway: "{{ serviceGateway }}"
nat64: "{{ nat64 }}"
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
sku:
name: "{{ name }}"
zones:
- "{{ zones }}"
etag: "{{ etag }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress:
id: "{{ id }}"
name: "{{ name }}"
type: "{{ type }}"
location: "{{ location }}"
tags: "{{ tags }}"
properties:
publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
publicIPAddressVersion: "{{ publicIPAddressVersion }}"
ipConfiguration: "{{ ipConfiguration }}"
dnsSettings: "{{ dnsSettings }}"
ddosSettings: "{{ ddosSettings }}"
ipTags: "{{ ipTags }}"
ipAddress: "{{ ipAddress }}"
publicIPPrefix: "{{ publicIPPrefix }}"
idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
resourceGuid: "{{ resourceGuid }}"
provisioningState: "{{ provisioningState }}"
servicePublicIPAddress: "{{ servicePublicIPAddress }}"
natGateway: "{{ natGateway }}"
migrationPhase: "{{ migrationPhase }}"
linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
deleteOption: "{{ deleteOption }}"
extendedLocation:
name: "{{ name }}"
type: "{{ type }}"
sku:
name: "{{ name }}"
tier: "{{ tier }}"
etag: "{{ etag }}"
zones:
- "{{ zones }}"
deleteOption: "{{ deleteOption }}"
- name: extendedLocation
description: |
The extended location of the public ip address.
value:
name: "{{ name }}"
type: "{{ type }}"
- name: sku
description: |
The public IP address 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 address tags.
UPDATE azure.network.public_ip_addresses
SET
tags = '{{ tags }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_address_name = '{{ public_ip_address_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 address.
REPLACE azure.network.public_ip_addresses
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_address_name = '{{ public_ip_address_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 address.
DELETE FROM azure.network.public_ip_addresses
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_address_name = '{{ public_ip_address_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;
Lifecycle Methods
- ddos_protection_status
- reserve_cloud_service_public_ip_address
- disassociate_cloud_service_reserved_public_ip
Gets the Ddos Protection Status of a Public IP Address.
EXEC azure.network.public_ip_addresses.ddos_protection_status
@resource_group_name='{{ resource_group_name }}' --required,
@public_ip_address_name='{{ public_ip_address_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Reserves the specified Cloud Service Public IP by switching its allocation method to Static. If rollback is requested, reverts the allocation method to Dynamic.
EXEC azure.network.public_ip_addresses.reserve_cloud_service_public_ip_address
@resource_group_name='{{ resource_group_name }}' --required,
@public_ip_address_name='{{ public_ip_address_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"isRollback": "{{ isRollback }}"
}'
;
Disassociates the Cloud Service reserved Public IP and associates the specified Standalone Public IP to the same Cloud Service frontend.
EXEC azure.network.public_ip_addresses.disassociate_cloud_service_reserved_public_ip
@resource_group_name='{{ resource_group_name }}' --required,
@public_ip_address_name='{{ public_ip_address_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"publicIpArmId": "{{ publicIpArmId }}"
}'
;