-
Notifications
You must be signed in to change notification settings - Fork 10
/
Private-Link-Resources-Get.yml
164 lines (163 loc) · 4.99 KB
/
Private-Link-Resources-Get.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
### YamlMime:RESTOperation
uid: management.azure.com.digital-twins.controlplane.privateendpoints.privatelinkresources_get
name: PrivateLinkResources Get
service: Azure Digital Twins
groupName: Private Endpoints
apiVersion: 2023-01-31
summary: Get the specified private link resource for the given Digital Twin.
consumes:
- application/json
produces:
- application/json
paths:
- content: GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId}?api-version=2023-01-31
uriParameters:
- name: subscriptionId
in: path
isRequired: true
description: The subscription identifier.
types:
- uid: string
- name: resourceGroupName
in: path
isRequired: true
description: The name of the resource group that contains the DigitalTwinsInstance.
types:
- uid: string
- name: resourceName
in: path
isRequired: true
description: The name of the DigitalTwinsInstance.
types:
- uid: string
pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$
- name: resourceId
in: path
isRequired: true
description: The name of the private link resource.
types:
- uid: string
- name: api-version
in: query
isRequired: true
description: Version of the DigitalTwinsInstance Management API.
types:
- uid: string
responses:
- name: 200 OK
description: The body contains the specified of private link resource.
types:
- uid: GroupIdInformation
- name: Other Status Codes
description: Error response describing why the operation failed.
types:
- uid: ErrorResponse
requestHeader: []
definitions:
- name: GroupIdInformation
description: The group information for creating a private endpoint on Digital Twin.
kind: object
properties:
- name: properties
description: The group information properties.
types:
- uid: GroupIdInformationProperties
- name: id
description: The resource identifier.
types:
- uid: string
- name: name
isReadOnly: true
description: The resource name.
types:
- uid: string
- name: type
isReadOnly: true
description: The resource type.
types:
- uid: string
- name: ErrorResponse
description: Error response.
kind: object
properties:
- name: error
description: Error description
types:
- uid: ErrorDefinition
- name: GroupIdInformationProperties
description: The properties for a group information object.
kind: object
properties:
- name: groupId
description: The group id.
types:
- uid: string
- name: requiredMembers
description: The required members for a specific group id.
types:
- uid: string
isArray: true
- name: requiredZoneNames
description: The required DNS zones for a specific group id.
types:
- uid: string
isArray: true
- name: ErrorDefinition
description: Error definition.
kind: object
properties:
- name: code
isReadOnly: true
description: Service specific error code which serves as the substatus for the HTTP error code.
types:
- uid: string
- name: message
isReadOnly: true
description: Description of the error.
types:
- uid: string
- name: details
isReadOnly: true
description: Internal error details.
types:
- uid: ErrorDefinition
isArray: true
examples:
- name: Get the specified private link resource for the given Digital Twin
request:
uri: 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
codeTab: |+
# [HTTP](#tab/HTTP)
``` 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
```
responses:
- statusCode: "200"
body: >-
{
"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"
]
}
}
security:
- name: azure_auth
type: oauth2
description: Azure Active Directory OAuth2 Flow
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
- name: user_impersonation
description: Impersonate your user account
metadata:
description: >
Learn more about Azure Digital Twins service - Get the specified private link resource for the given Digital Twin.
errorCodes: []