-
Notifications
You must be signed in to change notification settings - Fork 180
/
ManagedInstanceUpdate.yml
464 lines (450 loc) · 14.6 KB
/
ManagedInstanceUpdate.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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
### YamlMime:TSType
name: ManagedInstanceUpdate
uid: '@azure/arm-sql.ManagedInstanceUpdate'
package: '@azure/arm-sql'
summary: An update request for an Azure SQL Database managed instance.
fullName: ManagedInstanceUpdate
remarks: ''
isDeprecated: false
type: interface
properties:
- name: administratorLogin
uid: '@azure/arm-sql.ManagedInstanceUpdate.administratorLogin'
package: '@azure/arm-sql'
summary: >-
Administrator username for the managed instance. Can only be specified
when the managed instance is being created (and is required for creation).
fullName: administratorLogin
remarks: ''
isDeprecated: false
syntax:
content: 'administratorLogin?: string'
return:
description: ''
type: string
- name: administratorLoginPassword
uid: '@azure/arm-sql.ManagedInstanceUpdate.administratorLoginPassword'
package: '@azure/arm-sql'
summary: The administrator login password (required for managed instance creation).
fullName: administratorLoginPassword
remarks: ''
isDeprecated: false
syntax:
content: 'administratorLoginPassword?: string'
return:
description: ''
type: string
- name: administrators
uid: '@azure/arm-sql.ManagedInstanceUpdate.administrators'
package: '@azure/arm-sql'
summary: >-
The Azure Active Directory administrator of the instance. This can only be
used at instance create time. If used for instance update, it will be
ignored or it will result in an error. For updates individual APIs will
need to be used.
fullName: administrators
remarks: ''
isDeprecated: false
syntax:
content: 'administrators?: ManagedInstanceExternalAdministrator'
return:
description: ''
type: <xref uid="@azure/arm-sql.ManagedInstanceExternalAdministrator" />
- name: collation
uid: '@azure/arm-sql.ManagedInstanceUpdate.collation'
package: '@azure/arm-sql'
summary: Collation of the managed instance.
fullName: collation
remarks: ''
isDeprecated: false
syntax:
content: 'collation?: string'
return:
description: ''
type: string
- name: currentBackupStorageRedundancy
uid: '@azure/arm-sql.ManagedInstanceUpdate.currentBackupStorageRedundancy'
package: '@azure/arm-sql'
summary: >-
The storage account type used to store backups for this instance. The
options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage),
Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: currentBackupStorageRedundancy
remarks: ''
isDeprecated: false
syntax:
content: 'currentBackupStorageRedundancy?: string'
return:
description: ''
type: string
- name: dnsZone
uid: '@azure/arm-sql.ManagedInstanceUpdate.dnsZone'
package: '@azure/arm-sql'
summary: >-
The Dns Zone that the managed instance is in.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: dnsZone
remarks: ''
isDeprecated: false
syntax:
content: 'dnsZone?: string'
return:
description: ''
type: string
- name: dnsZonePartner
uid: '@azure/arm-sql.ManagedInstanceUpdate.dnsZonePartner'
package: '@azure/arm-sql'
summary: >-
The resource id of another managed instance whose DNS zone this managed
instance will share after creation.
fullName: dnsZonePartner
remarks: ''
isDeprecated: false
syntax:
content: 'dnsZonePartner?: string'
return:
description: ''
type: string
- name: fullyQualifiedDomainName
uid: '@azure/arm-sql.ManagedInstanceUpdate.fullyQualifiedDomainName'
package: '@azure/arm-sql'
summary: >-
The fully qualified domain name of the managed instance.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: fullyQualifiedDomainName
remarks: ''
isDeprecated: false
syntax:
content: 'fullyQualifiedDomainName?: string'
return:
description: ''
type: string
- name: identity
uid: '@azure/arm-sql.ManagedInstanceUpdate.identity'
package: '@azure/arm-sql'
summary: Managed instance identity
fullName: identity
remarks: ''
isDeprecated: false
syntax:
content: 'identity?: ResourceIdentity'
return:
description: ''
type: <xref uid="@azure/arm-sql.ResourceIdentity" />
- name: instancePoolId
uid: '@azure/arm-sql.ManagedInstanceUpdate.instancePoolId'
package: '@azure/arm-sql'
summary: The Id of the instance pool this managed server belongs to.
fullName: instancePoolId
remarks: ''
isDeprecated: false
syntax:
content: 'instancePoolId?: string'
return:
description: ''
type: string
- name: keyId
uid: '@azure/arm-sql.ManagedInstanceUpdate.keyId'
package: '@azure/arm-sql'
summary: A CMK URI of the key to use for encryption.
fullName: keyId
remarks: ''
isDeprecated: false
syntax:
content: 'keyId?: string'
return:
description: ''
type: string
- name: licenseType
uid: '@azure/arm-sql.ManagedInstanceUpdate.licenseType'
package: '@azure/arm-sql'
summary: >-
The license type. Possible values are 'LicenseIncluded' (regular price
inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for
bringing your own SQL licenses).
fullName: licenseType
remarks: ''
isDeprecated: false
syntax:
content: 'licenseType?: string'
return:
description: ''
type: string
- name: maintenanceConfigurationId
uid: '@azure/arm-sql.ManagedInstanceUpdate.maintenanceConfigurationId'
package: '@azure/arm-sql'
summary: Specifies maintenance configuration id to apply to this managed instance.
fullName: maintenanceConfigurationId
remarks: ''
isDeprecated: false
syntax:
content: 'maintenanceConfigurationId?: string'
return:
description: ''
type: string
- name: managedInstanceCreateMode
uid: '@azure/arm-sql.ManagedInstanceUpdate.managedInstanceCreateMode'
package: '@azure/arm-sql'
summary: >-
Specifies the mode of database creation.
Default: Regular instance creation.
Restore: Creates an instance by restoring a set of backups to specific
point in time. RestorePointInTime and SourceManagedInstanceId must be
specified.
fullName: managedInstanceCreateMode
remarks: ''
isDeprecated: false
syntax:
content: 'managedInstanceCreateMode?: string'
return:
description: ''
type: string
- name: minimalTlsVersion
uid: '@azure/arm-sql.ManagedInstanceUpdate.minimalTlsVersion'
package: '@azure/arm-sql'
summary: 'Minimal TLS version. Allowed values: ''None'', ''1.0'', ''1.1'', ''1.2'''
fullName: minimalTlsVersion
remarks: ''
isDeprecated: false
syntax:
content: 'minimalTlsVersion?: string'
return:
description: ''
type: string
- name: primaryUserAssignedIdentityId
uid: '@azure/arm-sql.ManagedInstanceUpdate.primaryUserAssignedIdentityId'
package: '@azure/arm-sql'
summary: The resource id of a user assigned identity to be used by default.
fullName: primaryUserAssignedIdentityId
remarks: ''
isDeprecated: false
syntax:
content: 'primaryUserAssignedIdentityId?: string'
return:
description: ''
type: string
- name: privateEndpointConnections
uid: '@azure/arm-sql.ManagedInstanceUpdate.privateEndpointConnections'
package: '@azure/arm-sql'
summary: >-
List of private endpoint connections on a managed instance.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: privateEndpointConnections
remarks: ''
isDeprecated: false
syntax:
content: 'privateEndpointConnections?: ManagedInstancePecProperty[]'
return:
description: ''
type: <xref uid="@azure/arm-sql.ManagedInstancePecProperty" />[]
- name: provisioningState
uid: '@azure/arm-sql.ManagedInstanceUpdate.provisioningState'
package: '@azure/arm-sql'
summary: >-
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: proxyOverride
uid: '@azure/arm-sql.ManagedInstanceUpdate.proxyOverride'
package: '@azure/arm-sql'
summary: Connection type used for connecting to the instance.
fullName: proxyOverride
remarks: ''
isDeprecated: false
syntax:
content: 'proxyOverride?: string'
return:
description: ''
type: string
- name: publicDataEndpointEnabled
uid: '@azure/arm-sql.ManagedInstanceUpdate.publicDataEndpointEnabled'
package: '@azure/arm-sql'
summary: Whether or not the public data endpoint is enabled.
fullName: publicDataEndpointEnabled
remarks: ''
isDeprecated: false
syntax:
content: 'publicDataEndpointEnabled?: boolean'
return:
description: ''
type: boolean
- name: requestedBackupStorageRedundancy
uid: '@azure/arm-sql.ManagedInstanceUpdate.requestedBackupStorageRedundancy'
package: '@azure/arm-sql'
summary: >-
The storage account type to be used to store backups for this instance.
The options are Local (LocallyRedundantStorage), Zone
(ZoneRedundantStorage), Geo (GeoRedundantStorage) and
GeoZone(GeoZoneRedundantStorage)
fullName: requestedBackupStorageRedundancy
remarks: ''
isDeprecated: false
syntax:
content: 'requestedBackupStorageRedundancy?: string'
return:
description: ''
type: string
- name: restorePointInTime
uid: '@azure/arm-sql.ManagedInstanceUpdate.restorePointInTime'
package: '@azure/arm-sql'
summary: >-
Specifies the point in time (ISO8601 format) of the source database that
will be restored to create the new database.
fullName: restorePointInTime
remarks: ''
isDeprecated: false
syntax:
content: 'restorePointInTime?: Date'
return:
description: ''
type: Date
- name: servicePrincipal
uid: '@azure/arm-sql.ManagedInstanceUpdate.servicePrincipal'
package: '@azure/arm-sql'
summary: The managed instance's service principal.
fullName: servicePrincipal
remarks: ''
isDeprecated: false
syntax:
content: 'servicePrincipal?: ServicePrincipal'
return:
description: ''
type: <xref uid="@azure/arm-sql.ServicePrincipal" />
- name: sku
uid: '@azure/arm-sql.ManagedInstanceUpdate.sku'
package: '@azure/arm-sql'
summary: Managed instance sku
fullName: sku
remarks: ''
isDeprecated: false
syntax:
content: 'sku?: Sku'
return:
description: ''
type: <xref uid="@azure/arm-sql.Sku" />
- name: sourceManagedInstanceId
uid: '@azure/arm-sql.ManagedInstanceUpdate.sourceManagedInstanceId'
package: '@azure/arm-sql'
summary: >-
The resource identifier of the source managed instance associated with
create operation of this instance.
fullName: sourceManagedInstanceId
remarks: ''
isDeprecated: false
syntax:
content: 'sourceManagedInstanceId?: string'
return:
description: ''
type: string
- name: state
uid: '@azure/arm-sql.ManagedInstanceUpdate.state'
package: '@azure/arm-sql'
summary: >-
The state of the managed instance.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: string'
return:
description: ''
type: string
- name: storageSizeInGB
uid: '@azure/arm-sql.ManagedInstanceUpdate.storageSizeInGB'
package: '@azure/arm-sql'
summary: >-
Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of
32 GB allowed only. Maximum value depends on the selected hardware family
and number of vCores.
fullName: storageSizeInGB
remarks: ''
isDeprecated: false
syntax:
content: 'storageSizeInGB?: number'
return:
description: ''
type: number
- name: subnetId
uid: '@azure/arm-sql.ManagedInstanceUpdate.subnetId'
package: '@azure/arm-sql'
summary: Subnet resource ID for the managed instance.
fullName: subnetId
remarks: ''
isDeprecated: false
syntax:
content: 'subnetId?: string'
return:
description: ''
type: string
- name: tags
uid: '@azure/arm-sql.ManagedInstanceUpdate.tags'
package: '@azure/arm-sql'
summary: Resource tags.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: timezoneId
uid: '@azure/arm-sql.ManagedInstanceUpdate.timezoneId'
package: '@azure/arm-sql'
summary: >-
Id of the timezone. Allowed values are timezones supported by Windows.
Windows keeps details on supported timezones, including the id, in
registry under
KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones.
You can get those registry values via SQL Server by querying SELECT name
AS timezone_id FROM sys.time_zone_info.
List of Ids can also be obtained by executing
[System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
An example of valid timezone id is "Pacific Standard Time" or "W. Europe
Standard Time".
fullName: timezoneId
remarks: ''
isDeprecated: false
syntax:
content: 'timezoneId?: string'
return:
description: ''
type: string
- name: vCores
uid: '@azure/arm-sql.ManagedInstanceUpdate.vCores'
package: '@azure/arm-sql'
summary: 'The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.'
fullName: vCores
remarks: ''
isDeprecated: false
syntax:
content: 'vCores?: number'
return:
description: ''
type: number
- name: zoneRedundant
uid: '@azure/arm-sql.ManagedInstanceUpdate.zoneRedundant'
package: '@azure/arm-sql'
summary: Whether or not the multi-az is enabled.
fullName: zoneRedundant
remarks: ''
isDeprecated: false
syntax:
content: 'zoneRedundant?: boolean'
return:
description: ''
type: boolean