PublicIPAddressesOperations interface

Package:

@azure/arm-network

Interface representing a PublicIPAddresses operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDdosProtectionStatus
beginDdosProtectionStatusAndWait
beginDelete
beginDeleteAndWait
beginDisassociateCloudServiceReservedPublicIp
beginDisassociateCloudServiceReservedPublicIpAndWait
beginReserveCloudServicePublicIpAddress
beginReserveCloudServicePublicIpAddressAndWait
createOrUpdate	Creates or updates a static or dynamic public IP address.
ddosProtectionStatus	Gets the Ddos Protection Status of a Public IP Address
delete	Deletes the specified public IP address.
disassociateCloudServiceReservedPublicIp	Disassociates the Cloud Service reserved Public IP and associates the specified Standalone Public IP to the same Cloud Service frontend.
get	Gets the specified public IP address in a specified resource group.
getCloudServicePublicIPAddress	Get the specified public IP address in a cloud service.
getVirtualMachineScaleSetPublicIPAddress	Get the specified public IP address in a virtual machine scale set.
list	Gets all public IP addresses in a resource group.
listAll	Gets all the public IP addresses in a subscription.
listCloudServicePublicIPAddresses	Gets information about all public IP addresses on a cloud service level.
listCloudServiceRoleInstancePublicIPAddresses	Gets information about all public IP addresses in a role instance IP configuration in a cloud service.
listVirtualMachineScaleSetPublicIPAddresses	Gets information about all public IP addresses on a virtual machine scale set level.
listVirtualMachineScaleSetVMPublicIPAddresses	Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.
reserveCloudServicePublicIpAddress	Reserves the specified Cloud Service Public IP by switching its allocation method to Static. If rollback is requested, reverts the allocation method to Dynamic.
updateTags	Updates public IP address tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => Promise<PublicIPAddress>

beginDdosProtectionStatus

Warning

This API is now deprecated.

use ddosProtectionStatus instead

beginDdosProtectionStatus: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIpDdosProtectionStatusResult>, PublicIpDdosProtectionStatusResult>>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIpDdosProtectionStatusResult>, PublicIpDdosProtectionStatusResult>>

beginDdosProtectionStatusAndWait

Warning

This API is now deprecated.

use ddosProtectionStatus instead

beginDdosProtectionStatusAndWait: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => Promise<PublicIpDdosProtectionStatusResult>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => Promise<PublicIpDdosProtectionStatusResult>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => Promise<void>

beginDisassociateCloudServiceReservedPublicIp

Warning

This API is now deprecated.

use disassociateCloudServiceReservedPublicIp instead

beginDisassociateCloudServiceReservedPublicIp: (resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

beginDisassociateCloudServiceReservedPublicIpAndWait

Warning

This API is now deprecated.

use disassociateCloudServiceReservedPublicIp instead

beginDisassociateCloudServiceReservedPublicIpAndWait: (resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => Promise<PublicIPAddress>

beginReserveCloudServicePublicIpAddress

Warning

This API is now deprecated.

use reserveCloudServicePublicIpAddress instead

beginReserveCloudServicePublicIpAddress: (resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>

beginReserveCloudServicePublicIpAddressAndWait

Warning

This API is now deprecated.

use reserveCloudServicePublicIpAddress instead

beginReserveCloudServicePublicIpAddressAndWait: (resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => Promise<PublicIPAddress>

createOrUpdate

Creates or updates a static or dynamic public IP address.

createOrUpdate: (resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

ddosProtectionStatus

Gets the Ddos Protection Status of a Public IP Address

ddosProtectionStatus: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => PollerLike<OperationState<PublicIpDdosProtectionStatusResult>, PublicIpDdosProtectionStatusResult>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams) => PollerLike<OperationState<PublicIpDdosProtectionStatusResult>, PublicIpDdosProtectionStatusResult>

delete

Deletes the specified public IP address.

delete: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

disassociateCloudServiceReservedPublicIp

Disassociates the Cloud Service reserved Public IP and associates the specified Standalone Public IP to the same Cloud Service frontend.

disassociateCloudServiceReservedPublicIp: (resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: DisassociateCloudServicePublicIpRequest, options?: PublicIPAddressesDisassociateCloudServiceReservedPublicIpOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

get

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

get: (resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesGetOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesGetOptionalParams) => Promise<PublicIPAddress>

getCloudServicePublicIPAddress

Get the specified public IP address in a cloud service.

getCloudServicePublicIPAddress: (resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetCloudServicePublicIPAddressOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetCloudServicePublicIPAddressOptionalParams) => Promise<PublicIPAddress>

getVirtualMachineScaleSetPublicIPAddress

Get the specified public IP address in a virtual machine scale set.

getVirtualMachineScaleSetPublicIPAddress: (resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressOptionalParams) => Promise<PublicIPAddress>

list

Gets all public IP addresses in a resource group.

list: (resourceGroupName: string, options?: PublicIPAddressesListOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(resourceGroupName: string, options?: PublicIPAddressesListOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listAll

Gets all the public IP addresses in a subscription.

listAll: (options?: PublicIPAddressesListAllOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(options?: PublicIPAddressesListAllOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listCloudServicePublicIPAddresses

Gets information about all public IP addresses on a cloud service level.

listCloudServicePublicIPAddresses: (resourceGroupName: string, cloudServiceName: string, options?: PublicIPAddressesListCloudServicePublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(resourceGroupName: string, cloudServiceName: string, options?: PublicIPAddressesListCloudServicePublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listCloudServiceRoleInstancePublicIPAddresses

Gets information about all public IP addresses in a role instance IP configuration in a cloud service.

listCloudServiceRoleInstancePublicIPAddresses: (resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListCloudServiceRoleInstancePublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListCloudServiceRoleInstancePublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listVirtualMachineScaleSetPublicIPAddresses

Gets information about all public IP addresses on a virtual machine scale set level.

listVirtualMachineScaleSetPublicIPAddresses: (resourceGroupName: string, virtualMachineScaleSetName: string, options?: PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(resourceGroupName: string, virtualMachineScaleSetName: string, options?: PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listVirtualMachineScaleSetVMPublicIPAddresses

Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.

listVirtualMachineScaleSetVMPublicIPAddresses: (resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

Property Value

(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesOptionalParams) => PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

reserveCloudServicePublicIpAddress

Reserves the specified Cloud Service Public IP by switching its allocation method to Static. If rollback is requested, reverts the allocation method to Dynamic.

reserveCloudServicePublicIpAddress: (resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: ReserveCloudServicePublicIpAddressRequest, options?: PublicIPAddressesReserveCloudServicePublicIpAddressOptionalParams) => PollerLike<OperationState<PublicIPAddress>, PublicIPAddress>

updateTags

Updates public IP address tags.

updateTags: (resourceGroupName: string, publicIpAddressName: string, parameters: TagsObject, options?: PublicIPAddressesUpdateTagsOptionalParams) => Promise<PublicIPAddress>

Property Value

(resourceGroupName: string, publicIpAddressName: string, parameters: TagsObject, options?: PublicIPAddressesUpdateTagsOptionalParams) => Promise<PublicIPAddress>