Private Link Scopes - Create Or Update

Service:

Monitor

API Version:

2019-10-17-preview

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}?api-version=2019-10-17-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
scopeName	path	True	string	The name of the Azure Monitor PrivateLinkScope resource.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	Resource location
tags		object	Resource tags

Responses

Name	Type	Description
200 OK	AzureMonitorPrivateLinkScope	Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope is returned.
201 Created	AzureMonitorPrivateLinkScope	Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope was created and is returned.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PrivateLinkScopeCreate

PrivateLinkScopeUpdate

PrivateLinkScopeCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope?api-version=2019-10-17-preview

{
  "location": "Global",
  "properties": {}
}

Go

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateLinkScopesCreate.json
func ExamplePrivateLinkScopesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewPrivateLinkScopesClient("86dc51d3-92ed-4d7e-947a-775ea79b4919", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"my-resource-group",
		"my-privatelinkscope",
		armmonitor.AzureMonitorPrivateLinkScope{
			Location:   to.Ptr("Global"),
			Properties: &armmonitor.AzureMonitorPrivateLinkScopeProperties{},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
 *
 * @summary Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateLinkScopesCreate.json
 */
async function privateLinkScopeCreate() {
  const subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4919";
  const resourceGroupName = "my-resource-group";
  const scopeName = "my-privatelinkscope";
  const azureMonitorPrivateLinkScopePayload = {
    location: "Global",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.privateLinkScopes.createOrUpdate(
    resourceGroupName,
    scopeName,
    azureMonitorPrivateLinkScopePayload
  );
  console.log(result);
}

privateLinkScopeCreate().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.Insights/privateLinkScopes",
  "location": "Global",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.Insights/privateLinkScopes",
  "location": "Global",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded"
  }
}

PrivateLinkScopeUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope?api-version=2019-10-17-preview

{
  "location": "Global",
  "tags": {
    "Tag1": "Value1"
  },
  "properties": {}
}

Go

No code sample is available. To request a code sample, open a GitHub issue

JavaScript

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
 *
 * @summary Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateLinkScopesUpdate.json
 */
async function privateLinkScopeUpdate() {
  const subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4919";
  const resourceGroupName = "my-resource-group";
  const scopeName = "my-privatelinkscope";
  const azureMonitorPrivateLinkScopePayload = {
    location: "Global",
    tags: { tag1: "Value1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.privateLinkScopes.createOrUpdate(
    resourceGroupName,
    scopeName,
    azureMonitorPrivateLinkScopePayload
  );
  console.log(result);
}

privateLinkScopeUpdate().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.Insights/privateLinkScopes",
  "location": "Global",
  "tags": {
    "Tag1": "Value1"
  },
  "properties": {
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.Insights/privateLinkScopes",
  "location": "Global",
  "tags": {
    "Tag1": "Value1"
  },
  "properties": {
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
AzureMonitorPrivateLinkScope	An Azure Monitor PrivateLinkScope definition.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	State of the private endpoint connection.

AzureMonitorPrivateLinkScope

An Azure Monitor PrivateLinkScope definition.

Name	Type	Description
id	string	Azure resource Id
location	string	Resource location
name	string	Azure resource name
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections.
properties.provisioningState	string	Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.
tags	object	Resource tags
type	string	Azure resource type

PrivateEndpointConnection

A private endpoint connection

Name	Type	Description
id	string	Azure resource Id
name	string	Azure resource name
properties.privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
properties.provisioningState	string	State of the private endpoint connection.
type	string	Azure resource type

PrivateEndpointProperty

Private endpoint which the connection belongs to.

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

State of the private endpoint connection.

Name	Type	Description
actionsRequired	string	The actions required for private link service connection.
description	string	The private link service connection description.
status	string	The private link service connection status.