IpAllocations interface

Package:

@azure/arm-network

Interface representing a IpAllocations.

Methods

beginCreateOrUpdate(string, string, IpAllocation, IpAllocationsCreateOrUpdateOptionalParams)	Creates or updates an IpAllocation in the specified resource group.
beginCreateOrUpdateAndWait(string, string, IpAllocation, IpAllocationsCreateOrUpdateOptionalParams)	Creates or updates an IpAllocation in the specified resource group.
beginDelete(string, string, IpAllocationsDeleteOptionalParams)	Deletes the specified IpAllocation.
beginDeleteAndWait(string, string, IpAllocationsDeleteOptionalParams)	Deletes the specified IpAllocation.
get(string, string, IpAllocationsGetOptionalParams)	Gets the specified IpAllocation by resource group.
list(IpAllocationsListOptionalParams)	Gets all IpAllocations in a subscription.
listByResourceGroup(string, IpAllocationsListByResourceGroupOptionalParams)	Gets all IpAllocations in a resource group.
updateTags(string, string, TagsObject, IpAllocationsUpdateTagsOptionalParams)	Updates a IpAllocation tags.

Method Details

beginCreateOrUpdate(string, string, IpAllocation, IpAllocationsCreateOrUpdateOptionalParams)

Creates or updates an IpAllocation in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, ipAllocationName: string, parameters: IpAllocation, options?: IpAllocationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IpAllocation>, IpAllocation>>

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

parameters

IpAllocation

Parameters supplied to the create or update virtual network operation.

options

IpAllocationsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, IpAllocation, IpAllocationsCreateOrUpdateOptionalParams)

Creates or updates an IpAllocation in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, ipAllocationName: string, parameters: IpAllocation, options?: IpAllocationsCreateOrUpdateOptionalParams): Promise<IpAllocation>

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

parameters

IpAllocation

Parameters supplied to the create or update virtual network operation.

options

IpAllocationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<IpAllocation>

beginDelete(string, string, IpAllocationsDeleteOptionalParams)

Deletes the specified IpAllocation.

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

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

options

IpAllocationsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, IpAllocationsDeleteOptionalParams)

Deletes the specified IpAllocation.

function beginDeleteAndWait(resourceGroupName: string, ipAllocationName: string, options?: IpAllocationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

options

IpAllocationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, IpAllocationsGetOptionalParams)

Gets the specified IpAllocation by resource group.

function get(resourceGroupName: string, ipAllocationName: string, options?: IpAllocationsGetOptionalParams): Promise<IpAllocation>

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

options

IpAllocationsGetOptionalParams

The options parameters.

Returns

Promise<IpAllocation>

list(IpAllocationsListOptionalParams)

Gets all IpAllocations in a subscription.

function list(options?: IpAllocationsListOptionalParams): PagedAsyncIterableIterator<IpAllocation, IpAllocation[], PageSettings>

Parameters

options

IpAllocationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpAllocation, IpAllocation[], PageSettings>

listByResourceGroup(string, IpAllocationsListByResourceGroupOptionalParams)

Gets all IpAllocations in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: IpAllocationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IpAllocation, IpAllocation[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

IpAllocationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpAllocation, IpAllocation[], PageSettings>

updateTags(string, string, TagsObject, IpAllocationsUpdateTagsOptionalParams)

Updates a IpAllocation tags.

function updateTags(resourceGroupName: string, ipAllocationName: string, parameters: TagsObject, options?: IpAllocationsUpdateTagsOptionalParams): Promise<IpAllocation>

Parameters

resourceGroupName

string

The name of the resource group.

ipAllocationName

string

The name of the IpAllocation.

parameters

TagsObject

Parameters supplied to update IpAllocation tags.

options

IpAllocationsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<IpAllocation>