Microsoft Azure

Azure Monitor: Private Link Scopes API

Azure Monitor API reference for Private Links Scopes management.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Monitor API reference for Private Links Scopes management.

Endpoints 17

asyncOperations

  • GETPrivateLinkScopeOperationStatus_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/:asyncOperationIdGet the status of an azure asynchronous operation associated with a private link scope operation.

PrivateLinkResources

  • GETPrivateLinkResources_ListByPrivateLinkScope/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateLinkResourcesGets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
  • GETPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateLinkResources/:groupNameGets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateEndpointConnections/:privateEndpointConnectionNameGets a private endpoint connection.
  • PUTPrivateEndpointConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateEndpointConnections/:privateEndpointConnectionNameApprove or reject a private endpoint connection with a given name.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection with a given name.
  • GETPrivateEndpointConnections_ListByPrivateLinkScope/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/privateEndpointConnectionsGets all private endpoint connections on a private link scope.

PrivateLinkScopedResources

  • GETPrivateLinkScopedResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/scopedResources/:nameGets a scoped resource in a private link scope.
  • PUTPrivateLinkScopedResources_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/scopedResources/:nameAdd an Azure monitor scoped resource in the private link scope.
  • DELETEPrivateLinkScopedResources_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/scopedResources/:nameDeletes an Azure monitor scoped resource with a given name.
  • GETPrivateLinkScopedResources_ListByPrivateLinkScope/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeName/scopedResourcesGets all scoped resources on a private link scope.
  • GETPrivateLinkScopes_List/subscriptions/:subscriptionId/providers/Microsoft.Insights/privateLinkScopesGets a list of all Azure Monitor PrivateLinkScopes within a subscription.
  • GETPrivateLinkScopes_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopesGets a list of Azure Monitor PrivateLinkScopes within a resource group.
  • GETPrivateLinkScopes_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeNameReturns a Azure Monitor PrivateLinkScope.
  • PUTPrivateLinkScopes_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeNameCreates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
  • DELETEPrivateLinkScopes_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeNameDeletes a Azure Monitor PrivateLinkScope.
  • PATCHPrivateLinkScopes_UpdateTags/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopes/:scopeNameUpdates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
17 operations on 10 pathsGET 10PUT 3DELETE 3PATCH 1
Main resources
PrivateEndpointConnections 4PrivateLinkScopedResources 4PrivateLinkResources 2asyncOperations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2021-09-01

How to test the Azure Monitor: Private Link Scopes API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Monitor: Private Link Scopes API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “PrivateLinkScopeOperationStatus_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/:asyncOperationId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Monitor: Private Link Scopes API?

Azure Monitor API reference for Private Links Scopes management. It is listed under Developer tools and has 17 endpoints.

Who publishes the Azure Monitor: Private Link Scopes API?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Monitor: Private Link Scopes API?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Monitor: Private Link Scopes API?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Monitor: Private Link Scopes API have?

17 operations on 10 paths (10 GET, 3 PUT, 3 DELETE, 1 PATCH). The largest groups are PrivateEndpointConnections, PrivateLinkScopedResources, PrivateLinkResources, asyncOperations.

Is forking the Azure Monitor: Private Link Scopes API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.