IpPrefixes interface

Package:

@azure/arm-managednetworkfabric

Interface representing a IpPrefixes.

Methods

beginCreate(string, string, IpPrefix, IpPrefixesCreateOptionalParams)	Implements IP Prefix PUT method.
beginCreateAndWait(string, string, IpPrefix, IpPrefixesCreateOptionalParams)	Implements IP Prefix PUT method.
beginDelete(string, string, IpPrefixesDeleteOptionalParams)	Implements IP Prefix DELETE method.
beginDeleteAndWait(string, string, IpPrefixesDeleteOptionalParams)	Implements IP Prefix DELETE method.
beginUpdate(string, string, IpPrefixPatch, IpPrefixesUpdateOptionalParams)	API to update certain properties of the IP Prefix resource.
beginUpdateAndWait(string, string, IpPrefixPatch, IpPrefixesUpdateOptionalParams)	API to update certain properties of the IP Prefix resource.
get(string, string, IpPrefixesGetOptionalParams)	Implements IP Prefix GET method.
listByResourceGroup(string, IpPrefixesListByResourceGroupOptionalParams)	Implements IpPrefixes list by resource group GET method.
listBySubscription(IpPrefixesListBySubscriptionOptionalParams)	Implements IpPrefixes list by subscription GET method.

Method Details

beginCreate(string, string, IpPrefix, IpPrefixesCreateOptionalParams)

Implements IP Prefix PUT method.

function beginCreate(resourceGroupName: string, ipPrefixName: string, body: IpPrefix, options?: IpPrefixesCreateOptionalParams): Promise<SimplePollerLike<OperationState<IpPrefix>, IpPrefix>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

body

IpPrefix

Request payload.

options

IpPrefixesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, IpPrefix, IpPrefixesCreateOptionalParams)

Implements IP Prefix PUT method.

function beginCreateAndWait(resourceGroupName: string, ipPrefixName: string, body: IpPrefix, options?: IpPrefixesCreateOptionalParams): Promise<IpPrefix>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

body

IpPrefix

Request payload.

options

IpPrefixesCreateOptionalParams

The options parameters.

Returns

Promise<IpPrefix>

beginDelete(string, string, IpPrefixesDeleteOptionalParams)

Implements IP Prefix DELETE method.

function beginDelete(resourceGroupName: string, ipPrefixName: string, options?: IpPrefixesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IpPrefixesDeleteHeaders>, IpPrefixesDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

options

IpPrefixesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, IpPrefixesDeleteOptionalParams)

Implements IP Prefix DELETE method.

function beginDeleteAndWait(resourceGroupName: string, ipPrefixName: string, options?: IpPrefixesDeleteOptionalParams): Promise<IpPrefixesDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

options

IpPrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<IpPrefixesDeleteHeaders>

beginUpdate(string, string, IpPrefixPatch, IpPrefixesUpdateOptionalParams)

API to update certain properties of the IP Prefix resource.

function beginUpdate(resourceGroupName: string, ipPrefixName: string, body: IpPrefixPatch, options?: IpPrefixesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IpPrefix>, IpPrefix>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

body

IpPrefixPatch

IP Prefix properties to update.

options

IpPrefixesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, IpPrefixPatch, IpPrefixesUpdateOptionalParams)

API to update certain properties of the IP Prefix resource.

function beginUpdateAndWait(resourceGroupName: string, ipPrefixName: string, body: IpPrefixPatch, options?: IpPrefixesUpdateOptionalParams): Promise<IpPrefix>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

body

IpPrefixPatch

IP Prefix properties to update.

options

IpPrefixesUpdateOptionalParams

The options parameters.

Returns

Promise<IpPrefix>

get(string, string, IpPrefixesGetOptionalParams)

Implements IP Prefix GET method.

function get(resourceGroupName: string, ipPrefixName: string, options?: IpPrefixesGetOptionalParams): Promise<IpPrefix>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

ipPrefixName

string

Name of the IP Prefix.

options

IpPrefixesGetOptionalParams

The options parameters.

Returns

Promise<IpPrefix>

listByResourceGroup(string, IpPrefixesListByResourceGroupOptionalParams)

Implements IpPrefixes list by resource group GET method.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

IpPrefixesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpPrefix, IpPrefix[], PageSettings>

listBySubscription(IpPrefixesListBySubscriptionOptionalParams)

Implements IpPrefixes list by subscription GET method.

function listBySubscription(options?: IpPrefixesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IpPrefix, IpPrefix[], PageSettings>

Parameters

options

IpPrefixesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpPrefix, IpPrefix[], PageSettings>