Private Link Scopes - Get

Returns a Azure Monitor PrivateLinkScope.

GET 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.

Responses

Name Type Description
200 OK

AzureMonitorPrivateLinkScope

An Azure Monitor PrivateLinkScope definition.

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

PrivateLinkScopeGet

Sample request

GET 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

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": []
    }
  }
}

Definitions

Name Description
AccessMode

Access mode types.

AccessModeSettings

Properties that define the scope private link mode settings.

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.

AzureMonitorPrivateLinkScope

An Azure Monitor PrivateLinkScope definition.

createdByType

The type of identity that created the resource.

DefaultErrorResponse

Default error response

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

systemData

Metadata pertaining to creation and last modification of the resource.

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.