@azure/arm-databasewatcher 1.0.0-alpha.20250619.1 → 1.0.0-alpha.20250718.1

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.
@@ -1,357 +1,357 @@
1
- ## API Report File for "@azure/arm-databasewatcher"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- // @public
8
- export type ActionType = string;
9
-
10
- // @public
11
- export type AlertRuleCreationProperties = string;
12
-
13
- // @public
14
- export interface AlertRuleResource extends ProxyResource {
15
- properties?: AlertRuleResourceProperties;
16
- }
17
-
18
- // @public
19
- export interface AlertRuleResourceProperties {
20
- alertRuleResourceId: string;
21
- alertRuleTemplateId: string;
22
- alertRuleTemplateVersion: string;
23
- createdWithProperties: AlertRuleCreationProperties;
24
- creationTime: Date;
25
- readonly provisioningState?: ResourceProvisioningState;
26
- }
27
-
28
- // @public
29
- export type CreatedByType = string;
30
-
31
- // @public
32
- export type DatabaseWatcherProvisioningState = string;
33
-
34
- // @public
35
- export interface Datastore {
36
- adxClusterResourceId?: string;
37
- kustoClusterDisplayName?: string;
38
- kustoClusterUri: string;
39
- kustoDatabaseName: string;
40
- kustoDataIngestionUri: string;
41
- kustoManagementUrl: string;
42
- kustoOfferingType: KustoOfferingType;
43
- }
44
-
45
- // @public
46
- export interface ErrorAdditionalInfo {
47
- readonly info?: Record<string, any>;
48
- readonly type?: string;
49
- }
50
-
51
- // @public
52
- export interface ErrorDetail {
53
- readonly additionalInfo?: ErrorAdditionalInfo[];
54
- readonly code?: string;
55
- readonly details?: ErrorDetail[];
56
- readonly message?: string;
57
- readonly target?: string;
58
- }
59
-
60
- // @public
61
- export interface ErrorResponse {
62
- error?: ErrorDetail;
63
- }
64
-
65
- // @public
66
- export interface HealthValidation extends ProxyResource {
67
- properties?: HealthValidationProperties;
68
- }
69
-
70
- // @public
71
- export interface HealthValidationProperties {
72
- readonly endTime: Date;
73
- readonly issues: ValidationIssue[];
74
- readonly provisioningState?: ResourceProvisioningState;
75
- readonly startTime: Date;
76
- readonly status: ValidationStatus;
77
- }
78
-
79
- // @public
80
- export enum KnownActionType {
81
- Internal = "Internal"
82
- }
83
-
84
- // @public
85
- export enum KnownAlertRuleCreationProperties {
86
- CreatedWithActionGroup = "CreatedWithActionGroup",
87
- None = "None"
88
- }
89
-
90
- // @public
91
- export enum KnownCreatedByType {
92
- Application = "Application",
93
- Key = "Key",
94
- ManagedIdentity = "ManagedIdentity",
95
- User = "User"
96
- }
97
-
98
- // @public
99
- export enum KnownDatabaseWatcherProvisioningState {
100
- Canceled = "Canceled",
101
- Failed = "Failed",
102
- Succeeded = "Succeeded"
103
- }
104
-
105
- // @public
106
- export enum KnownKustoOfferingType {
107
- Adx = "adx",
108
- Fabric = "fabric",
109
- Free = "free"
110
- }
111
-
112
- // @public
113
- export enum KnownManagedServiceIdentityType {
114
- None = "None",
115
- SystemAndUserAssigned = "SystemAssigned, UserAssigned",
116
- SystemAssigned = "SystemAssigned",
117
- UserAssigned = "UserAssigned"
118
- }
119
-
120
- // @public
121
- export enum KnownOrigin {
122
- System = "system",
123
- User = "user",
124
- UserSystem = "user,system"
125
- }
126
-
127
- // @public
128
- export enum KnownResourceProvisioningState {
129
- Canceled = "Canceled",
130
- Failed = "Failed",
131
- Succeeded = "Succeeded"
132
- }
133
-
134
- // @public
135
- export enum KnownSharedPrivateLinkResourceStatus {
136
- Approved = "Approved",
137
- Disconnected = "Disconnected",
138
- Pending = "Pending",
139
- Rejected = "Rejected"
140
- }
141
-
142
- // @public
143
- export enum KnownTargetAuthenticationType {
144
- Aad = "Aad",
145
- Sql = "Sql"
146
- }
147
-
148
- // @public
149
- export enum KnownValidationStatus {
150
- Canceled = "Canceled",
151
- Failed = "Failed",
152
- NotStarted = "NotStarted",
153
- Running = "Running",
154
- Succeeded = "Succeeded",
155
- TimedOut = "TimedOut"
156
- }
157
-
158
- // @public
159
- export enum KnownVersions {
160
- V20250102 = "2025-01-02"
161
- }
162
-
163
- // @public
164
- export enum KnownWatcherStatus {
165
- Deleting = "Deleting",
166
- Running = "Running",
167
- Starting = "Starting",
168
- Stopped = "Stopped",
169
- Stopping = "Stopping"
170
- }
171
-
172
- // @public
173
- export type KustoOfferingType = string;
174
-
175
- // @public
176
- export type ManagedServiceIdentityType = string;
177
-
178
- // @public
179
- export interface ManagedServiceIdentityV4 {
180
- readonly principalId?: string;
181
- readonly tenantId?: string;
182
- type: ManagedServiceIdentityType;
183
- userAssignedIdentities?: Record<string, UserAssignedIdentity>;
184
- }
185
-
186
- // @public
187
- export interface Operation {
188
- readonly actionType?: ActionType;
189
- display?: OperationDisplay;
190
- readonly isDataAction?: boolean;
191
- readonly name?: string;
192
- readonly origin?: Origin;
193
- }
194
-
195
- // @public
196
- export interface OperationDisplay {
197
- readonly description?: string;
198
- readonly operation?: string;
199
- readonly provider?: string;
200
- readonly resource?: string;
201
- }
202
-
203
- // @public
204
- export type Origin = string;
205
-
206
- // @public
207
- export interface ProxyResource extends Resource {
208
- }
209
-
210
- // @public
211
- export interface Resource {
212
- readonly id?: string;
213
- readonly name?: string;
214
- readonly systemData?: SystemData;
215
- readonly type?: string;
216
- }
217
-
218
- // @public
219
- export type ResourceProvisioningState = string;
220
-
221
- // @public
222
- export interface SharedPrivateLinkResource extends ProxyResource {
223
- properties?: SharedPrivateLinkResourceProperties;
224
- }
225
-
226
- // @public
227
- export interface SharedPrivateLinkResourceProperties {
228
- dnsZone?: string;
229
- groupId: string;
230
- privateLinkResourceId: string;
231
- readonly provisioningState?: ResourceProvisioningState;
232
- requestMessage: string;
233
- readonly status?: SharedPrivateLinkResourceStatus;
234
- }
235
-
236
- // @public
237
- export type SharedPrivateLinkResourceStatus = string;
238
-
239
- // @public
240
- export interface SqlDbElasticPoolTargetProperties extends TargetProperties {
241
- anchorDatabaseResourceId: string;
242
- readIntent?: boolean;
243
- sqlEpResourceId: string;
244
- targetType: "SqlEp";
245
- }
246
-
247
- // @public
248
- export interface SqlDbSingleDatabaseTargetProperties extends TargetProperties {
249
- readIntent?: boolean;
250
- sqlDbResourceId: string;
251
- targetType: "SqlDb";
252
- }
253
-
254
- // @public
255
- export interface SqlMiTargetProperties extends TargetProperties {
256
- connectionTcpPort?: number;
257
- readIntent?: boolean;
258
- sqlMiResourceId: string;
259
- targetType: "SqlMi";
260
- }
261
-
262
- // @public
263
- export interface SystemData {
264
- createdAt?: Date;
265
- createdBy?: string;
266
- createdByType?: CreatedByType;
267
- lastModifiedAt?: Date;
268
- lastModifiedBy?: string;
269
- lastModifiedByType?: CreatedByType;
270
- }
271
-
272
- // @public
273
- export interface Target extends ProxyResource {
274
- properties?: TargetPropertiesUnion;
275
- }
276
-
277
- // @public
278
- export type TargetAuthenticationType = string;
279
-
280
- // @public
281
- export interface TargetProperties {
282
- connectionServerName: string;
283
- readonly provisioningState?: ResourceProvisioningState;
284
- targetAuthenticationType: TargetAuthenticationType;
285
- targetType: string;
286
- targetVault?: VaultSecret;
287
- }
288
-
289
- // @public
290
- export type TargetPropertiesUnion = SqlDbSingleDatabaseTargetProperties | SqlDbElasticPoolTargetProperties | SqlMiTargetProperties | TargetProperties;
291
-
292
- // @public
293
- export interface TrackedResource extends Resource {
294
- location: string;
295
- tags?: Record<string, string>;
296
- }
297
-
298
- // @public
299
- export interface UserAssignedIdentity {
300
- readonly clientId?: string;
301
- readonly principalId?: string;
302
- }
303
-
304
- // @public
305
- export interface ValidationIssue {
306
- readonly additionalDetails?: string;
307
- readonly errorCode: string;
308
- readonly errorMessage: string;
309
- readonly recommendationMessage: string;
310
- readonly recommendationUrl?: string;
311
- readonly relatedResourceId?: string;
312
- readonly relatedResourceType?: string;
313
- }
314
-
315
- // @public
316
- export type ValidationStatus = string;
317
-
318
- // @public
319
- export interface VaultSecret {
320
- akvResourceId?: string;
321
- akvTargetPassword?: string;
322
- akvTargetUser?: string;
323
- }
324
-
325
- // @public
326
- export interface Watcher extends TrackedResource {
327
- identity?: ManagedServiceIdentityV4;
328
- properties?: WatcherProperties;
329
- }
330
-
331
- // @public
332
- export interface WatcherProperties {
333
- datastore?: Datastore;
334
- defaultAlertRuleIdentityResourceId?: string;
335
- readonly provisioningState?: DatabaseWatcherProvisioningState;
336
- readonly status?: WatcherStatus;
337
- }
338
-
339
- // @public
340
- export type WatcherStatus = string;
341
-
342
- // @public
343
- export interface WatcherUpdate {
344
- identity?: ManagedServiceIdentityV4;
345
- properties?: WatcherUpdateProperties;
346
- tags?: Record<string, string>;
347
- }
348
-
349
- // @public
350
- export interface WatcherUpdateProperties {
351
- datastore?: Datastore;
352
- defaultAlertRuleIdentityResourceId?: string;
353
- }
354
-
355
- // (No @packageDocumentation comment for this package)
356
-
357
- ```
1
+ ## API Report File for "@azure/arm-databasewatcher"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ // @public
8
+ export type ActionType = string;
9
+
10
+ // @public
11
+ export type AlertRuleCreationProperties = string;
12
+
13
+ // @public
14
+ export interface AlertRuleResource extends ProxyResource {
15
+ properties?: AlertRuleResourceProperties;
16
+ }
17
+
18
+ // @public
19
+ export interface AlertRuleResourceProperties {
20
+ alertRuleResourceId: string;
21
+ alertRuleTemplateId: string;
22
+ alertRuleTemplateVersion: string;
23
+ createdWithProperties: AlertRuleCreationProperties;
24
+ creationTime: Date;
25
+ readonly provisioningState?: ResourceProvisioningState;
26
+ }
27
+
28
+ // @public
29
+ export type CreatedByType = string;
30
+
31
+ // @public
32
+ export type DatabaseWatcherProvisioningState = string;
33
+
34
+ // @public
35
+ export interface Datastore {
36
+ adxClusterResourceId?: string;
37
+ kustoClusterDisplayName?: string;
38
+ kustoClusterUri: string;
39
+ kustoDatabaseName: string;
40
+ kustoDataIngestionUri: string;
41
+ kustoManagementUrl: string;
42
+ kustoOfferingType: KustoOfferingType;
43
+ }
44
+
45
+ // @public
46
+ export interface ErrorAdditionalInfo {
47
+ readonly info?: Record<string, any>;
48
+ readonly type?: string;
49
+ }
50
+
51
+ // @public
52
+ export interface ErrorDetail {
53
+ readonly additionalInfo?: ErrorAdditionalInfo[];
54
+ readonly code?: string;
55
+ readonly details?: ErrorDetail[];
56
+ readonly message?: string;
57
+ readonly target?: string;
58
+ }
59
+
60
+ // @public
61
+ export interface ErrorResponse {
62
+ error?: ErrorDetail;
63
+ }
64
+
65
+ // @public
66
+ export interface HealthValidation extends ProxyResource {
67
+ properties?: HealthValidationProperties;
68
+ }
69
+
70
+ // @public
71
+ export interface HealthValidationProperties {
72
+ readonly endTime: Date;
73
+ readonly issues: ValidationIssue[];
74
+ readonly provisioningState?: ResourceProvisioningState;
75
+ readonly startTime: Date;
76
+ readonly status: ValidationStatus;
77
+ }
78
+
79
+ // @public
80
+ export enum KnownActionType {
81
+ Internal = "Internal"
82
+ }
83
+
84
+ // @public
85
+ export enum KnownAlertRuleCreationProperties {
86
+ CreatedWithActionGroup = "CreatedWithActionGroup",
87
+ None = "None"
88
+ }
89
+
90
+ // @public
91
+ export enum KnownCreatedByType {
92
+ Application = "Application",
93
+ Key = "Key",
94
+ ManagedIdentity = "ManagedIdentity",
95
+ User = "User"
96
+ }
97
+
98
+ // @public
99
+ export enum KnownDatabaseWatcherProvisioningState {
100
+ Canceled = "Canceled",
101
+ Failed = "Failed",
102
+ Succeeded = "Succeeded"
103
+ }
104
+
105
+ // @public
106
+ export enum KnownKustoOfferingType {
107
+ Adx = "adx",
108
+ Fabric = "fabric",
109
+ Free = "free"
110
+ }
111
+
112
+ // @public
113
+ export enum KnownManagedServiceIdentityType {
114
+ None = "None",
115
+ SystemAndUserAssigned = "SystemAssigned, UserAssigned",
116
+ SystemAssigned = "SystemAssigned",
117
+ UserAssigned = "UserAssigned"
118
+ }
119
+
120
+ // @public
121
+ export enum KnownOrigin {
122
+ System = "system",
123
+ User = "user",
124
+ UserSystem = "user,system"
125
+ }
126
+
127
+ // @public
128
+ export enum KnownResourceProvisioningState {
129
+ Canceled = "Canceled",
130
+ Failed = "Failed",
131
+ Succeeded = "Succeeded"
132
+ }
133
+
134
+ // @public
135
+ export enum KnownSharedPrivateLinkResourceStatus {
136
+ Approved = "Approved",
137
+ Disconnected = "Disconnected",
138
+ Pending = "Pending",
139
+ Rejected = "Rejected"
140
+ }
141
+
142
+ // @public
143
+ export enum KnownTargetAuthenticationType {
144
+ Aad = "Aad",
145
+ Sql = "Sql"
146
+ }
147
+
148
+ // @public
149
+ export enum KnownValidationStatus {
150
+ Canceled = "Canceled",
151
+ Failed = "Failed",
152
+ NotStarted = "NotStarted",
153
+ Running = "Running",
154
+ Succeeded = "Succeeded",
155
+ TimedOut = "TimedOut"
156
+ }
157
+
158
+ // @public
159
+ export enum KnownVersions {
160
+ V20250102 = "2025-01-02"
161
+ }
162
+
163
+ // @public
164
+ export enum KnownWatcherStatus {
165
+ Deleting = "Deleting",
166
+ Running = "Running",
167
+ Starting = "Starting",
168
+ Stopped = "Stopped",
169
+ Stopping = "Stopping"
170
+ }
171
+
172
+ // @public
173
+ export type KustoOfferingType = string;
174
+
175
+ // @public
176
+ export type ManagedServiceIdentityType = string;
177
+
178
+ // @public
179
+ export interface ManagedServiceIdentityV4 {
180
+ readonly principalId?: string;
181
+ readonly tenantId?: string;
182
+ type: ManagedServiceIdentityType;
183
+ userAssignedIdentities?: Record<string, UserAssignedIdentity>;
184
+ }
185
+
186
+ // @public
187
+ export interface Operation {
188
+ readonly actionType?: ActionType;
189
+ display?: OperationDisplay;
190
+ readonly isDataAction?: boolean;
191
+ readonly name?: string;
192
+ readonly origin?: Origin;
193
+ }
194
+
195
+ // @public
196
+ export interface OperationDisplay {
197
+ readonly description?: string;
198
+ readonly operation?: string;
199
+ readonly provider?: string;
200
+ readonly resource?: string;
201
+ }
202
+
203
+ // @public
204
+ export type Origin = string;
205
+
206
+ // @public
207
+ export interface ProxyResource extends Resource {
208
+ }
209
+
210
+ // @public
211
+ export interface Resource {
212
+ readonly id?: string;
213
+ readonly name?: string;
214
+ readonly systemData?: SystemData;
215
+ readonly type?: string;
216
+ }
217
+
218
+ // @public
219
+ export type ResourceProvisioningState = string;
220
+
221
+ // @public
222
+ export interface SharedPrivateLinkResource extends ProxyResource {
223
+ properties?: SharedPrivateLinkResourceProperties;
224
+ }
225
+
226
+ // @public
227
+ export interface SharedPrivateLinkResourceProperties {
228
+ dnsZone?: string;
229
+ groupId: string;
230
+ privateLinkResourceId: string;
231
+ readonly provisioningState?: ResourceProvisioningState;
232
+ requestMessage: string;
233
+ readonly status?: SharedPrivateLinkResourceStatus;
234
+ }
235
+
236
+ // @public
237
+ export type SharedPrivateLinkResourceStatus = string;
238
+
239
+ // @public
240
+ export interface SqlDbElasticPoolTargetProperties extends TargetProperties {
241
+ anchorDatabaseResourceId: string;
242
+ readIntent?: boolean;
243
+ sqlEpResourceId: string;
244
+ targetType: "SqlEp";
245
+ }
246
+
247
+ // @public
248
+ export interface SqlDbSingleDatabaseTargetProperties extends TargetProperties {
249
+ readIntent?: boolean;
250
+ sqlDbResourceId: string;
251
+ targetType: "SqlDb";
252
+ }
253
+
254
+ // @public
255
+ export interface SqlMiTargetProperties extends TargetProperties {
256
+ connectionTcpPort?: number;
257
+ readIntent?: boolean;
258
+ sqlMiResourceId: string;
259
+ targetType: "SqlMi";
260
+ }
261
+
262
+ // @public
263
+ export interface SystemData {
264
+ createdAt?: Date;
265
+ createdBy?: string;
266
+ createdByType?: CreatedByType;
267
+ lastModifiedAt?: Date;
268
+ lastModifiedBy?: string;
269
+ lastModifiedByType?: CreatedByType;
270
+ }
271
+
272
+ // @public
273
+ export interface Target extends ProxyResource {
274
+ properties?: TargetPropertiesUnion;
275
+ }
276
+
277
+ // @public
278
+ export type TargetAuthenticationType = string;
279
+
280
+ // @public
281
+ export interface TargetProperties {
282
+ connectionServerName: string;
283
+ readonly provisioningState?: ResourceProvisioningState;
284
+ targetAuthenticationType: TargetAuthenticationType;
285
+ targetType: string;
286
+ targetVault?: VaultSecret;
287
+ }
288
+
289
+ // @public
290
+ export type TargetPropertiesUnion = SqlDbSingleDatabaseTargetProperties | SqlDbElasticPoolTargetProperties | SqlMiTargetProperties | TargetProperties;
291
+
292
+ // @public
293
+ export interface TrackedResource extends Resource {
294
+ location: string;
295
+ tags?: Record<string, string>;
296
+ }
297
+
298
+ // @public
299
+ export interface UserAssignedIdentity {
300
+ readonly clientId?: string;
301
+ readonly principalId?: string;
302
+ }
303
+
304
+ // @public
305
+ export interface ValidationIssue {
306
+ readonly additionalDetails?: string;
307
+ readonly errorCode: string;
308
+ readonly errorMessage: string;
309
+ readonly recommendationMessage: string;
310
+ readonly recommendationUrl?: string;
311
+ readonly relatedResourceId?: string;
312
+ readonly relatedResourceType?: string;
313
+ }
314
+
315
+ // @public
316
+ export type ValidationStatus = string;
317
+
318
+ // @public
319
+ export interface VaultSecret {
320
+ akvResourceId?: string;
321
+ akvTargetPassword?: string;
322
+ akvTargetUser?: string;
323
+ }
324
+
325
+ // @public
326
+ export interface Watcher extends TrackedResource {
327
+ identity?: ManagedServiceIdentityV4;
328
+ properties?: WatcherProperties;
329
+ }
330
+
331
+ // @public
332
+ export interface WatcherProperties {
333
+ datastore?: Datastore;
334
+ defaultAlertRuleIdentityResourceId?: string;
335
+ readonly provisioningState?: DatabaseWatcherProvisioningState;
336
+ readonly status?: WatcherStatus;
337
+ }
338
+
339
+ // @public
340
+ export type WatcherStatus = string;
341
+
342
+ // @public
343
+ export interface WatcherUpdate {
344
+ identity?: ManagedServiceIdentityV4;
345
+ properties?: WatcherUpdateProperties;
346
+ tags?: Record<string, string>;
347
+ }
348
+
349
+ // @public
350
+ export interface WatcherUpdateProperties {
351
+ datastore?: Datastore;
352
+ defaultAlertRuleIdentityResourceId?: string;
353
+ }
354
+
355
+ // (No @packageDocumentation comment for this package)
356
+
357
+ ```