-
Notifications
You must be signed in to change notification settings - Fork 180
/
OperationsManagementClientContext.yml
347 lines (337 loc) · 12.8 KB
/
OperationsManagementClientContext.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
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
### YamlMime:TSType
name: OperationsManagementClientContext
uid: '@azure/arm-operations.OperationsManagementClientContext'
package: '@azure/arm-operations'
summary: ''
fullName: OperationsManagementClientContext
remarks: ''
isDeprecated: false
type: class
constructors:
- name: >-
OperationsManagementClientContext(ServiceClientCredentials |
TokenCredential, string, string, string, string,
OperationsManagementClientOptions)
uid: '@azure/arm-operations.OperationsManagementClientContext.constructor'
package: '@azure/arm-operations'
summary: Initializes a new instance of the OperationsManagementClient class.
remarks: ''
isDeprecated: false
syntax:
content: >-
new OperationsManagementClientContext(credentials:
ServiceClientCredentials | TokenCredential, subscriptionId: string,
providerName: string, resourceType: string, resourceName: string,
options?: OperationsManagementClientOptions)
parameters:
- id: credentials
type: >-
<xref uid="@azure/ms-rest-js.ServiceClientCredentials" /> | <xref
uid="@azure/core-auth.TokenCredential" />
description: >-
Credentials needed for the client to connect to Azure. Credentials
implementing the TokenCredential interface from the @azure/identity
package are recommended. For
more information about these credentials, see
https://www.npmjs.com/package/@azure/identity. Credentials
implementing the
ServiceClientCredentials interface from the older packages
@azure/ms-rest-nodeauth and
@azure/ms-rest-browserauth are also supported.
- id: subscriptionId
type: string
description: >-
Gets subscription credentials which uniquely identify Microsoft
Azure
subscription. The subscription ID forms part of the URI for every
service call.
- id: providerName
type: string
description: Provider name for the parent resource.
- id: resourceType
type: string
description: Resource type for the parent resource
- id: resourceName
type: string
description: Parent resource name.
- id: options
type: >-
<xref
uid="@azure/arm-operations.OperationsManagementModels.OperationsManagementClientOptions"
/>
description: The parameter options
properties:
- name: apiVersion
uid: '@azure/arm-operations.OperationsManagementClientContext.apiVersion'
package: '@azure/arm-operations'
summary: ''
fullName: apiVersion
remarks: ''
isDeprecated: false
syntax:
content: 'apiVersion?: string'
return:
description: ''
type: string
- name: credentials
uid: '@azure/arm-operations.OperationsManagementClientContext.credentials'
package: '@azure/arm-operations'
summary: ''
fullName: credentials
remarks: ''
isDeprecated: false
syntax:
content: 'credentials: ServiceClientCredentials | TokenCredential'
return:
description: ''
type: >-
<xref uid="@azure/ms-rest-js.ServiceClientCredentials" /> | <xref
uid="@azure/core-auth.TokenCredential" />
- name: providerName
uid: '@azure/arm-operations.OperationsManagementClientContext.providerName'
package: '@azure/arm-operations'
summary: ''
fullName: providerName
remarks: ''
isDeprecated: false
syntax:
content: 'providerName: string'
return:
description: ''
type: string
- name: resourceName
uid: '@azure/arm-operations.OperationsManagementClientContext.resourceName'
package: '@azure/arm-operations'
summary: ''
fullName: resourceName
remarks: ''
isDeprecated: false
syntax:
content: 'resourceName: string'
return:
description: ''
type: string
- name: resourceType
uid: '@azure/arm-operations.OperationsManagementClientContext.resourceType'
package: '@azure/arm-operations'
summary: ''
fullName: resourceType
remarks: ''
isDeprecated: false
syntax:
content: 'resourceType: string'
return:
description: ''
type: string
- name: subscriptionId
uid: '@azure/arm-operations.OperationsManagementClientContext.subscriptionId'
package: '@azure/arm-operations'
summary: ''
fullName: subscriptionId
remarks: ''
isDeprecated: false
syntax:
content: 'subscriptionId: string'
return:
description: ''
type: string
inheritedProperties:
- name: acceptLanguage
uid: '@azure/arm-operations.OperationsManagementClientContext.acceptLanguage'
package: '@azure/arm-operations'
summary: ''
fullName: acceptLanguage
remarks: ''
isDeprecated: false
syntax:
content: 'acceptLanguage: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.acceptLanguage
- name: longRunningOperationRetryTimeout
uid: >-
@azure/arm-operations.OperationsManagementClientContext.longRunningOperationRetryTimeout
package: '@azure/arm-operations'
summary: >-
The retry timeout in seconds for Long Running Operations. Default value is
30.
fullName: longRunningOperationRetryTimeout
remarks: ''
isDeprecated: false
syntax:
content: 'longRunningOperationRetryTimeout?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
msRestAzure.AzureServiceClient.longRunningOperationRetryTimeout
inheritedMethods:
- name: >-
beginLongRunningRequest(RequestPrepareOptions | WebResource,
RequestOptionsBase)
uid: >-
@azure/arm-operations.OperationsManagementClientContext.beginLongRunningRequest
package: '@azure/arm-operations'
summary: >-
Send the initial request of a LRO (long running operation) and get back an
HttpLongRunningOperationResponse that provides methods for polling the LRO
and checking if the
LRO is finished.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginLongRunningRequest(request: RequestPrepareOptions |
WebResource, options?: RequestOptionsBase): Promise<LROPoller>
parameters:
- id: request
type: >-
<xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
uid="@azure/ms-rest-js.WebResource" />
description: The request object
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: Additional options to be sent while making the request
return:
description: |-
The HttpLongRunningOperationResponse
that provides methods for interacting with the LRO.
type: Promise<<xref uid="@azure/ms-rest-azure-js.LROPoller" />>
inheritanceDescription: >-
<b>Inherited From</b>
msRestAzure.AzureServiceClient.beginLongRunningRequest
- name: restoreLROPoller(LROPollState)
uid: '@azure/arm-operations.OperationsManagementClientContext.restoreLROPoller'
package: '@azure/arm-operations'
summary: >-
Restore an LROPoller from the provided LROPollState. This method can be
used to recreate an
LROPoller on a different process or machine.
remarks: ''
isDeprecated: false
syntax:
content: 'function restoreLROPoller(lroPollState: LROPollState): LROPoller'
parameters:
- id: lroPollState
type: <xref uid="@azure/ms-rest-azure-js.LROPollState" />
description: ''
return:
description: ''
type: <xref uid="@azure/ms-rest-azure-js.LROPoller" />
inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.restoreLROPoller
- name: >-
sendLongRunningRequest(RequestPrepareOptions | WebResource,
RequestOptionsBase)
uid: >-
@azure/arm-operations.OperationsManagementClientContext.sendLongRunningRequest
package: '@azure/arm-operations'
summary: >-
Provides a mechanism to make a request that will poll and provide the
final result.
remarks: ''
isDeprecated: false
syntax:
content: >-
function sendLongRunningRequest(request: RequestPrepareOptions |
WebResource, options?: RequestOptionsBase):
Promise<HttpOperationResponse>
parameters:
- id: request
type: >-
<xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
uid="@azure/ms-rest-js.WebResource" />
description: The request object
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: Additional options to be sent while making the request
return:
description: >-
The HttpOperationResponse containing the final polling request,
response and the responseBody.
type: Promise<<xref uid="@azure/ms-rest-js.HttpOperationResponse" />>
inheritanceDescription: >-
<b>Inherited From</b>
msRestAzure.AzureServiceClient.sendLongRunningRequest
- name: sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
uid: '@azure/arm-operations.OperationsManagementClientContext.sendLRORequest'
package: '@azure/arm-operations'
summary: >-
Send the initial request of a LRO (long running operation) and get back an
LROPoller that provides methods for polling the LRO and checking if the
LRO is finished.
remarks: ''
isDeprecated: false
syntax:
content: >-
function sendLRORequest(operationArguments: OperationArguments,
operationSpec: OperationSpec, options?: RequestOptionsBase):
Promise<LROPoller>
parameters:
- id: operationArguments
type: <xref uid="@azure/ms-rest-js.OperationArguments" />
description: The arguments to the operation.
- id: operationSpec
type: <xref uid="@azure/ms-rest-js.OperationSpec" />
description: The specification for the operation.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: Additional options to be sent while making the request.
return:
description: >-
The LROPoller object that provides methods for interacting with the
LRO.
type: Promise<<xref uid="@azure/ms-rest-azure-js.LROPoller" />>
inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendLRORequest
- name: >-
sendOperationRequest(OperationArguments, OperationSpec,
ServiceCallback<any>)
uid: >-
@azure/arm-operations.OperationsManagementClientContext.sendOperationRequest
package: '@azure/arm-operations'
summary: Send an HTTP request that is populated using the provided OperationSpec.
remarks: ''
isDeprecated: false
syntax:
content: >-
function sendOperationRequest(operationArguments: OperationArguments,
operationSpec: OperationSpec, callback?: ServiceCallback<any>):
Promise<RestResponse>
parameters:
- id: operationArguments
type: <xref uid="@azure/ms-rest-js.OperationArguments" />
description: >-
The arguments that the HTTP request's templated values will be
populated from.
- id: operationSpec
type: <xref uid="@azure/ms-rest-js.OperationSpec" />
description: The OperationSpec to use to populate the httpRequest.
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><any>
description: The callback to call when the response is received.
return:
description: ''
type: Promise<<xref uid="@azure/ms-rest-js.RestResponse" />>
inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendOperationRequest
- name: sendRequest(RequestPrepareOptions | WebResourceLike)
uid: '@azure/arm-operations.OperationsManagementClientContext.sendRequest'
package: '@azure/arm-operations'
summary: Send the provided httpRequest.
remarks: ''
isDeprecated: false
syntax:
content: >-
function sendRequest(options: RequestPrepareOptions | WebResourceLike):
Promise<HttpOperationResponse>
parameters:
- id: options
type: >-
<xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
uid="@azure/ms-rest-js.WebResourceLike" />
description: ''
return:
description: ''
type: Promise<<xref uid="@azure/ms-rest-js.HttpOperationResponse" />>
inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendRequest
extends: <xref uid="@azure/ms-rest-azure-js.AzureServiceClient" />