Skip to content

Commit 663ea68

Browse files
matthohn-msftmatthohn-msft
authored
[Hub Generated] Review request for Microsoft.Communication to add version preview/2023-06-01-preview (#25952)
* Adds base for updating Microsoft.Communication from version preview/2023-04-01-preview to version 2023-06-01-preview * Updates readme * Updates API version in new specs and examples * Adding SuppressionList support. * Updating readme file * Fixing model validation error * Prettier fixes * Fixing endpoint description * remove dataLocation and make datetime props readonly * Fixing model validation error * Remove datalocation from examples * update to v5 * Addressing lintdiff failures * Fix model validation errors * Revert pattern change which introduced the breaking change * add local domainName parameter
1 parent d56d45a commit 663ea68

Some content is hidden

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

49 files changed

+4617
-3
lines changed

‎specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/CommunicationServices.json

+866
Large diffs are not rendered by default.

‎specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/Domains.json

+732
Large diffs are not rendered by default.

‎specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/EmailServices.json

+502
Large diffs are not rendered by default.

‎specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/SenderUsernames.json

+339
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,339 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "Azure Communication Services Management API",
5+
"version": "2023-06-01-preview",
6+
"description": "REST API for Email Services/Domains/SenderUsernames"
7+
},
8+
"consumes": [
9+
"application/json"
10+
],
11+
"produces": [
12+
"application/json"
13+
],
14+
"host": "management.azure.com",
15+
"schemes": [
16+
"https"
17+
],
18+
"securityDefinitions": {
19+
"azure_auth": {
20+
"type": "oauth2",
21+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
22+
"flow": "implicit",
23+
"description": "Azure Active Directory OAuth2 Flow",
24+
"scopes": {
25+
"user_impersonation": "impersonate your user account"
26+
}
27+
}
28+
},
29+
"paths": {
30+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames": {
31+
"get": {
32+
"description": "List all valid sender usernames for a domains resource.",
33+
"operationId": "SenderUsernames_ListByDomains",
34+
"summary": "ListBy_Domains",
35+
"tags": [
36+
"SenderUsernames"
37+
],
38+
"parameters": [
39+
{
40+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
41+
},
42+
{
43+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
44+
},
45+
{
46+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
47+
},
48+
{
49+
"$ref": "EmailServices.json#/parameters/EmailServiceName"
50+
},
51+
{
52+
"$ref": "Domains.json#/parameters/DomainName"
53+
}
54+
],
55+
"responses": {
56+
"200": {
57+
"description": "Success. The response describe the Domains SenderUsername collection.",
58+
"schema": {
59+
"$ref": "#/definitions/SenderUsernameResourceCollection"
60+
}
61+
},
62+
"default": {
63+
"description": "Error response describing why the operation failed.",
64+
"schema": {
65+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
66+
}
67+
}
68+
},
69+
"x-ms-pageable": {
70+
"nextLinkName": "nextLink"
71+
},
72+
"produces": [
73+
"application/json"
74+
],
75+
"x-ms-examples": {
76+
"Get all SenderUsernames resources for a Domain.": {
77+
"$ref": "./examples/senderUsernames/listByDomain.json"
78+
}
79+
}
80+
}
81+
},
82+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}": {
83+
"get": {
84+
"description": "Get a valid sender username for a domains resource.",
85+
"operationId": "SenderUsernames_Get",
86+
"summary": "Get",
87+
"tags": [
88+
"SenderUsernames"
89+
],
90+
"parameters": [
91+
{
92+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
93+
},
94+
{
95+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
96+
},
97+
{
98+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
99+
},
100+
{
101+
"$ref": "EmailServices.json#/parameters/EmailServiceName"
102+
},
103+
{
104+
"$ref": "Domains.json#/parameters/DomainName"
105+
},
106+
{
107+
"$ref": "#/parameters/SenderUsername"
108+
}
109+
],
110+
"responses": {
111+
"200": {
112+
"description": "Success. The response describe the corresponding SenderUsername resource.",
113+
"schema": {
114+
"$ref": "#/definitions/SenderUsernameResource"
115+
}
116+
},
117+
"default": {
118+
"description": "Error response describing why the operation failed.",
119+
"schema": {
120+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
121+
}
122+
}
123+
},
124+
"produces": [
125+
"application/json"
126+
],
127+
"x-ms-examples": {
128+
"Get SenderUsernames resource": {
129+
"$ref": "./examples/senderUsernames/get.json"
130+
}
131+
}
132+
},
133+
"put": {
134+
"description": "Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.",
135+
"operationId": "SenderUsernames_CreateOrUpdate",
136+
"summary": "Create Or Update",
137+
"tags": [
138+
"SenderUsernames"
139+
],
140+
"parameters": [
141+
{
142+
"name": "parameters",
143+
"in": "body",
144+
"description": "Parameters for the create or update operation",
145+
"required": true,
146+
"schema": {
147+
"$ref": "#/definitions/SenderUsernameResource"
148+
}
149+
},
150+
{
151+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
152+
},
153+
{
154+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
155+
},
156+
{
157+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
158+
},
159+
{
160+
"$ref": "EmailServices.json#/parameters/EmailServiceName"
161+
},
162+
{
163+
"$ref": "Domains.json#/parameters/DomainName"
164+
},
165+
{
166+
"$ref": "#/parameters/SenderUsername"
167+
}
168+
],
169+
"consumes": [
170+
"application/json"
171+
],
172+
"responses": {
173+
"200": {
174+
"description": "The update request was completed successfully",
175+
"schema": {
176+
"$ref": "#/definitions/SenderUsernameResource"
177+
}
178+
},
179+
"201": {
180+
"description": "The create request was completed successfully",
181+
"schema": {
182+
"$ref": "#/definitions/SenderUsernameResource"
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+
"produces": [
193+
"application/json"
194+
],
195+
"x-ms-examples": {
196+
"Create or update SenderUsernames resource": {
197+
"$ref": "./examples/senderUsernames/createOrUpdate.json"
198+
}
199+
}
200+
},
201+
"delete": {
202+
"description": "Operation to delete a SenderUsernames resource.",
203+
"operationId": "SenderUsernames_Delete",
204+
"summary": "Delete",
205+
"tags": [
206+
"SenderUsernames"
207+
],
208+
"parameters": [
209+
{
210+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
211+
},
212+
{
213+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
214+
},
215+
{
216+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
217+
},
218+
{
219+
"$ref": "EmailServices.json#/parameters/EmailServiceName"
220+
},
221+
{
222+
"$ref": "Domains.json#/parameters/DomainName"
223+
},
224+
{
225+
"$ref": "#/parameters/SenderUsername"
226+
}
227+
],
228+
"responses": {
229+
"200": {
230+
"description": "The delete operation was successful."
231+
},
232+
"204": {
233+
"description": "The resource did not exist."
234+
},
235+
"default": {
236+
"description": "Error response describing why the operation failed.",
237+
"schema": {
238+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
239+
}
240+
}
241+
},
242+
"x-ms-examples": {
243+
"Delete SenderUsernames resource": {
244+
"$ref": "./examples/senderUsernames/delete.json"
245+
}
246+
}
247+
}
248+
}
249+
},
250+
"definitions": {
251+
"SenderUsernameResource": {
252+
"description": "A class representing a SenderUsername resource.",
253+
"type": "object",
254+
"allOf": [
255+
{
256+
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
257+
}
258+
],
259+
"properties": {
260+
"properties": {
261+
"$ref": "#/definitions/SenderUsernameProperties",
262+
"description": "The properties of a SenderUsername resource.",
263+
"x-ms-client-flatten": true
264+
}
265+
}
266+
},
267+
"SenderUsernameResourceCollection": {
268+
"description": "A class representing a Domains SenderUsernames collection.",
269+
"type": "object",
270+
"properties": {
271+
"value": {
272+
"description": "List of SenderUsernames",
273+
"type": "array",
274+
"items": {
275+
"$ref": "#/definitions/SenderUsernameResource"
276+
}
277+
},
278+
"nextLink": {
279+
"description": "The URL the client should use to fetch the next page (per server side paging).",
280+
"type": "string"
281+
}
282+
}
283+
},
284+
"SenderUsernameProperties": {
285+
"description": "A class that describes the properties of a SenderUsername resource.",
286+
"type": "object",
287+
"required": [
288+
"username"
289+
],
290+
"properties": {
291+
"dataLocation": {
292+
"description": "The location where the SenderUsername resource data is stored at rest.",
293+
"type": "string",
294+
"readOnly": true
295+
},
296+
"username": {
297+
"description": "A sender senderUsername to be used when sending emails.",
298+
"type": "string"
299+
},
300+
"displayName": {
301+
"description": "The display name for the senderUsername.",
302+
"type": "string"
303+
},
304+
"provisioningState": {
305+
"description": "Provisioning state of the resource. Unknown is the default state for Communication Services.",
306+
"enum": [
307+
"Unknown",
308+
"Succeeded",
309+
"Failed",
310+
"Canceled",
311+
"Running",
312+
"Creating",
313+
"Updating",
314+
"Deleting",
315+
"Moving"
316+
],
317+
"type": "string",
318+
"readOnly": true,
319+
"x-ms-enum": {
320+
"name": "ProvisioningState",
321+
"modelAsString": true
322+
}
323+
}
324+
}
325+
}
326+
},
327+
"parameters": {
328+
"SenderUsername": {
329+
"name": "senderUsername",
330+
"in": "path",
331+
"description": "The valid sender Username.",
332+
"minLength": 1,
333+
"maxLength": 253,
334+
"required": true,
335+
"type": "string",
336+
"x-ms-parameter-location": "method"
337+
}
338+
}
339+
}

0 commit comments

Comments
 (0)