Freigeben über


Private Link Scoped Resources - Get

Gets a scoped resource in a private link scope.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}?api-version=2021-07-01-preview

URI Parameters

Name In Required Type Description
name
path True

string

The name of the scoped resource object.

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

ScopedResource

Successfully retrieved a scoped resource in a private link scope.

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

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name?api-version=2021-07-01-preview

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name",
  "name": "scoped-resource-name",
  "type": "Microsoft.Insights/privateLinkScopes/scopedResources",
  "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": {
    "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

DefaultErrorResponse

Default error response

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ScopedResource

A private link scoped resource

systemData

Metadata pertaining to creation and last modification of the resource.

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.

ScopedResource

A private link scoped 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.linkedResourceId

string

The resource id of the scoped Azure monitor resource.

properties.provisioningState

string

State of the private endpoint connection.

systemData

systemData

System data

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.