PeeringServices interface

Package:

@azure/arm-peering

Interface representing a PeeringServices.

Methods

createOrUpdate(string, string, PeeringService, PeeringServicesCreateOrUpdateOptionalParams)	Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
delete(string, string, PeeringServicesDeleteOptionalParams)	Deletes an existing peering service with the specified name under the given subscription and resource group.
get(string, string, PeeringServicesGetOptionalParams)	Gets an existing peering service with the specified name under the given subscription and resource group.
initializeConnectionMonitor(PeeringServicesInitializeConnectionMonitorOptionalParams)	Initialize Peering Service for Connection Monitor functionality
listByResourceGroup(string, PeeringServicesListByResourceGroupOptionalParams)	Lists all of the peering services under the given subscription and resource group.
listBySubscription(PeeringServicesListBySubscriptionOptionalParams)	Lists all of the peerings under the given subscription.
update(string, string, ResourceTags, PeeringServicesUpdateOptionalParams)	Updates tags for a peering service with the specified name under the given subscription and resource group.

Method Details

createOrUpdate(string, string, PeeringService, PeeringServicesCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, peeringServiceName: string, peeringService: PeeringService, options?: PeeringServicesCreateOrUpdateOptionalParams): Promise<PeeringService>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

peeringService

PeeringService

The properties needed to create or update a peering service.

options

PeeringServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PeeringService>

delete(string, string, PeeringServicesDeleteOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

options

PeeringServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, PeeringServicesGetOptionalParams)

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

function get(resourceGroupName: string, peeringServiceName: string, options?: PeeringServicesGetOptionalParams): Promise<PeeringService>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering.

options

PeeringServicesGetOptionalParams

The options parameters.

Returns

Promise<PeeringService>

initializeConnectionMonitor(PeeringServicesInitializeConnectionMonitorOptionalParams)

Initialize Peering Service for Connection Monitor functionality

function initializeConnectionMonitor(options?: PeeringServicesInitializeConnectionMonitorOptionalParams): Promise<void>

Parameters

options

PeeringServicesInitializeConnectionMonitorOptionalParams

The options parameters.

Returns

Promise<void>

listByResourceGroup(string, PeeringServicesListByResourceGroupOptionalParams)

Lists all of the peering services under the given subscription and resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

PeeringServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PeeringService, PeeringService[], PageSettings>

listBySubscription(PeeringServicesListBySubscriptionOptionalParams)

Lists all of the peerings under the given subscription.

function listBySubscription(options?: PeeringServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PeeringService, PeeringService[], PageSettings>

Parameters

options

PeeringServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PeeringService, PeeringService[], PageSettings>

update(string, string, ResourceTags, PeeringServicesUpdateOptionalParams)

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

function update(resourceGroupName: string, peeringServiceName: string, tags: ResourceTags, options?: PeeringServicesUpdateOptionalParams): Promise<PeeringService>

Parameters

resourceGroupName

string

The name of the resource group.

peeringServiceName

string

The name of the peering service.

tags

ResourceTags

The resource tags.

options

PeeringServicesUpdateOptionalParams

The options parameters.

Returns

Promise<PeeringService>