Private Endpoints - PrivateLinkResources Get

Reference

Service:: Azure Digital Twins

API Version:: 2023-01-31

Get the specified private link resource for the given Digital Twin.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId}?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.
resourceId	path	True	string	The name of the private link resource.
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	GroupIdInformation	The body contains the specified of private link resource.
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

Get the specified private link resource for the given Digital Twin

Sample Request

HTTP

GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateLinkResources/subResource?api-version=2023-01-31

Sample Response

Status code:: 200

{
  "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.

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.

Share via