PublicIPAddresses interface

Package:

@azure/arm-network-profile-2020-09-01-hybrid

Interface representing a PublicIPAddresses.

Methods

beginCreateOrUpdate(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)	Creates or updates a static or dynamic public IP address.
beginCreateOrUpdateAndWait(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)	Creates or updates a static or dynamic public IP address.
beginDelete(string, string, PublicIPAddressesDeleteOptionalParams)	Deletes the specified public IP address.
beginDeleteAndWait(string, string, PublicIPAddressesDeleteOptionalParams)	Deletes the specified public IP address.
beginUpdateTags(string, string, TagsObject, PublicIPAddressesUpdateTagsOptionalParams)	Updates public IP address tags.
beginUpdateTagsAndWait(string, string, TagsObject, PublicIPAddressesUpdateTagsOptionalParams)	Updates public IP address tags.
get(string, string, PublicIPAddressesGetOptionalParams)	Gets the specified public IP address in a specified resource group.
list(string, PublicIPAddressesListOptionalParams)	Gets all public IP addresses in a resource group.
listAll(PublicIPAddressesListAllOptionalParams)	Gets all the public IP addresses in a subscription.

Method Details

beginCreateOrUpdate(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)

Creates or updates a static or dynamic public IP address.

function beginCreateOrUpdate(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PublicIPAddress>, PublicIPAddress>>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the public IP address.

parameters

PublicIPAddress

Parameters supplied to the create or update public IP address operation.

options

PublicIPAddressesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<PublicIPAddress>, PublicIPAddress>>

beginCreateOrUpdateAndWait(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)

Creates or updates a static or dynamic public IP address.

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

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the public IP address.

parameters

PublicIPAddress

Parameters supplied to the create or update public IP address operation.

options

PublicIPAddressesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PublicIPAddress>

beginDelete(string, string, PublicIPAddressesDeleteOptionalParams)

Deletes the specified public IP address.

function beginDelete(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the subnet.

options

PublicIPAddressesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, PublicIPAddressesDeleteOptionalParams)

Deletes the specified public IP address.

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

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the subnet.

options

PublicIPAddressesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateTags(string, string, TagsObject, PublicIPAddressesUpdateTagsOptionalParams)

Updates public IP address tags.

function beginUpdateTags(resourceGroupName: string, publicIpAddressName: string, parameters: TagsObject, options?: PublicIPAddressesUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<PublicIPAddress>, PublicIPAddress>>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the public IP address.

parameters

TagsObject

Parameters supplied to update public IP address tags.

options

PublicIPAddressesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<PublicIPAddress>, PublicIPAddress>>

beginUpdateTagsAndWait(string, string, TagsObject, PublicIPAddressesUpdateTagsOptionalParams)

Updates public IP address tags.

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

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the public IP address.

parameters

TagsObject

Parameters supplied to update public IP address tags.

options

PublicIPAddressesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<PublicIPAddress>

get(string, string, PublicIPAddressesGetOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

publicIpAddressName

string

The name of the subnet.

options

PublicIPAddressesGetOptionalParams

The options parameters.

Returns

Promise<PublicIPAddress>

list(string, PublicIPAddressesListOptionalParams)

Gets all public IP addresses in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

PublicIPAddressesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>

listAll(PublicIPAddressesListAllOptionalParams)

Gets all the public IP addresses in a subscription.

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

Parameters

options

PublicIPAddressesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>