Skip to content

Commit fb1e2c6

Browse files
xiaoxuqi-msAzureRestAPISpecReview
xiaoxuqi-ms
and
AzureRestAPISpecReview
authored
[Hub Generated] Publish private branch 'mysql/official/20230601.1' (#25698)
* [AutoSyncSwagger] 9bc611c6c add private endpoint connections * fix typo * fix * fix * fix * fix * fix --------- Co-authored-by: apispec-automation <[email protected]>
1 parent 32c178f commit fb1e2c6

File tree

65 files changed

+10621
-23
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+10621
-23
lines changed

‎specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/preview/2023-06-01-preview/AzureADAdministrator.json

Lines changed: 325 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,325 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "MySQLManagementClient",
5+
"description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.",
6+
"version": "2023-06-01-preview"
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {
37+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators/{administratorName}": {
38+
"put": {
39+
"tags": [
40+
"AzureADAdministrators"
41+
],
42+
"operationId": "AzureADAdministrators_CreateOrUpdate",
43+
"x-ms-examples": {
44+
"Create an azure ad administrator": {
45+
"$ref": "./examples/AzureADAdministratorCreate.json"
46+
}
47+
},
48+
"description": "Creates or updates an existing Azure Active Directory administrator.",
49+
"parameters": [
50+
{
51+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
52+
},
53+
{
54+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
55+
},
56+
{
57+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
58+
},
59+
{
60+
"$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter"
61+
},
62+
{
63+
"$ref": "#/parameters/AdministratorNameParameter"
64+
},
65+
{
66+
"name": "parameters",
67+
"in": "body",
68+
"required": true,
69+
"schema": {
70+
"$ref": "#/definitions/AzureADAdministrator"
71+
},
72+
"description": "The required parameters for creating or updating an aad administrator."
73+
}
74+
],
75+
"responses": {
76+
"200": {
77+
"description": "OK",
78+
"schema": {
79+
"$ref": "#/definitions/AzureADAdministrator"
80+
}
81+
},
82+
"201": {
83+
"description": "Created",
84+
"schema": {
85+
"$ref": "#/definitions/AzureADAdministrator"
86+
}
87+
},
88+
"202": {
89+
"description": "Accepted"
90+
},
91+
"default": {
92+
"description": "Error response describing why the operation failed.",
93+
"schema": {
94+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
95+
}
96+
}
97+
},
98+
"x-ms-long-running-operation": true
99+
},
100+
"delete": {
101+
"tags": [
102+
"AzureADAdministrators"
103+
],
104+
"operationId": "AzureADAdministrators_Delete",
105+
"x-ms-examples": {
106+
"Delete an azure ad administrator": {
107+
"$ref": "./examples/AzureADAdministratorDelete.json"
108+
}
109+
},
110+
"description": "Deletes an Azure AD Administrator.",
111+
"parameters": [
112+
{
113+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
114+
},
115+
{
116+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
117+
},
118+
{
119+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
120+
},
121+
{
122+
"$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter"
123+
},
124+
{
125+
"$ref": "#/parameters/AdministratorNameParameter"
126+
}
127+
],
128+
"responses": {
129+
"200": {
130+
"description": "OK"
131+
},
132+
"202": {
133+
"description": "Accepted"
134+
},
135+
"204": {
136+
"description": "NoContent"
137+
},
138+
"default": {
139+
"description": "Error response describing why the operation failed.",
140+
"schema": {
141+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
142+
}
143+
}
144+
},
145+
"x-ms-long-running-operation": true,
146+
"x-ms-long-running-operation-options": {
147+
"final-state-via": "location"
148+
}
149+
},
150+
"get": {
151+
"tags": [
152+
"AzureADAdministrators"
153+
],
154+
"operationId": "AzureADAdministrators_Get",
155+
"x-ms-examples": {
156+
"Get an azure ad administrator": {
157+
"$ref": "./examples/AzureADAdministratorGet.json"
158+
}
159+
},
160+
"description": "Gets information about an azure ad administrator.",
161+
"parameters": [
162+
{
163+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
164+
},
165+
{
166+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
167+
},
168+
{
169+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
170+
},
171+
{
172+
"$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter"
173+
},
174+
{
175+
"$ref": "#/parameters/AdministratorNameParameter"
176+
}
177+
],
178+
"responses": {
179+
"200": {
180+
"description": "OK",
181+
"schema": {
182+
"$ref": "#/definitions/AzureADAdministrator"
183+
}
184+
},
185+
"default": {
186+
"description": "Error response describing why the operation failed.",
187+
"schema": {
188+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
189+
}
190+
}
191+
}
192+
}
193+
},
194+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators": {
195+
"get": {
196+
"tags": [
197+
"AzureADAdministrators"
198+
],
199+
"operationId": "AzureADAdministrators_ListByServer",
200+
"x-ms-examples": {
201+
"List Azure AD administrators in a server": {
202+
"$ref": "./examples/AzureADAdministratorsListByServer.json"
203+
}
204+
},
205+
"description": "List all the AAD administrators in a given server.",
206+
"parameters": [
207+
{
208+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
209+
},
210+
{
211+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
212+
},
213+
{
214+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
215+
},
216+
{
217+
"$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter"
218+
}
219+
],
220+
"responses": {
221+
"200": {
222+
"description": "OK",
223+
"schema": {
224+
"$ref": "#/definitions/AdministratorListResult"
225+
}
226+
},
227+
"default": {
228+
"description": "Error response describing why the operation failed.",
229+
"schema": {
230+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
231+
}
232+
}
233+
},
234+
"x-ms-pageable": {
235+
"nextLinkName": "nextLink"
236+
}
237+
}
238+
}
239+
},
240+
"definitions": {
241+
"AdministratorProperties": {
242+
"type": "object",
243+
"properties": {
244+
"administratorType": {
245+
"type": "string",
246+
"description": "Type of the sever administrator.",
247+
"enum": [
248+
"ActiveDirectory"
249+
],
250+
"x-ms-enum": {
251+
"name": "AdministratorType",
252+
"modelAsString": true
253+
}
254+
},
255+
"login": {
256+
"type": "string",
257+
"description": "Login name of the server administrator."
258+
},
259+
"sid": {
260+
"type": "string",
261+
"description": "SID (object ID) of the server administrator."
262+
},
263+
"tenantId": {
264+
"type": "string",
265+
"description": "Tenant ID of the administrator."
266+
},
267+
"identityResourceId": {
268+
"type": "string",
269+
"description": "The resource id of the identity used for AAD Authentication."
270+
}
271+
},
272+
"description": "The properties of an administrator."
273+
},
274+
"AzureADAdministrator": {
275+
"type": "object",
276+
"properties": {
277+
"properties": {
278+
"$ref": "#/definitions/AdministratorProperties",
279+
"x-ms-client-flatten": true,
280+
"description": "The properties of an administrator."
281+
}
282+
},
283+
"allOf": [
284+
{
285+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
286+
}
287+
],
288+
"description": "Represents a Administrator."
289+
},
290+
"AdministratorListResult": {
291+
"type": "object",
292+
"properties": {
293+
"value": {
294+
"type": "array",
295+
"items": {
296+
"$ref": "#/definitions/AzureADAdministrator"
297+
},
298+
"description": "The list of azure ad administrator of a server"
299+
},
300+
"nextLink": {
301+
"description": "The link used to get the next page of operations.",
302+
"type": "string"
303+
}
304+
},
305+
"description": "A List of azure ad administrators."
306+
}
307+
},
308+
"parameters": {
309+
"AdministratorNameParameter": {
310+
"name": "administratorName",
311+
"in": "path",
312+
"required": true,
313+
"type": "string",
314+
"enum": [
315+
"ActiveDirectory"
316+
],
317+
"x-ms-enum": {
318+
"name": "AdministratorName",
319+
"modelAsString": true
320+
},
321+
"description": "The name of the Azure AD Administrator.",
322+
"x-ms-parameter-location": "method"
323+
}
324+
}
325+
}

‎specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/preview/2023-06-01-preview/examples/AzureADAdministratorCreate.json

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
4+
"resourceGroupName": "testrg",
5+
"serverName": "mysqltestsvc4",
6+
"administratorName": "ActiveDirectory",
7+
"api-version": "2023-06-01-preview",
8+
"parameters": {
9+
"properties": {
10+
"administratorType": "ActiveDirectory",
11+
"login": "[email protected]",
12+
"sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
13+
"tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467",
14+
"identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"
15+
}
16+
}
17+
},
18+
"responses": {
19+
"200": {
20+
"body": {
21+
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory",
22+
"name": "ActiveDirectory",
23+
"type": "Microsoft.DBforMySQL/flexibleServers/administrators",
24+
"properties": {
25+
"administratorType": "ActiveDirectory",
26+
"login": "[email protected]",
27+
"sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
28+
"tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467",
29+
"identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"
30+
}
31+
}
32+
},
33+
"201": {
34+
"body": {
35+
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory",
36+
"name": "ActiveDirectory",
37+
"type": "Microsoft.DBforMySQL/flexibleServers/administrators",
38+
"properties": {
39+
"administratorType": "ActiveDirectory",
40+
"login": "[email protected]",
41+
"sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
42+
"tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467",
43+
"identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"
44+
}
45+
}
46+
},
47+
"202": {}
48+
}
49+
}

0 commit comments

Comments
 (0)