CustomIPPrefixes interface

Package:

@azure/arm-network

Interface representing a CustomIPPrefixes.

Methods

beginCreateOrUpdate(string, string, CustomIpPrefix, CustomIPPrefixesCreateOrUpdateOptionalParams)	Creates or updates a custom IP prefix.
beginCreateOrUpdateAndWait(string, string, CustomIpPrefix, CustomIPPrefixesCreateOrUpdateOptionalParams)	Creates or updates a custom IP prefix.
beginDelete(string, string, CustomIPPrefixesDeleteOptionalParams)	Deletes the specified custom IP prefix.
beginDeleteAndWait(string, string, CustomIPPrefixesDeleteOptionalParams)	Deletes the specified custom IP prefix.
get(string, string, CustomIPPrefixesGetOptionalParams)	Gets the specified custom IP prefix in a specified resource group.
list(string, CustomIPPrefixesListOptionalParams)	Gets all custom IP prefixes in a resource group.
listAll(CustomIPPrefixesListAllOptionalParams)	Gets all the custom IP prefixes in a subscription.
updateTags(string, string, TagsObject, CustomIPPrefixesUpdateTagsOptionalParams)	Updates custom IP prefix tags.

Method Details

beginCreateOrUpdate(string, string, CustomIpPrefix, CustomIPPrefixesCreateOrUpdateOptionalParams)

Creates or updates a custom IP prefix.

function beginCreateOrUpdate(resourceGroupName: string, customIpPrefixName: string, parameters: CustomIpPrefix, options?: CustomIPPrefixesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CustomIpPrefix>, CustomIpPrefix>>

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the custom IP prefix.

parameters

CustomIpPrefix

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

options

CustomIPPrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, CustomIpPrefix, CustomIPPrefixesCreateOrUpdateOptionalParams)

Creates or updates a custom IP prefix.

function beginCreateOrUpdateAndWait(resourceGroupName: string, customIpPrefixName: string, parameters: CustomIpPrefix, options?: CustomIPPrefixesCreateOrUpdateOptionalParams): Promise<CustomIpPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the custom IP prefix.

parameters

CustomIpPrefix

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

options

CustomIPPrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CustomIpPrefix>

beginDelete(string, string, CustomIPPrefixesDeleteOptionalParams)

Deletes the specified custom IP prefix.

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

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the CustomIpPrefix.

options

CustomIPPrefixesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, CustomIPPrefixesDeleteOptionalParams)

Deletes the specified custom IP prefix.

function beginDeleteAndWait(resourceGroupName: string, customIpPrefixName: string, options?: CustomIPPrefixesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the CustomIpPrefix.

options

CustomIPPrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, CustomIPPrefixesGetOptionalParams)

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

function get(resourceGroupName: string, customIpPrefixName: string, options?: CustomIPPrefixesGetOptionalParams): Promise<CustomIpPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the custom IP prefix.

options

CustomIPPrefixesGetOptionalParams

The options parameters.

Returns

Promise<CustomIpPrefix>

list(string, CustomIPPrefixesListOptionalParams)

Gets all custom IP prefixes in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

CustomIPPrefixesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomIpPrefix, CustomIpPrefix[], PageSettings>

listAll(CustomIPPrefixesListAllOptionalParams)

Gets all the custom IP prefixes in a subscription.

function listAll(options?: CustomIPPrefixesListAllOptionalParams): PagedAsyncIterableIterator<CustomIpPrefix, CustomIpPrefix[], PageSettings>

Parameters

options

CustomIPPrefixesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomIpPrefix, CustomIpPrefix[], PageSettings>

updateTags(string, string, TagsObject, CustomIPPrefixesUpdateTagsOptionalParams)

Updates custom IP prefix tags.

function updateTags(resourceGroupName: string, customIpPrefixName: string, parameters: TagsObject, options?: CustomIPPrefixesUpdateTagsOptionalParams): Promise<CustomIpPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

customIpPrefixName

string

The name of the custom IP prefix.

parameters

TagsObject

Parameters supplied to update custom IP prefix tags.

options

CustomIPPrefixesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<CustomIpPrefix>