RegisteredPrefixes interface

Package:

@azure/arm-peering

Interface representing a RegisteredPrefixes.

Methods

createOrUpdate(string, string, string, PeeringRegisteredPrefix, RegisteredPrefixesCreateOrUpdateOptionalParams)	Creates a new registered prefix with the specified name under the given subscription, resource group and peering.
delete(string, string, string, RegisteredPrefixesDeleteOptionalParams)	Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
get(string, string, string, RegisteredPrefixesGetOptionalParams)	Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
listByPeering(string, string, RegisteredPrefixesListByPeeringOptionalParams)	Lists all registered prefixes under the given subscription, resource group and peering.

Method Details

createOrUpdate(string, string, string, PeeringRegisteredPrefix, RegisteredPrefixesCreateOrUpdateOptionalParams)

Creates a new registered prefix with the specified name under the given subscription, resource group and peering.

function createOrUpdate(resourceGroupName: string, peeringName: string, registeredPrefixName: string, registeredPrefix: PeeringRegisteredPrefix, options?: RegisteredPrefixesCreateOrUpdateOptionalParams): Promise<PeeringRegisteredPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

registeredPrefixName

string

The name of the registered prefix.

registeredPrefix

PeeringRegisteredPrefix

The properties needed to create a registered prefix.

options

RegisteredPrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PeeringRegisteredPrefix>

delete(string, string, string, RegisteredPrefixesDeleteOptionalParams)

Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.

function delete(resourceGroupName: string, peeringName: string, registeredPrefixName: string, options?: RegisteredPrefixesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

registeredPrefixName

string

The name of the registered prefix.

options

RegisteredPrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RegisteredPrefixesGetOptionalParams)

Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.

function get(resourceGroupName: string, peeringName: string, registeredPrefixName: string, options?: RegisteredPrefixesGetOptionalParams): Promise<PeeringRegisteredPrefix>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

registeredPrefixName

string

The name of the registered prefix.

options

RegisteredPrefixesGetOptionalParams

The options parameters.

Returns

Promise<PeeringRegisteredPrefix>

listByPeering(string, string, RegisteredPrefixesListByPeeringOptionalParams)

Lists all registered prefixes under the given subscription, resource group and peering.

function listByPeering(resourceGroupName: string, peeringName: string, options?: RegisteredPrefixesListByPeeringOptionalParams): PagedAsyncIterableIterator<PeeringRegisteredPrefix, PeeringRegisteredPrefix[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

options

RegisteredPrefixesListByPeeringOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PeeringRegisteredPrefix, PeeringRegisteredPrefix[], PageSettings>