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=2021-07-01-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
|
The geo-location where the resource lives
|
properties.accessModeSettings
|
True
|
AccessModeSettings
|
Access mode settings
|
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.
|
Other Status Codes
|
DefaultErrorResponse
|
An error occurred.
|
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
Sample request
PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope?api-version=2021-07-01-preview
{
"location": "Global",
"properties": {
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
import com.azure.resourcemanager.monitor.fluent.models.AzureMonitorPrivateLinkScopeInner;
import com.azure.resourcemanager.monitor.models.AccessMode;
import com.azure.resourcemanager.monitor.models.AccessModeSettings;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/**
* Samples for PrivateLinkScopes CreateOrUpdate.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/
* PrivateLinkScopesCreate.json
*/
/**
* Sample code: PrivateLinkScopeCreate.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void privateLinkScopeCreate(com.azure.resourcemanager.AzureResourceManager azure) {
azure.diagnosticSettings().manager().serviceClient().getPrivateLinkScopes().createOrUpdateWithResponse(
"my-resource-group", "my-privatelinkscope",
new AzureMonitorPrivateLinkScopeInner().withLocation("Global")
.withAccessModeSettings(new AccessModeSettings().withQueryAccessMode(AccessMode.OPEN)
.withIngestionAccessMode(AccessMode.OPEN).withExclusions(Arrays.asList())),
com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/PrivateLinkScopesCreate.json
func ExamplePrivateLinkScopesClient_CreateOrUpdate_privateLinkScopeCreate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkScopesClient().CreateOrUpdate(ctx, "my-resource-group", "my-privatelinkscope", armmonitor.AzureMonitorPrivateLinkScope{
Location: to.Ptr("Global"),
Properties: &armmonitor.AzureMonitorPrivateLinkScopeProperties{
AccessModeSettings: &armmonitor.AccessModeSettings{
Exclusions: []*armmonitor.AccessModeSettingsExclusion{},
IngestionAccessMode: to.Ptr(armmonitor.AccessModeOpen),
QueryAccessMode: to.Ptr(armmonitor.AccessModeOpen),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureMonitorPrivateLinkScope = armmonitor.AzureMonitorPrivateLinkScope{
// Name: to.Ptr("my-privatelinkscope"),
// Type: to.Ptr("Microsoft.Insights/privateLinkScopes"),
// ID: to.Ptr("/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope"),
// Location: to.Ptr("Global"),
// Tags: map[string]*string{
// },
// Properties: &armmonitor.AzureMonitorPrivateLinkScopeProperties{
// AccessModeSettings: &armmonitor.AccessModeSettings{
// Exclusions: []*armmonitor.AccessModeSettingsExclusion{
// },
// IngestionAccessMode: to.Ptr(armmonitor.AccessModeOpen),
// QueryAccessMode: to.Ptr(armmonitor.AccessModeOpen),
// },
// ProvisioningState: to.Ptr("Succeeded"),
// },
// SystemData: &armmonitor.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T12:59:57.051Z"); return t}()),
// CreatedBy: to.Ptr("bobby@contoso.com"),
// CreatedByType: to.Ptr(armmonitor.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T12:59:57.051Z"); return t}()),
// LastModifiedBy: to.Ptr("bobby@contoso.com"),
// LastModifiedByType: to.Ptr(armmonitor.CreatedByTypeUser),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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/2021-07-01-preview/examples/PrivateLinkScopesCreate.json
*/
async function privateLinkScopeCreate() {
const subscriptionId =
process.env["MONITOR_SUBSCRIPTION_ID"] || "86dc51d3-92ed-4d7e-947a-775ea79b4919";
const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "my-resource-group";
const scopeName = "my-privatelinkscope";
const azureMonitorPrivateLinkScopePayload = {
accessModeSettings: {
exclusions: [],
ingestionAccessMode: "Open",
queryAccessMode: "Open",
},
location: "Global",
};
const credential = new DefaultAzureCredential();
const client = new MonitorClient(credential, subscriptionId);
const result = await client.privateLinkScopes.createOrUpdate(
resourceGroupName,
scopeName,
azureMonitorPrivateLinkScopePayload,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;
// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/PrivateLinkScopesCreate.json
// this example is just showing the usage of "PrivateLinkScopes_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4919";
string resourceGroupName = "my-resource-group";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);
// get the collection of this MonitorPrivateLinkScopeResource
MonitorPrivateLinkScopeCollection collection = resourceGroupResource.GetMonitorPrivateLinkScopes();
// invoke the operation
string scopeName = "my-privatelinkscope";
MonitorPrivateLinkScopeData data = new MonitorPrivateLinkScopeData(new AzureLocation("Global"), new MonitorPrivateLinkAccessModeSettings(MonitorPrivateLinkAccessMode.Open, MonitorPrivateLinkAccessMode.Open)
{
Exclusions =
{
},
});
ArmOperation<MonitorPrivateLinkScopeResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, scopeName, data);
MonitorPrivateLinkScopeResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MonitorPrivateLinkScopeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
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
{
"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": {},
"systemData": {
"createdBy": "bobby@contoso.com",
"createdByType": "User",
"createdAt": "2021-06-16T12:59:57.051056Z",
"lastModifiedBy": "bobby@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-16T12:59:57.051056Z"
},
"properties": {
"provisioningState": "Succeeded",
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
{
"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": {},
"systemData": {
"createdBy": "bobby@contoso.com",
"createdByType": "User",
"createdAt": "2021-06-16T12:59:57.051056Z",
"lastModifiedBy": "bobby@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-16T12:59:57.051056Z"
},
"properties": {
"provisioningState": "Succeeded",
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
PrivateLinkScopeUpdate
Sample request
PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope?api-version=2021-07-01-preview
{
"location": "Global",
"tags": {
"Tag1": "Value1"
},
"properties": {
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
import com.azure.resourcemanager.monitor.fluent.models.AzureMonitorPrivateLinkScopeInner;
import com.azure.resourcemanager.monitor.models.AccessMode;
import com.azure.resourcemanager.monitor.models.AccessModeSettings;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/**
* Samples for PrivateLinkScopes CreateOrUpdate.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/
* PrivateLinkScopesUpdate.json
*/
/**
* Sample code: PrivateLinkScopeUpdate.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void privateLinkScopeUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
azure.diagnosticSettings().manager().serviceClient().getPrivateLinkScopes().createOrUpdateWithResponse(
"my-resource-group", "my-privatelinkscope",
new AzureMonitorPrivateLinkScopeInner().withLocation("Global").withTags(mapOf("Tag1", "Value1"))
.withAccessModeSettings(new AccessModeSettings().withQueryAccessMode(AccessMode.OPEN)
.withIngestionAccessMode(AccessMode.OPEN).withExclusions(Arrays.asList())),
com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/PrivateLinkScopesUpdate.json
func ExamplePrivateLinkScopesClient_CreateOrUpdate_privateLinkScopeUpdate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkScopesClient().CreateOrUpdate(ctx, "my-resource-group", "my-privatelinkscope", armmonitor.AzureMonitorPrivateLinkScope{
Location: to.Ptr("Global"),
Tags: map[string]*string{
"Tag1": to.Ptr("Value1"),
},
Properties: &armmonitor.AzureMonitorPrivateLinkScopeProperties{
AccessModeSettings: &armmonitor.AccessModeSettings{
Exclusions: []*armmonitor.AccessModeSettingsExclusion{},
IngestionAccessMode: to.Ptr(armmonitor.AccessModeOpen),
QueryAccessMode: to.Ptr(armmonitor.AccessModeOpen),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureMonitorPrivateLinkScope = armmonitor.AzureMonitorPrivateLinkScope{
// Name: to.Ptr("my-privatelinkscope"),
// Type: to.Ptr("Microsoft.Insights/privateLinkScopes"),
// ID: to.Ptr("/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope"),
// Location: to.Ptr("Global"),
// Tags: map[string]*string{
// "Tag1": to.Ptr("Value1"),
// },
// Properties: &armmonitor.AzureMonitorPrivateLinkScopeProperties{
// AccessModeSettings: &armmonitor.AccessModeSettings{
// Exclusions: []*armmonitor.AccessModeSettingsExclusion{
// },
// IngestionAccessMode: to.Ptr(armmonitor.AccessModeOpen),
// QueryAccessMode: to.Ptr(armmonitor.AccessModeOpen),
// },
// ProvisioningState: to.Ptr("Succeeded"),
// },
// SystemData: &armmonitor.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T12:59:57.051Z"); return t}()),
// CreatedBy: to.Ptr("bobby@contoso.com"),
// CreatedByType: to.Ptr(armmonitor.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T12:59:57.051Z"); return t}()),
// LastModifiedBy: to.Ptr("bobby@contoso.com"),
// LastModifiedByType: to.Ptr(armmonitor.CreatedByTypeUser),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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/2021-07-01-preview/examples/PrivateLinkScopesUpdate.json
*/
async function privateLinkScopeUpdate() {
const subscriptionId =
process.env["MONITOR_SUBSCRIPTION_ID"] || "86dc51d3-92ed-4d7e-947a-775ea79b4919";
const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "my-resource-group";
const scopeName = "my-privatelinkscope";
const azureMonitorPrivateLinkScopePayload = {
accessModeSettings: {
exclusions: [],
ingestionAccessMode: "Open",
queryAccessMode: "Open",
},
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);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;
// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/examples/PrivateLinkScopesUpdate.json
// this example is just showing the usage of "PrivateLinkScopes_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4919";
string resourceGroupName = "my-resource-group";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);
// get the collection of this MonitorPrivateLinkScopeResource
MonitorPrivateLinkScopeCollection collection = resourceGroupResource.GetMonitorPrivateLinkScopes();
// invoke the operation
string scopeName = "my-privatelinkscope";
MonitorPrivateLinkScopeData data = new MonitorPrivateLinkScopeData(new AzureLocation("Global"), new MonitorPrivateLinkAccessModeSettings(MonitorPrivateLinkAccessMode.Open, MonitorPrivateLinkAccessMode.Open)
{
Exclusions =
{
},
})
{
Tags =
{
["Tag1"] = "Value1",
},
};
ArmOperation<MonitorPrivateLinkScopeResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, scopeName, data);
MonitorPrivateLinkScopeResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MonitorPrivateLinkScopeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
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
{
"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"
},
"systemData": {
"createdBy": "bobby@contoso.com",
"createdByType": "User",
"createdAt": "2021-06-16T12:59:57.051056Z",
"lastModifiedBy": "bobby@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-16T12:59:57.051056Z"
},
"properties": {
"provisioningState": "Succeeded",
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
{
"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"
},
"systemData": {
"createdBy": "bobby@contoso.com",
"createdByType": "User",
"createdAt": "2021-06-16T12:59:57.051056Z",
"lastModifiedBy": "bobby@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-16T12:59:57.051056Z"
},
"properties": {
"provisioningState": "Succeeded",
"accessModeSettings": {
"queryAccessMode": "Open",
"ingestionAccessMode": "Open",
"exclusions": []
}
}
}
Definitions
AccessMode
Access mode types.
Name |
Type |
Description |
Open
|
string
|
|
PrivateOnly
|
string
|
|
AccessModeSettings
Properties that define the scope private link mode settings.
Name |
Type |
Description |
exclusions
|
AccessModeSettingsExclusion[]
|
List of exclusions that override the default access mode settings for specific private endpoint connections.
|
ingestionAccessMode
|
AccessMode
|
Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
|
queryAccessMode
|
AccessMode
|
Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
|
AccessModeSettingsExclusion
Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.
Name |
Type |
Description |
ingestionAccessMode
|
AccessMode
|
Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
|
privateEndpointConnectionName
|
string
|
The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
|
queryAccessMode
|
AccessMode
|
Specifies the access mode of queries through the specified private endpoint connection in the exclusion.
|
AzureMonitorPrivateLinkScope
An Azure Monitor PrivateLinkScope definition.
Name |
Type |
Description |
id
|
string
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
location
|
string
|
The geo-location where the resource lives
|
name
|
string
|
The name of the resource
|
properties.accessModeSettings
|
AccessModeSettings
|
Access mode settings
|
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.
|
systemData
|
systemData
|
System data
|
tags
|
object
|
Resource tags.
|
type
|
string
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
createdByType
The type of identity that created the resource.
Name |
Type |
Description |
Application
|
string
|
|
Key
|
string
|
|
ManagedIdentity
|
string
|
|
User
|
string
|
|
DefaultErrorResponse
Default error response
Name |
Type |
Description |
error
|
ErrorDetail
|
The error object.
|
ErrorAdditionalInfo
The resource management error additional info.
Name |
Type |
Description |
info
|
object
|
The additional info.
|
type
|
string
|
The additional info type.
|
ErrorDetail
The error detail.
Name |
Type |
Description |
additionalInfo
|
ErrorAdditionalInfo[]
|
The error additional info.
|
code
|
string
|
The error code.
|
details
|
ErrorDetail[]
|
The error details.
|
message
|
string
|
The error message.
|
target
|
string
|
The error target.
|
PrivateEndpoint
The Private Endpoint resource.
Name |
Type |
Description |
id
|
string
|
The ARM identifier for Private Endpoint
|
PrivateEndpointConnection
The Private Endpoint Connection resource.
Name |
Type |
Description |
id
|
string
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
The name of the resource
|
properties.privateEndpoint
|
PrivateEndpoint
|
The resource of private end point.
|
properties.privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
A collection of information about the state of the connection between service consumer and provider.
|
properties.provisioningState
|
PrivateEndpointConnectionProvisioningState
|
The provisioning state of the private endpoint connection resource.
|
type
|
string
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
PrivateEndpointConnectionProvisioningState
The current provisioning state.
Name |
Type |
Description |
Creating
|
string
|
|
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Name |
Type |
Description |
Approved
|
string
|
|
Pending
|
string
|
|
Rejected
|
string
|
|
PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
Name |
Type |
Description |
actionsRequired
|
string
|
A message indicating if changes on the service provider require any updates on the consumer.
|
description
|
string
|
The reason for approval/rejection of the connection.
|
status
|
PrivateEndpointServiceConnectionStatus
|
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
|
systemData
Metadata pertaining to creation and last modification of the resource.
Name |
Type |
Description |
createdAt
|
string
|
The timestamp of resource creation (UTC).
|
createdBy
|
string
|
The identity that created the resource.
|
createdByType
|
createdByType
|
The type of identity that created the resource.
|
lastModifiedAt
|
string
|
The timestamp of resource last modification (UTC)
|
lastModifiedBy
|
string
|
The identity that last modified the resource.
|
lastModifiedByType
|
createdByType
|
The type of identity that last modified the resource.
|