PrivateLinkScopes interface

Package:

@azure/arm-monitor

Interface representing a PrivateLinkScopes.

Methods

beginDelete(string, string, PrivateLinkScopesDeleteOptionalParams)	Deletes a Azure Monitor PrivateLinkScope.
beginDeleteAndWait(string, string, PrivateLinkScopesDeleteOptionalParams)	Deletes a Azure Monitor PrivateLinkScope.
createOrUpdate(string, string, AzureMonitorPrivateLinkScope, PrivateLinkScopesCreateOrUpdateOptionalParams)	Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
get(string, string, PrivateLinkScopesGetOptionalParams)	Returns a Azure Monitor PrivateLinkScope.
list(PrivateLinkScopesListOptionalParams)	Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.
listByResourceGroup(string, PrivateLinkScopesListByResourceGroupOptionalParams)	Gets a list of Azure Monitor PrivateLinkScopes within a resource group.
updateTags(string, string, TagsResource, PrivateLinkScopesUpdateTagsOptionalParams)	Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

Method Details

beginDelete(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Monitor PrivateLinkScope.

function beginDelete(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Monitor PrivateLinkScope resource.

options

PrivateLinkScopesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Monitor PrivateLinkScope.

function beginDeleteAndWait(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Monitor PrivateLinkScope resource.

options

PrivateLinkScopesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, AzureMonitorPrivateLinkScope, PrivateLinkScopesCreateOrUpdateOptionalParams)

Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

function createOrUpdate(resourceGroupName: string, scopeName: string, azureMonitorPrivateLinkScopePayload: AzureMonitorPrivateLinkScope, options?: PrivateLinkScopesCreateOrUpdateOptionalParams): Promise<AzureMonitorPrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Monitor PrivateLinkScope resource.

azureMonitorPrivateLinkScopePayload

AzureMonitorPrivateLinkScope

Properties that need to be specified to create or update a Azure Monitor PrivateLinkScope.

options

PrivateLinkScopesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AzureMonitorPrivateLinkScope>

get(string, string, PrivateLinkScopesGetOptionalParams)

Returns a Azure Monitor PrivateLinkScope.

function get(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesGetOptionalParams): Promise<AzureMonitorPrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Monitor PrivateLinkScope resource.

options

PrivateLinkScopesGetOptionalParams

The options parameters.

Returns

Promise<AzureMonitorPrivateLinkScope>

list(PrivateLinkScopesListOptionalParams)

Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.

function list(options?: PrivateLinkScopesListOptionalParams): PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope, AzureMonitorPrivateLinkScope[], PageSettings>

Parameters

options

PrivateLinkScopesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope, AzureMonitorPrivateLinkScope[], PageSettings>

listByResourceGroup(string, PrivateLinkScopesListByResourceGroupOptionalParams)

Gets a list of Azure Monitor PrivateLinkScopes within a resource group.

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

Parameters

resourceGroupName

string

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

options

PrivateLinkScopesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope, AzureMonitorPrivateLinkScope[], PageSettings>

updateTags(string, string, TagsResource, PrivateLinkScopesUpdateTagsOptionalParams)

Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

function updateTags(resourceGroupName: string, scopeName: string, privateLinkScopeTags: TagsResource, options?: PrivateLinkScopesUpdateTagsOptionalParams): Promise<AzureMonitorPrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Monitor PrivateLinkScope resource.

privateLinkScopeTags

TagsResource

Updated tag information to set into the PrivateLinkScope instance.

options

PrivateLinkScopesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<AzureMonitorPrivateLinkScope>