Dela via


Private Endpoints - PrivateLinkResources List

List private link resources for given Digital Twin.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources?api-version=2023-01-31

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName
path True

string

The name of the DigitalTwinsInstance.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

Version of the DigitalTwinsInstance Management API.

Responses

Name Type Description
200 OK

GroupIdInformationResponse

The body contains the list of private link resources.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateLinkResources?api-version=2023-01-31

Sample response

{
  "value": [
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateLinkResources/myDigitalTwinsService",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances/privateLinkResources",
      "name": "myDigitalTwinsService",
      "properties": {
        "groupId": "digitalTwinsInstance",
        "requiredMembers": [
          "myDigitalTwinsService"
        ],
        "requiredZoneNames": [
          "privatelink.api.wus2.digitaltwins.azure.net"
        ]
      }
    }
  ]
}

Definitions

Name Description
ErrorDefinition

Error definition.

ErrorResponse

Error response.

GroupIdInformation

The group information for creating a private endpoint on Digital Twin.

GroupIdInformationProperties

The properties for a group information object.

GroupIdInformationResponse

The available private link resources for a Digital Twin.

ErrorDefinition

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.

details

ErrorDefinition[]

Internal error details.

message

string

Description of the error.

ErrorResponse

Error response.

Name Type Description
error

ErrorDefinition

Error description

GroupIdInformation

The group information for creating a private endpoint on Digital Twin.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties

GroupIdInformationProperties

The group information properties.

type

string

The resource type.

GroupIdInformationProperties

The properties for a group information object.

Name Type Description
groupId

string

The group id.

requiredMembers

string[]

The required members for a specific group id.

requiredZoneNames

string[]

The required DNS zones for a specific group id.

GroupIdInformationResponse

The available private link resources for a Digital Twin.

Name Type Description
value

GroupIdInformation[]

The list of available private link resources for a Digital Twin.