Peerings interface

Package:

@azure/arm-peering

Interface representing a Peerings.

Methods

createOrUpdate(string, string, Peering, PeeringsCreateOrUpdateOptionalParams)	Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
delete(string, string, PeeringsDeleteOptionalParams)	Deletes an existing peering with the specified name under the given subscription and resource group.
get(string, string, PeeringsGetOptionalParams)	Gets an existing peering with the specified name under the given subscription and resource group.
listByResourceGroup(string, PeeringsListByResourceGroupOptionalParams)	Lists all of the peerings under the given subscription and resource group.
listBySubscription(PeeringsListBySubscriptionOptionalParams)	Lists all of the peerings under the given subscription.
update(string, string, ResourceTags, PeeringsUpdateOptionalParams)	Updates tags for a peering with the specified name under the given subscription and resource group.

Method Details

createOrUpdate(string, string, Peering, PeeringsCreateOrUpdateOptionalParams)

Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.

function createOrUpdate(resourceGroupName: string, peeringName: string, peering: Peering, options?: PeeringsCreateOrUpdateOptionalParams): Promise<Peering>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

peering

Peering

The properties needed to create or update a peering.

options

PeeringsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Peering>

delete(string, string, PeeringsDeleteOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

options

PeeringsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, PeeringsGetOptionalParams)

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

function get(resourceGroupName: string, peeringName: string, options?: PeeringsGetOptionalParams): Promise<Peering>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

options

PeeringsGetOptionalParams

The options parameters.

Returns

Promise<Peering>

listByResourceGroup(string, PeeringsListByResourceGroupOptionalParams)

Lists all of the peerings under the given subscription and resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

PeeringsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Peering, Peering[], PageSettings>

listBySubscription(PeeringsListBySubscriptionOptionalParams)

Lists all of the peerings under the given subscription.

function listBySubscription(options?: PeeringsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Peering, Peering[], PageSettings>

Parameters

options

PeeringsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Peering, Peering[], PageSettings>

update(string, string, ResourceTags, PeeringsUpdateOptionalParams)

Updates tags for a peering with the specified name under the given subscription and resource group.

function update(resourceGroupName: string, peeringName: string, tags: ResourceTags, options?: PeeringsUpdateOptionalParams): Promise<Peering>

Parameters

resourceGroupName

string

The name of the resource group.

peeringName

string

The name of the peering.

tags

ResourceTags

The resource tags.

options

PeeringsUpdateOptionalParams

The options parameters.

Returns

Promise<Peering>