@azure-tools/typespec-azure-resource-manager 0.38.0-dev.3 → 0.38.0-dev.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/lib.d.ts +1 -1
- package/dist/src/lib.d.ts.map +1 -1
- package/dist/src/testing/index.d.ts.map +1 -1
- package/dist/src/testing/index.js +4 -22
- package/dist/src/testing/index.js.map +1 -1
- package/dist/vitest.config.d.ts +3 -0
- package/dist/vitest.config.d.ts.map +1 -0
- package/dist/vitest.config.js +14 -0
- package/dist/vitest.config.js.map +1 -0
- package/lib/arm.foundations.tsp +63 -56
- package/lib/interfaces.tsp +192 -198
- package/lib/models.tsp +27 -26
- package/lib/operations.tsp +234 -233
- package/lib/parameters.tsp +20 -20
- package/lib/private-links.tsp +6 -6
- package/lib/private.decorators.tsp +3 -3
- package/lib/responses.tsp +20 -20
- package/package.json +6 -7
package/lib/operations.tsp
CHANGED
|
@@ -10,79 +10,80 @@ namespace Azure.ResourceManager;
|
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
12
|
* A resource list operation, at the subscription scope
|
|
13
|
-
* @template
|
|
13
|
+
* @template Resource the resource being patched
|
|
14
14
|
*/
|
|
15
15
|
@autoRoute
|
|
16
|
-
@doc("List {name} resources by subscription ID",
|
|
17
|
-
@listsResource(
|
|
18
|
-
@segmentOf(
|
|
19
|
-
@armResourceList(
|
|
16
|
+
@doc("List {name} resources by subscription ID", Resource)
|
|
17
|
+
@listsResource(Resource)
|
|
18
|
+
@segmentOf(Resource)
|
|
19
|
+
@armResourceList(Resource)
|
|
20
20
|
@get
|
|
21
|
-
op ArmListBySubscription<
|
|
22
|
-
...SubscriptionScope<
|
|
23
|
-
): ArmResponse<ResourceListResult<
|
|
21
|
+
op ArmListBySubscription<Resource extends ArmResource>(
|
|
22
|
+
...SubscriptionScope<Resource>,
|
|
23
|
+
): ArmResponse<ResourceListResult<Resource>> | ErrorResponse;
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* A resource list operation, at the scope of the resource's parent
|
|
27
|
-
* @template
|
|
28
|
-
* @template
|
|
29
|
-
* @template
|
|
30
|
-
* @template
|
|
27
|
+
* @template Resource the resource being patched
|
|
28
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
29
|
+
* @template ParentName Optional. The name of the parent resource
|
|
30
|
+
* @template ParentFriendlyName Optional. The friendly name of the parent resource
|
|
31
31
|
*/
|
|
32
32
|
@get
|
|
33
33
|
@autoRoute
|
|
34
|
-
@listsResource(
|
|
35
|
-
@segmentOf(
|
|
36
|
-
@armRenameListByOperation(
|
|
37
|
-
@armResourceList(
|
|
34
|
+
@listsResource(Resource)
|
|
35
|
+
@segmentOf(Resource)
|
|
36
|
+
@armRenameListByOperation(Resource, ParentName, ParentFriendlyName) // This must come before @armResourceList!
|
|
37
|
+
@armResourceList(Resource)
|
|
38
38
|
op ArmResourceListByParent<
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
39
|
+
Resource extends ArmResource,
|
|
40
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
41
|
+
ParentName extends valueof string = "",
|
|
42
|
+
ParentFriendlyName extends valueof string = ""
|
|
43
43
|
>(
|
|
44
|
-
...ResourceParentParameters<
|
|
45
|
-
): ArmResponse<ResourceListResult<
|
|
44
|
+
...ResourceParentParameters<Resource, BaseParameters>,
|
|
45
|
+
): ArmResponse<ResourceListResult<Resource>> | ErrorResponse;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* A resource list operation, with scope determined by
|
|
49
|
-
* @template
|
|
50
|
-
* @template
|
|
48
|
+
* A resource list operation, with scope determined by BaseParameters
|
|
49
|
+
* @template Resource the resource being patched
|
|
50
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
51
51
|
*/
|
|
52
52
|
@get
|
|
53
53
|
@autoRoute
|
|
54
|
-
@listsResource(
|
|
55
|
-
@segmentOf(
|
|
56
|
-
@armRenameListByOperation(
|
|
57
|
-
@armResourceList(
|
|
54
|
+
@listsResource(Resource)
|
|
55
|
+
@segmentOf(Resource)
|
|
56
|
+
@armRenameListByOperation(Resource) // This must come before @armResourceList!
|
|
57
|
+
@armResourceList(Resource)
|
|
58
58
|
op ArmResourceListAtScope<
|
|
59
|
-
|
|
60
|
-
|
|
59
|
+
Resource extends ArmResource,
|
|
60
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
61
61
|
>(
|
|
62
|
-
...ResourceParentParameters<
|
|
63
|
-
): ArmResponse<ResourceListResult<
|
|
62
|
+
...ResourceParentParameters<Resource, BaseParameters>,
|
|
63
|
+
): ArmResponse<ResourceListResult<Resource>> | ErrorResponse;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
66
|
* A resource GET operation
|
|
67
|
-
* @template
|
|
68
|
-
* @template
|
|
67
|
+
* @template Resource the resource being patched
|
|
68
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
69
69
|
*/
|
|
70
70
|
@autoRoute
|
|
71
|
-
@doc("Get a {name}",
|
|
71
|
+
@doc("Get a {name}", Resource)
|
|
72
72
|
@get
|
|
73
|
-
@armResourceRead(
|
|
74
|
-
op ArmResourceRead<
|
|
75
|
-
|
|
76
|
-
|
|
73
|
+
@armResourceRead(Resource)
|
|
74
|
+
op ArmResourceRead<
|
|
75
|
+
Resource extends ArmResourceBase,
|
|
76
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
77
|
+
>(...ResourceInstanceParameters<Resource, BaseParameters>): ArmResponse<Resource> | ErrorResponse;
|
|
77
78
|
|
|
78
79
|
/**
|
|
79
80
|
* A long-running resource CreateOrUpdate (PUT)
|
|
80
|
-
* @template
|
|
81
|
-
* @template
|
|
81
|
+
* @template Resource the resource being patched
|
|
82
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
82
83
|
* @template LroHeaders Optional. Allows overriding the lro headers returned on resource create
|
|
83
84
|
*/
|
|
84
85
|
@autoRoute
|
|
85
|
-
@doc("Create a {name}",
|
|
86
|
+
@doc("Create a {name}", Resource)
|
|
86
87
|
@extension("x-ms-long-running-operation", true)
|
|
87
88
|
@extension(
|
|
88
89
|
"x-ms-long-running-operation-options",
|
|
@@ -90,118 +91,118 @@ op ArmResourceRead<TResource extends ArmResourceBase, TBaseParameters = BasePara
|
|
|
90
91
|
`final-state-via`: "azure-async-operation",
|
|
91
92
|
}
|
|
92
93
|
)
|
|
93
|
-
@armResourceCreateOrUpdate(
|
|
94
|
+
@armResourceCreateOrUpdate(Resource)
|
|
94
95
|
@put
|
|
95
96
|
op ArmResourceCreateOrUpdateAsync<
|
|
96
|
-
|
|
97
|
-
|
|
97
|
+
Resource extends ArmResource,
|
|
98
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
98
99
|
LroHeaders extends TypeSpec.Reflection.Model = {}
|
|
99
100
|
>(
|
|
100
|
-
...ResourceInstanceParameters<
|
|
101
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
101
102
|
|
|
102
103
|
@doc("Resource create parameters.")
|
|
103
104
|
@body
|
|
104
|
-
resource:
|
|
105
|
-
): ArmResourceUpdatedResponse<
|
|
106
|
-
|
|
105
|
+
resource: Resource,
|
|
106
|
+
): ArmResourceUpdatedResponse<Resource> | ArmResourceCreatedResponse<
|
|
107
|
+
Resource,
|
|
107
108
|
LroHeaders
|
|
108
109
|
> | ErrorResponse;
|
|
109
110
|
|
|
110
111
|
/**
|
|
111
112
|
* DEPRECATED: Please use ArmResourceCreateOrReplaceSync instead
|
|
112
|
-
* @template
|
|
113
|
-
* @template
|
|
113
|
+
* @template Resource the resource being patched
|
|
114
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
114
115
|
*/
|
|
115
116
|
@autoRoute
|
|
116
|
-
@doc("Create a {name}",
|
|
117
|
-
@armResourceCreateOrUpdate(
|
|
117
|
+
@doc("Create a {name}", Resource)
|
|
118
|
+
@armResourceCreateOrUpdate(Resource)
|
|
118
119
|
@put
|
|
119
120
|
op ArmResourceCreateOrUpdateSync<
|
|
120
|
-
|
|
121
|
-
|
|
121
|
+
Resource extends ArmResource,
|
|
122
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
122
123
|
>(
|
|
123
|
-
...ResourceInstanceParameters<
|
|
124
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
124
125
|
|
|
125
126
|
@doc("Resource create parameters.")
|
|
126
127
|
@body
|
|
127
|
-
resource:
|
|
128
|
-
): ArmResponse<
|
|
128
|
+
resource: Resource,
|
|
129
|
+
): ArmResponse<Resource> | ErrorResponse;
|
|
129
130
|
|
|
130
131
|
/**
|
|
131
132
|
* Synchronous PUT operation for ARM resources
|
|
132
|
-
* @template
|
|
133
|
-
* @template
|
|
133
|
+
* @template Resource the resource being patched
|
|
134
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
134
135
|
*/
|
|
135
136
|
@autoRoute
|
|
136
|
-
@doc("Create a {name}",
|
|
137
|
-
@armResourceCreateOrUpdate(
|
|
137
|
+
@doc("Create a {name}", Resource)
|
|
138
|
+
@armResourceCreateOrUpdate(Resource)
|
|
138
139
|
@put
|
|
139
140
|
op ArmResourceCreateOrReplaceSync<
|
|
140
|
-
|
|
141
|
-
|
|
141
|
+
Resource extends ArmResource,
|
|
142
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
142
143
|
>(
|
|
143
|
-
...ResourceInstanceParameters<
|
|
144
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
144
145
|
|
|
145
146
|
@doc("Resource create parameters.")
|
|
146
147
|
@body
|
|
147
|
-
resource:
|
|
148
|
-
): ArmResourceUpdatedResponse<
|
|
148
|
+
resource: Resource,
|
|
149
|
+
): ArmResourceUpdatedResponse<Resource> | ArmResourceCreatedSyncResponse<Resource> | ErrorResponse;
|
|
149
150
|
|
|
150
151
|
op ArmResourceCreateOrReplaceAsync<
|
|
151
|
-
|
|
152
|
-
|
|
152
|
+
Resource extends ArmResource,
|
|
153
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
153
154
|
LroHeaders extends TypeSpec.Reflection.Model = {}
|
|
154
|
-
> is ArmResourceCreateOrUpdateAsync<
|
|
155
|
+
> is ArmResourceCreateOrUpdateAsync<Resource, BaseParameters, LroHeaders>;
|
|
155
156
|
|
|
156
157
|
/**
|
|
157
158
|
* @dev A long-running resource update that only allows updating resource tags (the minimum)
|
|
158
|
-
* @template
|
|
159
|
-
* @template
|
|
159
|
+
* @template Resource the resource being patched
|
|
160
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
160
161
|
* @template LroHeaders Optional. Allows overriding the lro headers that appear in the Accepted response
|
|
161
162
|
*/
|
|
162
163
|
op ArmTagsPatchAsync<
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
164
|
+
Resource extends ArmResource,
|
|
165
|
+
Properties extends {} = TagsUpdateModel<Resource>,
|
|
166
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
166
167
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
167
168
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
168
|
-
|
|
169
|
+
Resource,
|
|
169
170
|
string
|
|
170
171
|
>
|
|
171
|
-
> is ArmCustomPatchAsync<
|
|
172
|
+
> is ArmCustomPatchAsync<Resource, TagsUpdateModel<Resource>, BaseParameters, LroHeaders>;
|
|
172
173
|
|
|
173
174
|
/**
|
|
174
175
|
* @dev A long-running resource update using the items from the resource marked with visibility "update"
|
|
175
|
-
* @template
|
|
176
|
-
* @template
|
|
177
|
-
* @template
|
|
176
|
+
* @template Resource the resource being patched
|
|
177
|
+
* @template Properties The model type of the resource properties
|
|
178
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
178
179
|
* @template LroHeaders Optional. Allows overriding the lro headers returned in the Accepted response
|
|
179
180
|
*/
|
|
180
181
|
op ArmResourcePatchAsync<
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
182
|
+
Resource extends ArmResource,
|
|
183
|
+
Properties extends TypeSpec.Reflection.Model,
|
|
184
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
184
185
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
185
186
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
186
|
-
|
|
187
|
+
Resource,
|
|
187
188
|
string
|
|
188
189
|
>
|
|
189
190
|
> is ArmCustomPatchAsync<
|
|
190
|
-
|
|
191
|
-
ResourceUpdateModel<
|
|
192
|
-
|
|
191
|
+
Resource,
|
|
192
|
+
ResourceUpdateModel<Resource, Properties>,
|
|
193
|
+
BaseParameters,
|
|
193
194
|
LroHeaders
|
|
194
195
|
>;
|
|
195
196
|
|
|
196
197
|
/**
|
|
197
198
|
* A long-running resource update using a custom PATCH payload (Asynchronous)
|
|
198
|
-
* @template
|
|
199
|
-
* @template
|
|
200
|
-
* @template
|
|
199
|
+
* @template Resource the resource being patched
|
|
200
|
+
* @template PatchModel The input model for the PATCH request
|
|
201
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
201
202
|
* @template LroHeaders Optional. Allows overriding the lro headers returned in the Accepted response
|
|
202
203
|
*/
|
|
203
204
|
@autoRoute
|
|
204
|
-
@doc("Update a {name}",
|
|
205
|
+
@doc("Update a {name}", Resource)
|
|
205
206
|
@extension("x-ms-long-running-operation", true)
|
|
206
207
|
@extension(
|
|
207
208
|
"x-ms-long-running-operation-options",
|
|
@@ -209,80 +210,80 @@ op ArmResourcePatchAsync<
|
|
|
209
210
|
`final-state-via`: "location",
|
|
210
211
|
}
|
|
211
212
|
)
|
|
212
|
-
@armResourceUpdate(
|
|
213
|
+
@armResourceUpdate(Resource)
|
|
213
214
|
@patch
|
|
214
215
|
op ArmCustomPatchAsync<
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
216
|
+
Resource extends ArmResource,
|
|
217
|
+
PatchModel extends TypeSpec.Reflection.Model = TagsUpdateModel<Resource>,
|
|
218
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
218
219
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
219
220
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
220
|
-
|
|
221
|
+
Resource,
|
|
221
222
|
string
|
|
222
223
|
>
|
|
223
224
|
>(
|
|
224
|
-
...ResourceInstanceParameters<
|
|
225
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
225
226
|
|
|
226
227
|
@doc("The resource properties to be updated.")
|
|
227
228
|
@body
|
|
228
|
-
properties:
|
|
229
|
-
): ArmResponse<
|
|
229
|
+
properties: PatchModel,
|
|
230
|
+
): ArmResponse<Resource> | ArmAcceptedLroResponse<
|
|
230
231
|
"Resource update request accepted.",
|
|
231
232
|
LroHeaders
|
|
232
233
|
> | ErrorResponse;
|
|
233
234
|
|
|
234
235
|
/**
|
|
235
236
|
* @dev A resource update that only allows updating resource tags (the minimum)
|
|
236
|
-
* @template
|
|
237
|
-
* @template
|
|
237
|
+
* @template Resource the resource being patched
|
|
238
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
238
239
|
*/
|
|
239
240
|
op ArmTagsPatchSync<
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
> is ArmCustomPatchSync<
|
|
241
|
+
Resource extends ArmResource,
|
|
242
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
243
|
+
> is ArmCustomPatchSync<Resource, TagsUpdateModel<Resource>, BaseParameters>;
|
|
243
244
|
|
|
244
245
|
/**
|
|
245
246
|
* @dev A resource update using the items from the resource marked with visibility "update"
|
|
246
|
-
* @template
|
|
247
|
-
* @template
|
|
248
|
-
* @template
|
|
247
|
+
* @template Resource the resource being patched
|
|
248
|
+
* @template Properties The model type of the resource properties
|
|
249
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
249
250
|
*/
|
|
250
251
|
op ArmResourcePatchSync<
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
> is ArmCustomPatchSync<
|
|
252
|
+
Resource extends ArmResource,
|
|
253
|
+
Properties extends TypeSpec.Reflection.Model,
|
|
254
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
255
|
+
> is ArmCustomPatchSync<Resource, ResourceUpdateModel<Resource, Properties>, BaseParameters>;
|
|
255
256
|
|
|
256
257
|
/**
|
|
257
258
|
* A resource update using a custom PATCH payload (synchronous)
|
|
258
|
-
* @template
|
|
259
|
-
* @template
|
|
260
|
-
* @template
|
|
259
|
+
* @template Resource the resource being patched
|
|
260
|
+
* @template PatchModel The input model for the PATCH request
|
|
261
|
+
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
261
262
|
*/
|
|
262
263
|
@autoRoute
|
|
263
|
-
@doc("Update a {name}",
|
|
264
|
-
@armResourceUpdate(
|
|
264
|
+
@doc("Update a {name}", Resource)
|
|
265
|
+
@armResourceUpdate(Resource)
|
|
265
266
|
@patch
|
|
266
267
|
op ArmCustomPatchSync<
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
268
|
+
Resource extends ArmResource,
|
|
269
|
+
PatchModel extends TypeSpec.Reflection.Model = TagsUpdateModel<Resource>,
|
|
270
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
270
271
|
>(
|
|
271
|
-
...ResourceInstanceParameters<
|
|
272
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
272
273
|
|
|
273
274
|
@doc("The resource properties to be updated.")
|
|
274
275
|
@body
|
|
275
|
-
properties:
|
|
276
|
-
): ArmResponse<
|
|
276
|
+
properties: PatchModel,
|
|
277
|
+
): ArmResponse<Resource> | ErrorResponse;
|
|
277
278
|
|
|
278
279
|
/**
|
|
279
280
|
* @dev Delete a resource asynchronously
|
|
280
|
-
* @template
|
|
281
|
-
* @template
|
|
282
|
-
* @template
|
|
281
|
+
* @template Resource The resource being deleted
|
|
282
|
+
* @template Response The response type for the operation
|
|
283
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
283
284
|
*/
|
|
284
285
|
@autoRoute
|
|
285
|
-
@doc("Delete a {name}",
|
|
286
|
+
@doc("Delete a {name}", Resource)
|
|
286
287
|
@extension("x-ms-long-running-operation", true)
|
|
287
288
|
@extension(
|
|
288
289
|
"x-ms-long-running-operation-options",
|
|
@@ -290,68 +291,68 @@ op ArmCustomPatchSync<
|
|
|
290
291
|
`final-state-via`: "location",
|
|
291
292
|
}
|
|
292
293
|
)
|
|
293
|
-
@armResourceDelete(
|
|
294
|
+
@armResourceDelete(Resource)
|
|
294
295
|
@delete
|
|
295
296
|
op ArmResourceDeleteAsyncBase<
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
>(...ResourceInstanceParameters<
|
|
297
|
+
Resource extends ArmResource,
|
|
298
|
+
Response,
|
|
299
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
300
|
+
>(...ResourceInstanceParameters<Resource, BaseParameters>): Response | ErrorResponse;
|
|
300
301
|
|
|
301
302
|
/**
|
|
302
303
|
* @dev Delete a resource asynchronously. DEPRECATED: Use ArmResourceDeleteWithoutOkAsync instead
|
|
303
|
-
* @template
|
|
304
|
-
* @template
|
|
304
|
+
* @template Resource The resource being deleted
|
|
305
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
305
306
|
* @template LroHeaders Optional. Allows overriding the headers in the Accepted response
|
|
306
307
|
*/
|
|
307
308
|
op ArmResourceDeleteAsync<
|
|
308
|
-
|
|
309
|
-
|
|
309
|
+
Resource extends ArmResource,
|
|
310
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
310
311
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader
|
|
311
312
|
> is ArmResourceDeleteAsyncBase<
|
|
312
|
-
|
|
313
|
+
Resource,
|
|
313
314
|
ArmDeletedResponse | ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
314
|
-
|
|
315
|
+
BaseParameters
|
|
315
316
|
>;
|
|
316
317
|
|
|
317
318
|
/**
|
|
318
319
|
* @dev Delete a resource asynchronously
|
|
319
|
-
* @template
|
|
320
|
-
* @template
|
|
320
|
+
* @template Resource The resource being deleted
|
|
321
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
321
322
|
* @template LroHeaders Optional. Allows overriding the headers returned in the Accepted response
|
|
322
323
|
*/
|
|
323
324
|
op ArmResourceDeleteWithoutOkAsync<
|
|
324
|
-
|
|
325
|
-
|
|
325
|
+
Resource extends ArmResource,
|
|
326
|
+
BaseParameters = DefaultBaseParameters<Resource>,
|
|
326
327
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader
|
|
327
328
|
> is ArmResourceDeleteAsyncBase<
|
|
328
|
-
|
|
329
|
+
Resource,
|
|
329
330
|
ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
330
|
-
|
|
331
|
+
BaseParameters
|
|
331
332
|
>;
|
|
332
333
|
|
|
333
334
|
/**
|
|
334
335
|
* Delete a resource synchronously
|
|
335
|
-
* @template
|
|
336
|
-
* @template
|
|
336
|
+
* @template Resource The resource being deleted
|
|
337
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
337
338
|
*/
|
|
338
339
|
@autoRoute
|
|
339
|
-
@doc("Delete a {name}",
|
|
340
|
-
@armResourceDelete(
|
|
340
|
+
@doc("Delete a {name}", Resource)
|
|
341
|
+
@armResourceDelete(Resource)
|
|
341
342
|
@delete
|
|
342
343
|
op ArmResourceDeleteSync<
|
|
343
|
-
|
|
344
|
-
|
|
344
|
+
Resource extends ArmResource,
|
|
345
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
345
346
|
>(
|
|
346
|
-
...ResourceInstanceParameters<
|
|
347
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
347
348
|
): ArmDeletedResponse | ArmDeletedNoContentResponse | ErrorResponse;
|
|
348
349
|
|
|
349
350
|
/**
|
|
350
351
|
* A long-running resource action.
|
|
351
|
-
* @template
|
|
352
|
-
* @template
|
|
353
|
-
* @template
|
|
354
|
-
* @template
|
|
352
|
+
* @template Resource The resource being acted upon
|
|
353
|
+
* @template Request The request model for the action
|
|
354
|
+
* @template Response The response type for the action
|
|
355
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
355
356
|
*/
|
|
356
357
|
@autoRoute
|
|
357
358
|
@extension("x-ms-long-running-operation", true)
|
|
@@ -361,175 +362,175 @@ op ArmResourceDeleteSync<
|
|
|
361
362
|
`final-state-via`: "location",
|
|
362
363
|
}
|
|
363
364
|
)
|
|
364
|
-
@armResourceAction(
|
|
365
|
+
@armResourceAction(Resource)
|
|
365
366
|
@post
|
|
366
367
|
op ArmResourceActionAsyncBase<
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
368
|
+
Resource extends ArmResource,
|
|
369
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
370
|
+
Response extends TypeSpec.Reflection.Model | void,
|
|
371
|
+
BaseParameters extends TypeSpec.Reflection.Model
|
|
371
372
|
>(
|
|
372
|
-
...ResourceInstanceParameters<
|
|
373
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
373
374
|
|
|
374
375
|
@doc("The content of the action request")
|
|
375
376
|
@body
|
|
376
|
-
body:
|
|
377
|
-
):
|
|
377
|
+
body: Request,
|
|
378
|
+
): Response | ErrorResponse;
|
|
378
379
|
|
|
379
380
|
/**
|
|
380
381
|
* @dev A long-running resource action.
|
|
381
|
-
* @template
|
|
382
|
-
* @template
|
|
383
|
-
* @template
|
|
384
|
-
* @template
|
|
382
|
+
* @template Resource The resource being acted upon
|
|
383
|
+
* @template Request The request model for the action
|
|
384
|
+
* @template Response The response model for the action
|
|
385
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
385
386
|
* @template LroHeaders Optional. Allows overriding the headers returned in the Accepted response
|
|
386
387
|
*/
|
|
387
388
|
@returnsDoc("ARM operation completed successfully.")
|
|
388
389
|
op ArmResourceActionAsync<
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
390
|
+
Resource extends ArmResource,
|
|
391
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
392
|
+
Response extends TypeSpec.Reflection.Model | void,
|
|
393
|
+
BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
|
|
393
394
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
394
395
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
395
|
-
|
|
396
|
+
Response,
|
|
396
397
|
string
|
|
397
398
|
>
|
|
398
399
|
> is ArmResourceActionAsyncBase<
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
ArmAcceptedLroResponse<"Resource operation accepted.", LroHeaders> |
|
|
402
|
-
|
|
400
|
+
Resource,
|
|
401
|
+
Request,
|
|
402
|
+
ArmAcceptedLroResponse<"Resource operation accepted.", LroHeaders> | Response,
|
|
403
|
+
BaseParameters
|
|
403
404
|
>;
|
|
404
405
|
|
|
405
406
|
/**
|
|
406
407
|
* A synchronous resource action.
|
|
407
|
-
* @template
|
|
408
|
-
* @template
|
|
409
|
-
* @template
|
|
410
|
-
* @template
|
|
408
|
+
* @template Resource The resource being acted upon
|
|
409
|
+
* @template Request The request model for the action
|
|
410
|
+
* @template Response The response model for the action
|
|
411
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
411
412
|
*/
|
|
412
413
|
@autoRoute
|
|
413
|
-
@armResourceAction(
|
|
414
|
+
@armResourceAction(Resource)
|
|
414
415
|
@post
|
|
415
416
|
@returnsDoc("ARM operation completed successfully.")
|
|
416
417
|
op ArmResourceActionSync<
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
418
|
+
Resource extends ArmResource,
|
|
419
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
420
|
+
Response extends TypeSpec.Reflection.Model | void,
|
|
421
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
421
422
|
>(
|
|
422
|
-
...ResourceInstanceParameters<
|
|
423
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
423
424
|
|
|
424
425
|
@doc("The content of the action request")
|
|
425
426
|
@body
|
|
426
|
-
body:
|
|
427
|
-
):
|
|
427
|
+
body: Request,
|
|
428
|
+
): Response | ErrorResponse;
|
|
428
429
|
|
|
429
430
|
/**
|
|
430
431
|
* @dev A long-running resource action that returns no content. DEPRECATED: Use 'ArmResourceActionNoResponseContentAsync' instead
|
|
431
|
-
* @template
|
|
432
|
-
* @template
|
|
433
|
-
* @template
|
|
432
|
+
* @template Resource The resource being acted upon
|
|
433
|
+
* @template Request The request model for the action
|
|
434
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
434
435
|
* @template LroHeaders Optional. Allows overriding the headers returned in the Accepted response
|
|
435
436
|
*
|
|
436
437
|
*/
|
|
437
438
|
op ArmResourceActionNoContentAsync<
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
439
|
+
Resource extends ArmResource,
|
|
440
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
441
|
+
BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
|
|
441
442
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
442
443
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
443
444
|
void,
|
|
444
445
|
string
|
|
445
446
|
>
|
|
446
447
|
> is ArmResourceActionAsyncBase<
|
|
447
|
-
|
|
448
|
-
|
|
448
|
+
Resource,
|
|
449
|
+
Request,
|
|
449
450
|
ArmAcceptedLroResponse | ArmNoContentResponse<"Action completed successfully.">,
|
|
450
|
-
|
|
451
|
+
BaseParameters
|
|
451
452
|
>;
|
|
452
453
|
|
|
453
454
|
/**
|
|
454
455
|
* @dev A long-running resource action that returns no content.
|
|
455
|
-
* @template
|
|
456
|
-
* @template
|
|
457
|
-
* @template
|
|
456
|
+
* @template Resource The resource being acted upon
|
|
457
|
+
* @template Request The request model for the action
|
|
458
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
458
459
|
* @template Headers Optional. Allows overriding the headers returned in the Accepted response
|
|
459
460
|
*/
|
|
460
461
|
op ArmResourceActionNoResponseContentAsync<
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
462
|
+
Resource extends ArmResource,
|
|
463
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
464
|
+
BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
|
|
464
465
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
|
|
465
466
|
Azure.Core.StatusMonitorPollingOptions<ArmOperationStatus>,
|
|
466
467
|
void,
|
|
467
468
|
string
|
|
468
469
|
>
|
|
469
470
|
> is ArmResourceActionAsyncBase<
|
|
470
|
-
|
|
471
|
-
|
|
471
|
+
Resource,
|
|
472
|
+
Request,
|
|
472
473
|
ArmAcceptedLroResponse<"Resource operation accepted.", LroHeaders>,
|
|
473
|
-
|
|
474
|
+
BaseParameters
|
|
474
475
|
>;
|
|
475
476
|
|
|
476
477
|
/**
|
|
477
478
|
* A synchronous resource action that returns no content.
|
|
478
|
-
* @template
|
|
479
|
-
* @template
|
|
480
|
-
* @template
|
|
479
|
+
* @template Resource The resource being acted upon
|
|
480
|
+
* @template Request The request model for the action
|
|
481
|
+
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
481
482
|
*/
|
|
482
483
|
@autoRoute
|
|
483
|
-
@armResourceAction(
|
|
484
|
+
@armResourceAction(Resource)
|
|
484
485
|
@post
|
|
485
486
|
op ArmResourceActionNoContentSync<
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
487
|
+
Resource extends ArmResource,
|
|
488
|
+
Request extends TypeSpec.Reflection.Model | void,
|
|
489
|
+
BaseParameters = DefaultBaseParameters<Resource>
|
|
489
490
|
>(
|
|
490
|
-
...ResourceInstanceParameters<
|
|
491
|
+
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
491
492
|
|
|
492
493
|
@doc("The content of the action request")
|
|
493
494
|
@body
|
|
494
|
-
body:
|
|
495
|
+
body: Request,
|
|
495
496
|
): ArmNoContentResponse<"Action completed successfully."> | ErrorResponse;
|
|
496
497
|
|
|
497
498
|
/**
|
|
498
499
|
* @dev Adds check global name availability operation, normally used if
|
|
499
500
|
* a resource name must be globally unique (for example, if the resource
|
|
500
501
|
* exposes and endpoint that uses the resource name in the url)
|
|
501
|
-
* @template
|
|
502
|
-
* @template
|
|
503
|
-
* @template
|
|
502
|
+
* @template Request the availability request, defaults to the standard request, containing name and resource type
|
|
503
|
+
* @template Response the availability response, default to the standard response
|
|
504
|
+
* @template AdditionalParams A model specifying additional non-path parameters to the availability request
|
|
504
505
|
*/
|
|
505
506
|
@doc("Implements global CheckNameAvailability operations")
|
|
506
507
|
op checkGlobalNameAvailability<
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
508
|
+
Request extends TypeSpec.Reflection.Model = Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest,
|
|
509
|
+
Response extends TypeSpec.Reflection.Model = CheckNameAvailabilityResponse,
|
|
510
|
+
AdditionalParams extends TypeSpec.Reflection.Model = {}
|
|
510
511
|
> is checkNameAvailability<
|
|
511
512
|
SubscriptionIdParameter & DefaultProviderNamespace,
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
513
|
+
Request,
|
|
514
|
+
Response,
|
|
515
|
+
AdditionalParams
|
|
515
516
|
>;
|
|
516
517
|
|
|
517
518
|
/**
|
|
518
519
|
* @dev Adds check location-specific name availability operation, normally used if
|
|
519
520
|
* a resource name must be globally unique (for example, if the resource
|
|
520
521
|
* exposes and endpoint that uses the resource name in the url)
|
|
521
|
-
* @template
|
|
522
|
-
* @template
|
|
523
|
-
* @template
|
|
522
|
+
* @template Request the availability request, defaults to the standard request, containing name and resource type
|
|
523
|
+
* @template Response the availability response, default to the standard response
|
|
524
|
+
* @template AdditionalParams A model specifying additional non-path parameters to the availability request
|
|
524
525
|
*/
|
|
525
526
|
@doc("Implements local CheckNameAvailability operations")
|
|
526
527
|
op checkLocalNameAvailability<
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
528
|
+
Request extends TypeSpec.Reflection.Model = Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest,
|
|
529
|
+
Response extends TypeSpec.Reflection.Model = CheckNameAvailabilityResponse,
|
|
530
|
+
AdditionalParams extends TypeSpec.Reflection.Model = {}
|
|
530
531
|
> is checkNameAvailability<
|
|
531
532
|
SubscriptionIdParameter & DefaultProviderNamespace & LocationParameter,
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
533
|
+
Request,
|
|
534
|
+
Response,
|
|
535
|
+
AdditionalParams
|
|
535
536
|
>;
|