PublicIPAddress interface

Package:

@azure/arm-network

Public IP address resource.

Extends

Resource

Properties

ddosSettings	The DDoS protection custom policy associated with the public IP address.
deleteOption	Specify what happens to the public IP address when the VM using it is deleted
dnsSettings	The FQDN of the DNS record associated with the public IP address.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extended location of the public ip address.
idleTimeoutInMinutes	The idle timeout of the public IP address.
ipAddress	The IP address associated with the public IP address resource.
ipConfiguration	The IP configuration associated with the public IP address. NOTE: This property will not be serialized. It can only be populated by the server.
ipTags	The list of tags associated with the public IP address.
linkedPublicIPAddress	The linked public IP address of the public IP address resource.
migrationPhase	Migration phase of Public IP Address.
natGateway	The NatGateway for the Public IP address.
provisioningState	The provisioning state of the public IP address resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicIPAddressVersion	The public IP address version.
publicIPAllocationMethod	The public IP address allocation method.
publicIPPrefix	The Public IP Prefix this Public IP Address should be allocated from.
resourceGuid	The resource GUID property of the public IP address resource. NOTE: This property will not be serialized. It can only be populated by the server.
servicePublicIPAddress	The service public IP address of the public IP address resource.
sku	The public IP address SKU.
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

ddosSettings

The DDoS protection custom policy associated with the public IP address.

ddosSettings?: DdosSettings

Property Value

DdosSettings

deleteOption

Specify what happens to the public IP address when the VM using it is deleted

deleteOption?: string

Property Value

string

dnsSettings

The FQDN of the DNS record associated with the public IP address.

dnsSettings?: PublicIPAddressDnsSettings

Property Value

PublicIPAddressDnsSettings

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

extendedLocation

The extended location of the public ip address.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

idleTimeoutInMinutes

The idle timeout of the public IP address.

idleTimeoutInMinutes?: number

Property Value

number

ipAddress

The IP address associated with the public IP address resource.

ipAddress?: string

Property Value

string

ipConfiguration

The IP configuration associated with the public IP address. NOTE: This property will not be serialized. It can only be populated by the server.

ipConfiguration?: IPConfiguration

Property Value

IPConfiguration

ipTags

The list of tags associated with the public IP address.

ipTags?: IpTag[]

Property Value

IpTag[]

linkedPublicIPAddress

The linked public IP address of the public IP address resource.

linkedPublicIPAddress?: PublicIPAddress

Property Value

PublicIPAddress

migrationPhase

Migration phase of Public IP Address.

migrationPhase?: string

Property Value

string

natGateway

The NatGateway for the Public IP address.

natGateway?: NatGateway

Property Value

NatGateway

provisioningState

The provisioning state of the public IP address resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicIPAddressVersion

The public IP address version.

publicIPAddressVersion?: string

Property Value

string

publicIPAllocationMethod

The public IP address allocation method.

publicIPAllocationMethod?: string

Property Value

string

publicIPPrefix

The Public IP Prefix this Public IP Address should be allocated from.

publicIPPrefix?: SubResource

Property Value

SubResource

resourceGuid

The resource GUID property of the public IP address resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

servicePublicIPAddress

The service public IP address of the public IP address resource.

servicePublicIPAddress?: PublicIPAddress

Property Value

PublicIPAddress

sku

The public IP address SKU.

sku?: PublicIPAddressSku

Property Value

PublicIPAddressSku

zones

A list of availability zones denoting the IP allocated for the resource needs to come from.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type