Share via

Prefixes interface

  • Reference
Package:
@azure/arm-peering

Interface representing a Prefixes.

Methods

createOrUpdate(string, string, string, PeeringServicePrefix, PrefixesCreateOrUpdateOptionalParams)

Creates a new prefix with the specified name under the given subscription, resource group and peering service.
delete(string, string, string, PrefixesDeleteOptionalParams)

Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
get(string, string, string, PrefixesGetOptionalParams)

Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
listByPeeringService(string, string, PrefixesListByPeeringServiceOptionalParams)

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

Method Details

createOrUpdate(string, string, string, PeeringServicePrefix, PrefixesCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, peeringServiceName: string, prefixName: string, peeringServicePrefix: PeeringServicePrefix, options?: PrefixesCreateOrUpdateOptionalParams): Promise<PeeringServicePrefix>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

prefixName

string

The name of the prefix.

peeringServicePrefix
PeeringServicePrefix

The properties needed to create a prefix.

options
PrefixesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PeeringServicePrefix>

delete(string, string, string, PrefixesDeleteOptionalParams)

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

function delete(resourceGroupName: string, peeringServiceName: string, prefixName: string, options?: PrefixesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

prefixName

string

The name of the prefix.

options
PrefixesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrefixesGetOptionalParams)

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

function get(resourceGroupName: string, peeringServiceName: string, prefixName: string, options?: PrefixesGetOptionalParams): Promise<PeeringServicePrefix>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

prefixName

string

The name of the prefix.

options
PrefixesGetOptionalParams

The options parameters.

Returns

Promise<PeeringServicePrefix>

listByPeeringService(string, string, PrefixesListByPeeringServiceOptionalParams)

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

function listByPeeringService(resourceGroupName: string, peeringServiceName: string, options?: PrefixesListByPeeringServiceOptionalParams): PagedAsyncIterableIterator<PeeringServicePrefix, PeeringServicePrefix[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

options
PrefixesListByPeeringServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PeeringServicePrefix, PeeringServicePrefix[], PageSettings>