-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
TopLevelDomains.json
299 lines (299 loc) · 8.57 KB
/
TopLevelDomains.json
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
{
"swagger": "2.0",
"info": {
"version": "2020-10-01",
"title": "TopLevelDomains API Client"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains": {
"get": {
"tags": [
"TopLevelDomains"
],
"summary": "Get all top-level domains supported for registration.",
"description": "Get all top-level domains supported for registration.",
"operationId": "TopLevelDomains_List",
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopLevelDomainCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Top Level Domains": {
"$ref": "./examples/ListTopLevelDomains.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}": {
"get": {
"tags": [
"TopLevelDomains"
],
"summary": "Get details of a top-level domain.",
"description": "Get details of a top-level domain.",
"operationId": "TopLevelDomains_Get",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Name of the top-level domain.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopLevelDomain"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Top Level Domain": {
"$ref": "./examples/GetTopLevelDomain.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements": {
"post": {
"tags": [
"TopLevelDomains"
],
"summary": "Gets all legal agreements that user needs to accept before purchasing a domain.",
"description": "Gets all legal agreements that user needs to accept before purchasing a domain.",
"operationId": "TopLevelDomains_ListAgreements",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Name of the top-level domain.",
"required": true,
"type": "string"
},
{
"name": "agreementOption",
"in": "body",
"description": "Domain agreement options.",
"required": true,
"schema": {
"$ref": "#/definitions/TopLevelDomainAgreementOption"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TldLegalAgreementCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Top Level Domain Agreements": {
"$ref": "./examples/ListTopLevelDomainAgreements.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"TldLegalAgreement": {
"description": "Legal agreement for a top level domain.",
"required": [
"agreementKey",
"title",
"content"
],
"type": "object",
"properties": {
"agreementKey": {
"description": "Unique identifier for the agreement.",
"type": "string"
},
"title": {
"description": "Agreement title.",
"type": "string"
},
"content": {
"description": "Agreement details.",
"type": "string"
},
"url": {
"description": "URL where a copy of the agreement details is hosted.",
"type": "string"
}
}
},
"TldLegalAgreementCollection": {
"description": "Collection of top-level domain legal agreements.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "Collection of resources.",
"type": "array",
"items": {
"$ref": "#/definitions/TldLegalAgreement"
}
},
"nextLink": {
"description": "Link to next page of resources.",
"type": "string",
"readOnly": true
}
}
},
"TopLevelDomain": {
"description": "A top level domain object.",
"type": "object",
"allOf": [
{
"$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
"description": "TopLevelDomain resource specific properties",
"properties": {
"privacy": {
"description": "If <code>true</code>, then the top level domain supports domain privacy; otherwise, <code>false</code>.",
"type": "boolean"
}
},
"x-ms-client-flatten": true
}
}
},
"TopLevelDomainAgreementOption": {
"description": "Options for retrieving the list of top level domain legal agreements.",
"type": "object",
"properties": {
"includePrivacy": {
"description": "If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>.",
"type": "boolean"
},
"forTransfer": {
"description": "If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; otherwise, <code>false</code>.",
"type": "boolean"
}
}
},
"TopLevelDomainCollection": {
"description": "Collection of Top-level domains.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "Collection of resources.",
"type": "array",
"items": {
"$ref": "#/definitions/TopLevelDomain"
}
},
"nextLink": {
"description": "Link to next page of resources.",
"type": "string",
"readOnly": true
}
}
}
},
"parameters": {
"subscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
"required": true,
"type": "string"
},
"apiVersionParameter": {
"name": "api-version",
"in": "query",
"description": "API Version",
"required": true,
"type": "string"
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
]
}