PrivateLinkScopes | @azure/arm-monitor

Interface representing a PrivateLinkScopes.

Hierarchy

PrivateLinkScopes

Implemented by

PrivateLinkScopesImpl

Index

Methods

beginDelete

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

- Defined in operationsInterfaces/privateLinkScopes.ts:50
Deletes a Azure Monitor PrivateLinkScope.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- scopeName: string
  
  The name of the Azure Monitor PrivateLinkScope resource.
- Optional options: PrivateLinkScopesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/privateLinkScopes.ts:61
Deletes a Azure Monitor PrivateLinkScope.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- scopeName: string
  
  The name of the Azure Monitor PrivateLinkScope resource.
- Optional options: PrivateLinkScopesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

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

- Defined in operationsInterfaces/privateLinkScopes.ts:86
Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

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.
- Optional options: PrivateLinkScopesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PrivateLinkScopesCreateOrUpdateResponse>

get

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

- Defined in operationsInterfaces/privateLinkScopes.ts:72
Returns a Azure Monitor PrivateLinkScope.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- scopeName: string
  
  The name of the Azure Monitor PrivateLinkScope resource.
- Optional options: PrivateLinkScopesGetOptionalParams
  
  The options parameters.
Returns Promise<PrivateLinkScopesGetResponse>

list

list(options?: PrivateLinkScopesListOptionalParams): PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

- Defined in operationsInterfaces/privateLinkScopes.ts:32
Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.

Parameters
- Optional options: PrivateLinkScopesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: PrivateLinkScopesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

- Defined in operationsInterfaces/privateLinkScopes.ts:40
Gets a list of Azure Monitor PrivateLinkScopes within a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: PrivateLinkScopesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

updateTags

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

- Defined in operationsInterfaces/privateLinkScopes.ts:99
Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

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.
- Optional options: PrivateLinkScopesUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<PrivateLinkScopesUpdateTagsResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginDelete

Parameters

resourceGroupName: string

scopeName: string

Optional options: PrivateLinkScopesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

scopeName: string

Optional options: PrivateLinkScopesDeleteOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

scopeName: string

azureMonitorPrivateLinkScopePayload: AzureMonitorPrivateLinkScope

Optional options: PrivateLinkScopesCreateOrUpdateOptionalParams

Returns Promise<PrivateLinkScopesCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

scopeName: string

Optional options: PrivateLinkScopesGetOptionalParams

Returns Promise<PrivateLinkScopesGetResponse>

list

Parameters

Optional options: PrivateLinkScopesListOptionalParams

Returns PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: PrivateLinkScopesListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<AzureMonitorPrivateLinkScope>

updateTags

Parameters

resourceGroupName: string

scopeName: string

privateLinkScopeTags: TagsResource

Optional options: PrivateLinkScopesUpdateTagsOptionalParams

Returns Promise<PrivateLinkScopesUpdateTagsResponse>