Private Link Scopes - Update Tags
Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
PATCH 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 |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
scope
|
path | True |
string |
The name of the Azure Monitor PrivateLinkScope resource. |
subscription
|
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 | Type | Description |
---|---|---|
tags |
object |
Resource tags |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Updating the Azure Monitor PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties. |
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
PrivateLinkScopeUpdateTagsOnly
Sample request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope?api-version=2019-10-17-preview
{
"tags": {
"Tag1": "Value1",
"Tag2": "Value2"
}
}
Sample response
{
"id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
"name": "my-privatelinkscope",
"type": "Microsoft.Insights/privateLinkScopes",
"location": "Global",
"tags": {
"Tag1": "Value1",
"Tag2": "Value2"
},
"properties": {
"provisioningState": "Succeeded"
}
}
Definitions
Name | Description |
---|---|
Azure |
An Azure Monitor PrivateLinkScope definition. |
Private |
A private endpoint connection |
Private |
Private endpoint which the connection belongs to. |
Private |
State of the private endpoint connection. |
Tags |
A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. |
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 |
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 |
Private endpoint which the connection belongs to. |
|
properties.privateLinkServiceConnectionState |
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. |
TagsResource
A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.
Name | Type | Description |
---|---|---|
tags |
object |
Resource tags |