PublicIPPrefixes interface

Package:

@azure/arm-network

Interface representing a PublicIPPrefixes.

Methods

beginCreateOrUpdate(string, string, PublicIPPrefix, PublicIPPrefixesCreateOrUpdateOptionalParams)	Creates or updates a static or dynamic public IP prefix.
beginCreateOrUpdateAndWait(string, string, PublicIPPrefix, PublicIPPrefixesCreateOrUpdateOptionalParams)	Creates or updates a static or dynamic public IP prefix.
beginDelete(string, string, PublicIPPrefixesDeleteOptionalParams)	Deletes the specified public IP prefix.
beginDeleteAndWait(string, string, PublicIPPrefixesDeleteOptionalParams)	Deletes the specified public IP prefix.
get(string, string, PublicIPPrefixesGetOptionalParams)	Gets the specified public IP prefix in a specified resource group.
list(string, PublicIPPrefixesListOptionalParams)	Gets all public IP prefixes in a resource group.
listAll(PublicIPPrefixesListAllOptionalParams)	Gets all the public IP prefixes in a subscription.
updateTags(string, string, TagsObject, PublicIPPrefixesUpdateTagsOptionalParams)	Updates public IP prefix tags.

Method Details

beginCreateOrUpdate(string, string, PublicIPPrefix, PublicIPPrefixesCreateOrUpdateOptionalParams)

Creates or updates a static or dynamic public IP prefix.

function beginCreateOrUpdate(resourceGroupName: string, publicIpPrefixName: string, parameters: PublicIPPrefix, options?: PublicIPPrefixesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PublicIPPrefix>, PublicIPPrefix>>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the public IP prefix.

parameters

PublicIPPrefix

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

options

PublicIPPrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PublicIPPrefix>, PublicIPPrefix>>

beginCreateOrUpdateAndWait(string, string, PublicIPPrefix, PublicIPPrefixesCreateOrUpdateOptionalParams)

Creates or updates a static or dynamic public IP prefix.

function beginCreateOrUpdateAndWait(resourceGroupName: string, publicIpPrefixName: string, parameters: PublicIPPrefix, options?: PublicIPPrefixesCreateOrUpdateOptionalParams): Promise<PublicIPPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the public IP prefix.

parameters

PublicIPPrefix

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

options

PublicIPPrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PublicIPPrefix>

beginDelete(string, string, PublicIPPrefixesDeleteOptionalParams)

Deletes the specified public IP prefix.

function beginDelete(resourceGroupName: string, publicIpPrefixName: string, options?: PublicIPPrefixesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the PublicIpPrefix.

options

PublicIPPrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, PublicIPPrefixesDeleteOptionalParams)

Deletes the specified public IP prefix.

function beginDeleteAndWait(resourceGroupName: string, publicIpPrefixName: string, options?: PublicIPPrefixesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the PublicIpPrefix.

options

PublicIPPrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, PublicIPPrefixesGetOptionalParams)

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

function get(resourceGroupName: string, publicIpPrefixName: string, options?: PublicIPPrefixesGetOptionalParams): Promise<PublicIPPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the public IP prefix.

options

PublicIPPrefixesGetOptionalParams

The options parameters.

Returns

Promise<PublicIPPrefix>

list(string, PublicIPPrefixesListOptionalParams)

Gets all public IP prefixes in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

PublicIPPrefixesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicIPPrefix, PublicIPPrefix[], PageSettings>

listAll(PublicIPPrefixesListAllOptionalParams)

Gets all the public IP prefixes in a subscription.

function listAll(options?: PublicIPPrefixesListAllOptionalParams): PagedAsyncIterableIterator<PublicIPPrefix, PublicIPPrefix[], PageSettings>

Parameters

options

PublicIPPrefixesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicIPPrefix, PublicIPPrefix[], PageSettings>

updateTags(string, string, TagsObject, PublicIPPrefixesUpdateTagsOptionalParams)

Updates public IP prefix tags.

function updateTags(resourceGroupName: string, publicIpPrefixName: string, parameters: TagsObject, options?: PublicIPPrefixesUpdateTagsOptionalParams): Promise<PublicIPPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

publicIpPrefixName

string

The name of the public IP prefix.

parameters

TagsObject

Parameters supplied to update public IP prefix tags.

options

PublicIPPrefixesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<PublicIPPrefix>