@azure/arm-purview 1.1.1-alpha.20250618.1 → 1.1.1-alpha.20250717.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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "sdk-type": "mgmt",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "A generated SDK for PurviewManagementClient.",
6
- "version": "1.1.1-alpha.20250618.1",
6
+ "version": "1.1.1-alpha.20250717.1",
7
7
  "engines": {
8
8
  "node": ">=20.0.0"
9
9
  },
@@ -1,653 +1,653 @@
1
- ## API Report File for "@azure/arm-purview"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import * as coreAuth from '@azure/core-auth';
8
- import * as coreClient from '@azure/core-client';
9
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
10
- import { PollerLike } from '@azure/core-lro';
11
- import { PollOperationState } from '@azure/core-lro';
12
-
13
- // @public
14
- export interface AccessKeys {
15
- atlasKafkaPrimaryEndpoint?: string;
16
- atlasKafkaSecondaryEndpoint?: string;
17
- }
18
-
19
- // @public
20
- export interface Account extends TrackedResource {
21
- cloudConnectors?: CloudConnectors;
22
- readonly createdAt?: Date;
23
- readonly createdBy?: string;
24
- readonly createdByObjectId?: string;
25
- readonly endpoints?: AccountPropertiesEndpoints;
26
- readonly friendlyName?: string;
27
- managedResourceGroupName?: string;
28
- readonly managedResources?: AccountPropertiesManagedResources;
29
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
30
- readonly provisioningState?: ProvisioningState;
31
- publicNetworkAccess?: PublicNetworkAccess;
32
- readonly sku?: AccountSku;
33
- }
34
-
35
- // @public
36
- export interface AccountEndpoints {
37
- readonly catalog?: string;
38
- readonly guardian?: string;
39
- readonly scan?: string;
40
- }
41
-
42
- // @public
43
- export interface AccountList {
44
- count?: number;
45
- nextLink?: string;
46
- value: Account[];
47
- }
48
-
49
- // @public
50
- export interface AccountProperties {
51
- cloudConnectors?: CloudConnectors;
52
- readonly createdAt?: Date;
53
- readonly createdBy?: string;
54
- readonly createdByObjectId?: string;
55
- readonly endpoints?: AccountPropertiesEndpoints;
56
- readonly friendlyName?: string;
57
- managedResourceGroupName?: string;
58
- readonly managedResources?: AccountPropertiesManagedResources;
59
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
60
- readonly provisioningState?: ProvisioningState;
61
- publicNetworkAccess?: PublicNetworkAccess;
62
- }
63
-
64
- // @public
65
- export interface AccountPropertiesEndpoints extends AccountEndpoints {
66
- }
67
-
68
- // @public
69
- export interface AccountPropertiesManagedResources extends ManagedResources {
70
- }
71
-
72
- // @public
73
- export interface Accounts {
74
- addRootCollectionAdmin(resourceGroupName: string, accountName: string, collectionAdminUpdate: CollectionAdminUpdate, options?: AccountsAddRootCollectionAdminOptionalParams): Promise<void>;
75
- beginCreateOrUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AccountsCreateOrUpdateResponse>, AccountsCreateOrUpdateResponse>>;
76
- beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<AccountsCreateOrUpdateResponse>;
77
- beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
78
- beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>;
79
- beginUpdate(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AccountsUpdateResponse>, AccountsUpdateResponse>>;
80
- beginUpdateAndWait(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
81
- checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: AccountsCheckNameAvailabilityOptionalParams): Promise<AccountsCheckNameAvailabilityResponse>;
82
- get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<AccountsGetResponse>;
83
- listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Account>;
84
- listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Account>;
85
- listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccountsListKeysResponse>;
86
- }
87
-
88
- // @public
89
- export interface AccountsAddRootCollectionAdminOptionalParams extends coreClient.OperationOptions {
90
- }
91
-
92
- // @public
93
- export interface AccountsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
94
- }
95
-
96
- // @public
97
- export type AccountsCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
98
-
99
- // @public
100
- export interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
101
- resumeFrom?: string;
102
- updateIntervalInMs?: number;
103
- }
104
-
105
- // @public
106
- export type AccountsCreateOrUpdateResponse = Account;
107
-
108
- // @public
109
- export interface AccountsDeleteOptionalParams extends coreClient.OperationOptions {
110
- resumeFrom?: string;
111
- updateIntervalInMs?: number;
112
- }
113
-
114
- // @public
115
- export interface AccountsGetOptionalParams extends coreClient.OperationOptions {
116
- }
117
-
118
- // @public
119
- export type AccountsGetResponse = Account;
120
-
121
- // @public
122
- export interface AccountSku extends AccountSkuAutoGenerated {
123
- }
124
-
125
- // @public
126
- export interface AccountSkuAutoGenerated {
127
- capacity?: number;
128
- name?: Name;
129
- }
130
-
131
- // @public
132
- export interface AccountsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
133
- skipToken?: string;
134
- }
135
-
136
- // @public
137
- export type AccountsListByResourceGroupNextResponse = AccountList;
138
-
139
- // @public
140
- export interface AccountsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
141
- skipToken?: string;
142
- }
143
-
144
- // @public
145
- export type AccountsListByResourceGroupResponse = AccountList;
146
-
147
- // @public
148
- export interface AccountsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
149
- skipToken?: string;
150
- }
151
-
152
- // @public
153
- export type AccountsListBySubscriptionNextResponse = AccountList;
154
-
155
- // @public
156
- export interface AccountsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
157
- skipToken?: string;
158
- }
159
-
160
- // @public
161
- export type AccountsListBySubscriptionResponse = AccountList;
162
-
163
- // @public
164
- export interface AccountsListKeysOptionalParams extends coreClient.OperationOptions {
165
- }
166
-
167
- // @public
168
- export type AccountsListKeysResponse = AccessKeys;
169
-
170
- // @public
171
- export interface AccountsUpdateOptionalParams extends coreClient.OperationOptions {
172
- resumeFrom?: string;
173
- updateIntervalInMs?: number;
174
- }
175
-
176
- // @public
177
- export type AccountsUpdateResponse = Account;
178
-
179
- // @public
180
- export interface AccountUpdateParameters {
181
- identity?: Identity;
182
- properties?: AccountProperties;
183
- tags?: {
184
- [propertyName: string]: string;
185
- };
186
- }
187
-
188
- // @public
189
- export interface CheckNameAvailabilityRequest {
190
- name?: string;
191
- type?: string;
192
- }
193
-
194
- // @public
195
- export interface CheckNameAvailabilityResult {
196
- message?: string;
197
- nameAvailable?: boolean;
198
- reason?: Reason;
199
- }
200
-
201
- // @public
202
- export interface CloudConnectors {
203
- readonly awsExternalId?: string;
204
- }
205
-
206
- // @public
207
- export interface CollectionAdminUpdate {
208
- objectId?: string;
209
- }
210
-
211
- // @public
212
- export type CreatedByType = string;
213
-
214
- // @public
215
- export interface DefaultAccountPayload {
216
- accountName?: string;
217
- resourceGroupName?: string;
218
- scope?: string;
219
- scopeTenantId?: string;
220
- scopeType?: ScopeType;
221
- subscriptionId?: string;
222
- }
223
-
224
- // @public
225
- export interface DefaultAccounts {
226
- get(scopeTenantId: string, scopeType: ScopeType, options?: DefaultAccountsGetOptionalParams): Promise<DefaultAccountsGetResponse>;
227
- remove(scopeTenantId: string, scopeType: ScopeType, options?: DefaultAccountsRemoveOptionalParams): Promise<void>;
228
- set(defaultAccountPayload: DefaultAccountPayload, options?: DefaultAccountsSetModelOptionalParams): Promise<DefaultAccountsSetModelResponse>;
229
- }
230
-
231
- // @public
232
- export interface DefaultAccountsGetOptionalParams extends coreClient.OperationOptions {
233
- scope?: string;
234
- }
235
-
236
- // @public
237
- export type DefaultAccountsGetResponse = DefaultAccountPayload;
238
-
239
- // @public
240
- export interface DefaultAccountsRemoveOptionalParams extends coreClient.OperationOptions {
241
- scope?: string;
242
- }
243
-
244
- // @public
245
- export interface DefaultAccountsSetModelOptionalParams extends coreClient.OperationOptions {
246
- }
247
-
248
- // @public
249
- export type DefaultAccountsSetModelResponse = DefaultAccountPayload;
250
-
251
- // @public
252
- export interface DimensionProperties {
253
- displayName?: string;
254
- name?: string;
255
- toBeExportedForCustomer?: boolean;
256
- }
257
-
258
- // @public
259
- export interface ErrorModel {
260
- readonly code?: string;
261
- readonly details?: ErrorModel[];
262
- readonly message?: string;
263
- readonly target?: string;
264
- }
265
-
266
- // @public
267
- export interface ErrorResponseModel {
268
- readonly error?: ErrorResponseModelError;
269
- }
270
-
271
- // @public
272
- export interface ErrorResponseModelError extends ErrorModel {
273
- }
274
-
275
- // @public
276
- export function getContinuationToken(page: unknown): string | undefined;
277
-
278
- // @public
279
- export interface Identity {
280
- readonly principalId?: string;
281
- readonly tenantId?: string;
282
- type?: Type;
283
- userAssignedIdentities?: {
284
- [propertyName: string]: UserAssignedIdentity;
285
- };
286
- }
287
-
288
- // @public
289
- export enum KnownCreatedByType {
290
- Application = "Application",
291
- Key = "Key",
292
- ManagedIdentity = "ManagedIdentity",
293
- User = "User"
294
- }
295
-
296
- // @public
297
- export enum KnownLastModifiedByType {
298
- Application = "Application",
299
- Key = "Key",
300
- ManagedIdentity = "ManagedIdentity",
301
- User = "User"
302
- }
303
-
304
- // @public
305
- export enum KnownName {
306
- Standard = "Standard"
307
- }
308
-
309
- // @public
310
- export enum KnownProvisioningState {
311
- Canceled = "Canceled",
312
- Creating = "Creating",
313
- Deleting = "Deleting",
314
- Failed = "Failed",
315
- Moving = "Moving",
316
- SoftDeleted = "SoftDeleted",
317
- SoftDeleting = "SoftDeleting",
318
- Succeeded = "Succeeded",
319
- Unknown = "Unknown"
320
- }
321
-
322
- // @public
323
- export enum KnownPublicNetworkAccess {
324
- Disabled = "Disabled",
325
- Enabled = "Enabled",
326
- NotSpecified = "NotSpecified"
327
- }
328
-
329
- // @public
330
- export enum KnownReason {
331
- AlreadyExists = "AlreadyExists",
332
- Invalid = "Invalid"
333
- }
334
-
335
- // @public
336
- export enum KnownScopeType {
337
- Subscription = "Subscription",
338
- Tenant = "Tenant"
339
- }
340
-
341
- // @public
342
- export enum KnownStatus {
343
- Approved = "Approved",
344
- Disconnected = "Disconnected",
345
- Pending = "Pending",
346
- Rejected = "Rejected",
347
- Unknown = "Unknown"
348
- }
349
-
350
- // @public
351
- export enum KnownType {
352
- None = "None",
353
- SystemAssigned = "SystemAssigned",
354
- UserAssigned = "UserAssigned"
355
- }
356
-
357
- // @public
358
- export type LastModifiedByType = string;
359
-
360
- // @public
361
- export interface ManagedResources {
362
- readonly eventHubNamespace?: string;
363
- readonly resourceGroup?: string;
364
- readonly storageAccount?: string;
365
- }
366
-
367
- // @public
368
- export type Name = string;
369
-
370
- // @public
371
- export interface Operation {
372
- display?: OperationDisplay;
373
- isDataAction?: boolean;
374
- name?: string;
375
- origin?: string;
376
- serviceSpecification?: OperationMetaServiceSpecification;
377
- }
378
-
379
- // @public
380
- export interface OperationDisplay {
381
- description?: string;
382
- operation?: string;
383
- provider?: string;
384
- resource?: string;
385
- }
386
-
387
- // @public
388
- export interface OperationList {
389
- count?: number;
390
- nextLink?: string;
391
- value: Operation[];
392
- }
393
-
394
- // @public
395
- export interface OperationMetaLogSpecification {
396
- blobDuration?: string;
397
- displayName?: string;
398
- name?: string;
399
- }
400
-
401
- // @public
402
- export interface OperationMetaMetricSpecification {
403
- aggregationType?: string;
404
- dimensions?: DimensionProperties[];
405
- displayDescription?: string;
406
- displayName?: string;
407
- enableRegionalMdmAccount?: string;
408
- internalMetricName?: string;
409
- name?: string;
410
- resourceIdDimensionNameOverride?: string;
411
- sourceMdmNamespace?: string;
412
- supportedAggregationTypes?: string[];
413
- supportedTimeGrainTypes?: string[];
414
- unit?: string;
415
- }
416
-
417
- // @public
418
- export interface OperationMetaServiceSpecification {
419
- logSpecifications?: OperationMetaLogSpecification[];
420
- metricSpecifications?: OperationMetaMetricSpecification[];
421
- }
422
-
423
- // @public
424
- export interface Operations {
425
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
426
- }
427
-
428
- // @public
429
- export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
430
- }
431
-
432
- // @public
433
- export type OperationsListNextResponse = OperationList;
434
-
435
- // @public
436
- export interface OperationsListOptionalParams extends coreClient.OperationOptions {
437
- }
438
-
439
- // @public
440
- export type OperationsListResponse = OperationList;
441
-
442
- // @public
443
- export interface PrivateEndpoint {
444
- id?: string;
445
- }
446
-
447
- // @public
448
- export interface PrivateEndpointConnection extends ProxyResource {
449
- privateEndpoint?: PrivateEndpoint;
450
- privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
451
- readonly provisioningState?: string;
452
- }
453
-
454
- // @public
455
- export interface PrivateEndpointConnectionList {
456
- count?: number;
457
- nextLink?: string;
458
- value: PrivateEndpointConnection[];
459
- }
460
-
461
- // @public
462
- export interface PrivateEndpointConnections {
463
- beginCreateOrUpdate(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, request: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
464
- beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, request: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse>;
465
- beginDelete(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
466
- beginDeleteAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
467
- get(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
468
- listByAccount(resourceGroupName: string, accountName: string, options?: PrivateEndpointConnectionsListByAccountOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
469
- }
470
-
471
- // @public
472
- export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
473
- resumeFrom?: string;
474
- updateIntervalInMs?: number;
475
- }
476
-
477
- // @public
478
- export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
479
-
480
- // @public
481
- export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
482
- resumeFrom?: string;
483
- updateIntervalInMs?: number;
484
- }
485
-
486
- // @public
487
- export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
488
- }
489
-
490
- // @public
491
- export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
492
-
493
- // @public
494
- export interface PrivateEndpointConnectionsListByAccountNextOptionalParams extends coreClient.OperationOptions {
495
- skipToken?: string;
496
- }
497
-
498
- // @public
499
- export type PrivateEndpointConnectionsListByAccountNextResponse = PrivateEndpointConnectionList;
500
-
501
- // @public
502
- export interface PrivateEndpointConnectionsListByAccountOptionalParams extends coreClient.OperationOptions {
503
- skipToken?: string;
504
- }
505
-
506
- // @public
507
- export type PrivateEndpointConnectionsListByAccountResponse = PrivateEndpointConnectionList;
508
-
509
- // @public
510
- export interface PrivateLinkResource {
511
- readonly id?: string;
512
- readonly name?: string;
513
- readonly properties?: PrivateLinkResourceProperties;
514
- readonly type?: string;
515
- }
516
-
517
- // @public
518
- export interface PrivateLinkResourceList {
519
- count?: number;
520
- nextLink?: string;
521
- value: PrivateLinkResource[];
522
- }
523
-
524
- // @public
525
- export interface PrivateLinkResourceProperties {
526
- readonly groupId?: string;
527
- readonly requiredMembers?: string[];
528
- readonly requiredZoneNames?: string[];
529
- }
530
-
531
- // @public
532
- export interface PrivateLinkResources {
533
- getByGroupId(resourceGroupName: string, accountName: string, groupId: string, options?: PrivateLinkResourcesGetByGroupIdOptionalParams): Promise<PrivateLinkResourcesGetByGroupIdResponse>;
534
- listByAccount(resourceGroupName: string, accountName: string, options?: PrivateLinkResourcesListByAccountOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
535
- }
536
-
537
- // @public
538
- export interface PrivateLinkResourcesGetByGroupIdOptionalParams extends coreClient.OperationOptions {
539
- }
540
-
541
- // @public
542
- export type PrivateLinkResourcesGetByGroupIdResponse = PrivateLinkResource;
543
-
544
- // @public
545
- export interface PrivateLinkResourcesListByAccountNextOptionalParams extends coreClient.OperationOptions {
546
- }
547
-
548
- // @public
549
- export type PrivateLinkResourcesListByAccountNextResponse = PrivateLinkResourceList;
550
-
551
- // @public
552
- export interface PrivateLinkResourcesListByAccountOptionalParams extends coreClient.OperationOptions {
553
- }
554
-
555
- // @public
556
- export type PrivateLinkResourcesListByAccountResponse = PrivateLinkResourceList;
557
-
558
- // @public
559
- export interface PrivateLinkServiceConnectionState {
560
- actionsRequired?: string;
561
- description?: string;
562
- status?: Status;
563
- }
564
-
565
- // @public
566
- export type ProvisioningState = string;
567
-
568
- // @public
569
- export interface ProxyResource {
570
- readonly id?: string;
571
- readonly name?: string;
572
- readonly type?: string;
573
- }
574
-
575
- // @public
576
- export type PublicNetworkAccess = string;
577
-
578
- // @public (undocumented)
579
- export class PurviewManagementClient extends coreClient.ServiceClient {
580
- // (undocumented)
581
- $host: string;
582
- constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PurviewManagementClientOptionalParams);
583
- // (undocumented)
584
- accounts: Accounts;
585
- // (undocumented)
586
- apiVersion: string;
587
- // (undocumented)
588
- defaultAccounts: DefaultAccounts;
589
- // (undocumented)
590
- operations: Operations;
591
- // (undocumented)
592
- privateEndpointConnections: PrivateEndpointConnections;
593
- // (undocumented)
594
- privateLinkResources: PrivateLinkResources;
595
- // (undocumented)
596
- subscriptionId: string;
597
- }
598
-
599
- // @public
600
- export interface PurviewManagementClientOptionalParams extends coreClient.ServiceClientOptions {
601
- $host?: string;
602
- apiVersion?: string;
603
- endpoint?: string;
604
- }
605
-
606
- // @public
607
- export type Reason = string;
608
-
609
- // @public
610
- export type ScopeType = string;
611
-
612
- // @public
613
- export type Status = string;
614
-
615
- // @public
616
- export interface SystemData {
617
- readonly createdAt?: Date;
618
- readonly createdBy?: string;
619
- readonly createdByType?: CreatedByType;
620
- readonly lastModifiedAt?: Date;
621
- readonly lastModifiedBy?: string;
622
- readonly lastModifiedByType?: LastModifiedByType;
623
- }
624
-
625
- // @public
626
- export interface TrackedResource {
627
- readonly id?: string;
628
- identity?: Identity;
629
- location?: string;
630
- readonly name?: string;
631
- readonly systemData?: TrackedResourceSystemData;
632
- tags?: {
633
- [propertyName: string]: string;
634
- };
635
- readonly type?: string;
636
- }
637
-
638
- // @public
639
- export interface TrackedResourceSystemData extends SystemData {
640
- }
641
-
642
- // @public
643
- export type Type = string;
644
-
645
- // @public
646
- export interface UserAssignedIdentity {
647
- readonly clientId?: string;
648
- readonly principalId?: string;
649
- }
650
-
651
- // (No @packageDocumentation comment for this package)
652
-
653
- ```
1
+ ## API Report File for "@azure/arm-purview"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import * as coreAuth from '@azure/core-auth';
8
+ import * as coreClient from '@azure/core-client';
9
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
10
+ import { PollerLike } from '@azure/core-lro';
11
+ import { PollOperationState } from '@azure/core-lro';
12
+
13
+ // @public
14
+ export interface AccessKeys {
15
+ atlasKafkaPrimaryEndpoint?: string;
16
+ atlasKafkaSecondaryEndpoint?: string;
17
+ }
18
+
19
+ // @public
20
+ export interface Account extends TrackedResource {
21
+ cloudConnectors?: CloudConnectors;
22
+ readonly createdAt?: Date;
23
+ readonly createdBy?: string;
24
+ readonly createdByObjectId?: string;
25
+ readonly endpoints?: AccountPropertiesEndpoints;
26
+ readonly friendlyName?: string;
27
+ managedResourceGroupName?: string;
28
+ readonly managedResources?: AccountPropertiesManagedResources;
29
+ readonly privateEndpointConnections?: PrivateEndpointConnection[];
30
+ readonly provisioningState?: ProvisioningState;
31
+ publicNetworkAccess?: PublicNetworkAccess;
32
+ readonly sku?: AccountSku;
33
+ }
34
+
35
+ // @public
36
+ export interface AccountEndpoints {
37
+ readonly catalog?: string;
38
+ readonly guardian?: string;
39
+ readonly scan?: string;
40
+ }
41
+
42
+ // @public
43
+ export interface AccountList {
44
+ count?: number;
45
+ nextLink?: string;
46
+ value: Account[];
47
+ }
48
+
49
+ // @public
50
+ export interface AccountProperties {
51
+ cloudConnectors?: CloudConnectors;
52
+ readonly createdAt?: Date;
53
+ readonly createdBy?: string;
54
+ readonly createdByObjectId?: string;
55
+ readonly endpoints?: AccountPropertiesEndpoints;
56
+ readonly friendlyName?: string;
57
+ managedResourceGroupName?: string;
58
+ readonly managedResources?: AccountPropertiesManagedResources;
59
+ readonly privateEndpointConnections?: PrivateEndpointConnection[];
60
+ readonly provisioningState?: ProvisioningState;
61
+ publicNetworkAccess?: PublicNetworkAccess;
62
+ }
63
+
64
+ // @public
65
+ export interface AccountPropertiesEndpoints extends AccountEndpoints {
66
+ }
67
+
68
+ // @public
69
+ export interface AccountPropertiesManagedResources extends ManagedResources {
70
+ }
71
+
72
+ // @public
73
+ export interface Accounts {
74
+ addRootCollectionAdmin(resourceGroupName: string, accountName: string, collectionAdminUpdate: CollectionAdminUpdate, options?: AccountsAddRootCollectionAdminOptionalParams): Promise<void>;
75
+ beginCreateOrUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AccountsCreateOrUpdateResponse>, AccountsCreateOrUpdateResponse>>;
76
+ beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<AccountsCreateOrUpdateResponse>;
77
+ beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
78
+ beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>;
79
+ beginUpdate(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AccountsUpdateResponse>, AccountsUpdateResponse>>;
80
+ beginUpdateAndWait(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
81
+ checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: AccountsCheckNameAvailabilityOptionalParams): Promise<AccountsCheckNameAvailabilityResponse>;
82
+ get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<AccountsGetResponse>;
83
+ listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Account>;
84
+ listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Account>;
85
+ listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccountsListKeysResponse>;
86
+ }
87
+
88
+ // @public
89
+ export interface AccountsAddRootCollectionAdminOptionalParams extends coreClient.OperationOptions {
90
+ }
91
+
92
+ // @public
93
+ export interface AccountsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
94
+ }
95
+
96
+ // @public
97
+ export type AccountsCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
98
+
99
+ // @public
100
+ export interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
101
+ resumeFrom?: string;
102
+ updateIntervalInMs?: number;
103
+ }
104
+
105
+ // @public
106
+ export type AccountsCreateOrUpdateResponse = Account;
107
+
108
+ // @public
109
+ export interface AccountsDeleteOptionalParams extends coreClient.OperationOptions {
110
+ resumeFrom?: string;
111
+ updateIntervalInMs?: number;
112
+ }
113
+
114
+ // @public
115
+ export interface AccountsGetOptionalParams extends coreClient.OperationOptions {
116
+ }
117
+
118
+ // @public
119
+ export type AccountsGetResponse = Account;
120
+
121
+ // @public
122
+ export interface AccountSku extends AccountSkuAutoGenerated {
123
+ }
124
+
125
+ // @public
126
+ export interface AccountSkuAutoGenerated {
127
+ capacity?: number;
128
+ name?: Name;
129
+ }
130
+
131
+ // @public
132
+ export interface AccountsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
133
+ skipToken?: string;
134
+ }
135
+
136
+ // @public
137
+ export type AccountsListByResourceGroupNextResponse = AccountList;
138
+
139
+ // @public
140
+ export interface AccountsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
141
+ skipToken?: string;
142
+ }
143
+
144
+ // @public
145
+ export type AccountsListByResourceGroupResponse = AccountList;
146
+
147
+ // @public
148
+ export interface AccountsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
149
+ skipToken?: string;
150
+ }
151
+
152
+ // @public
153
+ export type AccountsListBySubscriptionNextResponse = AccountList;
154
+
155
+ // @public
156
+ export interface AccountsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
157
+ skipToken?: string;
158
+ }
159
+
160
+ // @public
161
+ export type AccountsListBySubscriptionResponse = AccountList;
162
+
163
+ // @public
164
+ export interface AccountsListKeysOptionalParams extends coreClient.OperationOptions {
165
+ }
166
+
167
+ // @public
168
+ export type AccountsListKeysResponse = AccessKeys;
169
+
170
+ // @public
171
+ export interface AccountsUpdateOptionalParams extends coreClient.OperationOptions {
172
+ resumeFrom?: string;
173
+ updateIntervalInMs?: number;
174
+ }
175
+
176
+ // @public
177
+ export type AccountsUpdateResponse = Account;
178
+
179
+ // @public
180
+ export interface AccountUpdateParameters {
181
+ identity?: Identity;
182
+ properties?: AccountProperties;
183
+ tags?: {
184
+ [propertyName: string]: string;
185
+ };
186
+ }
187
+
188
+ // @public
189
+ export interface CheckNameAvailabilityRequest {
190
+ name?: string;
191
+ type?: string;
192
+ }
193
+
194
+ // @public
195
+ export interface CheckNameAvailabilityResult {
196
+ message?: string;
197
+ nameAvailable?: boolean;
198
+ reason?: Reason;
199
+ }
200
+
201
+ // @public
202
+ export interface CloudConnectors {
203
+ readonly awsExternalId?: string;
204
+ }
205
+
206
+ // @public
207
+ export interface CollectionAdminUpdate {
208
+ objectId?: string;
209
+ }
210
+
211
+ // @public
212
+ export type CreatedByType = string;
213
+
214
+ // @public
215
+ export interface DefaultAccountPayload {
216
+ accountName?: string;
217
+ resourceGroupName?: string;
218
+ scope?: string;
219
+ scopeTenantId?: string;
220
+ scopeType?: ScopeType;
221
+ subscriptionId?: string;
222
+ }
223
+
224
+ // @public
225
+ export interface DefaultAccounts {
226
+ get(scopeTenantId: string, scopeType: ScopeType, options?: DefaultAccountsGetOptionalParams): Promise<DefaultAccountsGetResponse>;
227
+ remove(scopeTenantId: string, scopeType: ScopeType, options?: DefaultAccountsRemoveOptionalParams): Promise<void>;
228
+ set(defaultAccountPayload: DefaultAccountPayload, options?: DefaultAccountsSetModelOptionalParams): Promise<DefaultAccountsSetModelResponse>;
229
+ }
230
+
231
+ // @public
232
+ export interface DefaultAccountsGetOptionalParams extends coreClient.OperationOptions {
233
+ scope?: string;
234
+ }
235
+
236
+ // @public
237
+ export type DefaultAccountsGetResponse = DefaultAccountPayload;
238
+
239
+ // @public
240
+ export interface DefaultAccountsRemoveOptionalParams extends coreClient.OperationOptions {
241
+ scope?: string;
242
+ }
243
+
244
+ // @public
245
+ export interface DefaultAccountsSetModelOptionalParams extends coreClient.OperationOptions {
246
+ }
247
+
248
+ // @public
249
+ export type DefaultAccountsSetModelResponse = DefaultAccountPayload;
250
+
251
+ // @public
252
+ export interface DimensionProperties {
253
+ displayName?: string;
254
+ name?: string;
255
+ toBeExportedForCustomer?: boolean;
256
+ }
257
+
258
+ // @public
259
+ export interface ErrorModel {
260
+ readonly code?: string;
261
+ readonly details?: ErrorModel[];
262
+ readonly message?: string;
263
+ readonly target?: string;
264
+ }
265
+
266
+ // @public
267
+ export interface ErrorResponseModel {
268
+ readonly error?: ErrorResponseModelError;
269
+ }
270
+
271
+ // @public
272
+ export interface ErrorResponseModelError extends ErrorModel {
273
+ }
274
+
275
+ // @public
276
+ export function getContinuationToken(page: unknown): string | undefined;
277
+
278
+ // @public
279
+ export interface Identity {
280
+ readonly principalId?: string;
281
+ readonly tenantId?: string;
282
+ type?: Type;
283
+ userAssignedIdentities?: {
284
+ [propertyName: string]: UserAssignedIdentity;
285
+ };
286
+ }
287
+
288
+ // @public
289
+ export enum KnownCreatedByType {
290
+ Application = "Application",
291
+ Key = "Key",
292
+ ManagedIdentity = "ManagedIdentity",
293
+ User = "User"
294
+ }
295
+
296
+ // @public
297
+ export enum KnownLastModifiedByType {
298
+ Application = "Application",
299
+ Key = "Key",
300
+ ManagedIdentity = "ManagedIdentity",
301
+ User = "User"
302
+ }
303
+
304
+ // @public
305
+ export enum KnownName {
306
+ Standard = "Standard"
307
+ }
308
+
309
+ // @public
310
+ export enum KnownProvisioningState {
311
+ Canceled = "Canceled",
312
+ Creating = "Creating",
313
+ Deleting = "Deleting",
314
+ Failed = "Failed",
315
+ Moving = "Moving",
316
+ SoftDeleted = "SoftDeleted",
317
+ SoftDeleting = "SoftDeleting",
318
+ Succeeded = "Succeeded",
319
+ Unknown = "Unknown"
320
+ }
321
+
322
+ // @public
323
+ export enum KnownPublicNetworkAccess {
324
+ Disabled = "Disabled",
325
+ Enabled = "Enabled",
326
+ NotSpecified = "NotSpecified"
327
+ }
328
+
329
+ // @public
330
+ export enum KnownReason {
331
+ AlreadyExists = "AlreadyExists",
332
+ Invalid = "Invalid"
333
+ }
334
+
335
+ // @public
336
+ export enum KnownScopeType {
337
+ Subscription = "Subscription",
338
+ Tenant = "Tenant"
339
+ }
340
+
341
+ // @public
342
+ export enum KnownStatus {
343
+ Approved = "Approved",
344
+ Disconnected = "Disconnected",
345
+ Pending = "Pending",
346
+ Rejected = "Rejected",
347
+ Unknown = "Unknown"
348
+ }
349
+
350
+ // @public
351
+ export enum KnownType {
352
+ None = "None",
353
+ SystemAssigned = "SystemAssigned",
354
+ UserAssigned = "UserAssigned"
355
+ }
356
+
357
+ // @public
358
+ export type LastModifiedByType = string;
359
+
360
+ // @public
361
+ export interface ManagedResources {
362
+ readonly eventHubNamespace?: string;
363
+ readonly resourceGroup?: string;
364
+ readonly storageAccount?: string;
365
+ }
366
+
367
+ // @public
368
+ export type Name = string;
369
+
370
+ // @public
371
+ export interface Operation {
372
+ display?: OperationDisplay;
373
+ isDataAction?: boolean;
374
+ name?: string;
375
+ origin?: string;
376
+ serviceSpecification?: OperationMetaServiceSpecification;
377
+ }
378
+
379
+ // @public
380
+ export interface OperationDisplay {
381
+ description?: string;
382
+ operation?: string;
383
+ provider?: string;
384
+ resource?: string;
385
+ }
386
+
387
+ // @public
388
+ export interface OperationList {
389
+ count?: number;
390
+ nextLink?: string;
391
+ value: Operation[];
392
+ }
393
+
394
+ // @public
395
+ export interface OperationMetaLogSpecification {
396
+ blobDuration?: string;
397
+ displayName?: string;
398
+ name?: string;
399
+ }
400
+
401
+ // @public
402
+ export interface OperationMetaMetricSpecification {
403
+ aggregationType?: string;
404
+ dimensions?: DimensionProperties[];
405
+ displayDescription?: string;
406
+ displayName?: string;
407
+ enableRegionalMdmAccount?: string;
408
+ internalMetricName?: string;
409
+ name?: string;
410
+ resourceIdDimensionNameOverride?: string;
411
+ sourceMdmNamespace?: string;
412
+ supportedAggregationTypes?: string[];
413
+ supportedTimeGrainTypes?: string[];
414
+ unit?: string;
415
+ }
416
+
417
+ // @public
418
+ export interface OperationMetaServiceSpecification {
419
+ logSpecifications?: OperationMetaLogSpecification[];
420
+ metricSpecifications?: OperationMetaMetricSpecification[];
421
+ }
422
+
423
+ // @public
424
+ export interface Operations {
425
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
426
+ }
427
+
428
+ // @public
429
+ export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
430
+ }
431
+
432
+ // @public
433
+ export type OperationsListNextResponse = OperationList;
434
+
435
+ // @public
436
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
437
+ }
438
+
439
+ // @public
440
+ export type OperationsListResponse = OperationList;
441
+
442
+ // @public
443
+ export interface PrivateEndpoint {
444
+ id?: string;
445
+ }
446
+
447
+ // @public
448
+ export interface PrivateEndpointConnection extends ProxyResource {
449
+ privateEndpoint?: PrivateEndpoint;
450
+ privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
451
+ readonly provisioningState?: string;
452
+ }
453
+
454
+ // @public
455
+ export interface PrivateEndpointConnectionList {
456
+ count?: number;
457
+ nextLink?: string;
458
+ value: PrivateEndpointConnection[];
459
+ }
460
+
461
+ // @public
462
+ export interface PrivateEndpointConnections {
463
+ beginCreateOrUpdate(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, request: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
464
+ beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, request: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse>;
465
+ beginDelete(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
466
+ beginDeleteAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
467
+ get(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
468
+ listByAccount(resourceGroupName: string, accountName: string, options?: PrivateEndpointConnectionsListByAccountOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
469
+ }
470
+
471
+ // @public
472
+ export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
473
+ resumeFrom?: string;
474
+ updateIntervalInMs?: number;
475
+ }
476
+
477
+ // @public
478
+ export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
479
+
480
+ // @public
481
+ export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
482
+ resumeFrom?: string;
483
+ updateIntervalInMs?: number;
484
+ }
485
+
486
+ // @public
487
+ export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
488
+ }
489
+
490
+ // @public
491
+ export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
492
+
493
+ // @public
494
+ export interface PrivateEndpointConnectionsListByAccountNextOptionalParams extends coreClient.OperationOptions {
495
+ skipToken?: string;
496
+ }
497
+
498
+ // @public
499
+ export type PrivateEndpointConnectionsListByAccountNextResponse = PrivateEndpointConnectionList;
500
+
501
+ // @public
502
+ export interface PrivateEndpointConnectionsListByAccountOptionalParams extends coreClient.OperationOptions {
503
+ skipToken?: string;
504
+ }
505
+
506
+ // @public
507
+ export type PrivateEndpointConnectionsListByAccountResponse = PrivateEndpointConnectionList;
508
+
509
+ // @public
510
+ export interface PrivateLinkResource {
511
+ readonly id?: string;
512
+ readonly name?: string;
513
+ readonly properties?: PrivateLinkResourceProperties;
514
+ readonly type?: string;
515
+ }
516
+
517
+ // @public
518
+ export interface PrivateLinkResourceList {
519
+ count?: number;
520
+ nextLink?: string;
521
+ value: PrivateLinkResource[];
522
+ }
523
+
524
+ // @public
525
+ export interface PrivateLinkResourceProperties {
526
+ readonly groupId?: string;
527
+ readonly requiredMembers?: string[];
528
+ readonly requiredZoneNames?: string[];
529
+ }
530
+
531
+ // @public
532
+ export interface PrivateLinkResources {
533
+ getByGroupId(resourceGroupName: string, accountName: string, groupId: string, options?: PrivateLinkResourcesGetByGroupIdOptionalParams): Promise<PrivateLinkResourcesGetByGroupIdResponse>;
534
+ listByAccount(resourceGroupName: string, accountName: string, options?: PrivateLinkResourcesListByAccountOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
535
+ }
536
+
537
+ // @public
538
+ export interface PrivateLinkResourcesGetByGroupIdOptionalParams extends coreClient.OperationOptions {
539
+ }
540
+
541
+ // @public
542
+ export type PrivateLinkResourcesGetByGroupIdResponse = PrivateLinkResource;
543
+
544
+ // @public
545
+ export interface PrivateLinkResourcesListByAccountNextOptionalParams extends coreClient.OperationOptions {
546
+ }
547
+
548
+ // @public
549
+ export type PrivateLinkResourcesListByAccountNextResponse = PrivateLinkResourceList;
550
+
551
+ // @public
552
+ export interface PrivateLinkResourcesListByAccountOptionalParams extends coreClient.OperationOptions {
553
+ }
554
+
555
+ // @public
556
+ export type PrivateLinkResourcesListByAccountResponse = PrivateLinkResourceList;
557
+
558
+ // @public
559
+ export interface PrivateLinkServiceConnectionState {
560
+ actionsRequired?: string;
561
+ description?: string;
562
+ status?: Status;
563
+ }
564
+
565
+ // @public
566
+ export type ProvisioningState = string;
567
+
568
+ // @public
569
+ export interface ProxyResource {
570
+ readonly id?: string;
571
+ readonly name?: string;
572
+ readonly type?: string;
573
+ }
574
+
575
+ // @public
576
+ export type PublicNetworkAccess = string;
577
+
578
+ // @public (undocumented)
579
+ export class PurviewManagementClient extends coreClient.ServiceClient {
580
+ // (undocumented)
581
+ $host: string;
582
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PurviewManagementClientOptionalParams);
583
+ // (undocumented)
584
+ accounts: Accounts;
585
+ // (undocumented)
586
+ apiVersion: string;
587
+ // (undocumented)
588
+ defaultAccounts: DefaultAccounts;
589
+ // (undocumented)
590
+ operations: Operations;
591
+ // (undocumented)
592
+ privateEndpointConnections: PrivateEndpointConnections;
593
+ // (undocumented)
594
+ privateLinkResources: PrivateLinkResources;
595
+ // (undocumented)
596
+ subscriptionId: string;
597
+ }
598
+
599
+ // @public
600
+ export interface PurviewManagementClientOptionalParams extends coreClient.ServiceClientOptions {
601
+ $host?: string;
602
+ apiVersion?: string;
603
+ endpoint?: string;
604
+ }
605
+
606
+ // @public
607
+ export type Reason = string;
608
+
609
+ // @public
610
+ export type ScopeType = string;
611
+
612
+ // @public
613
+ export type Status = string;
614
+
615
+ // @public
616
+ export interface SystemData {
617
+ readonly createdAt?: Date;
618
+ readonly createdBy?: string;
619
+ readonly createdByType?: CreatedByType;
620
+ readonly lastModifiedAt?: Date;
621
+ readonly lastModifiedBy?: string;
622
+ readonly lastModifiedByType?: LastModifiedByType;
623
+ }
624
+
625
+ // @public
626
+ export interface TrackedResource {
627
+ readonly id?: string;
628
+ identity?: Identity;
629
+ location?: string;
630
+ readonly name?: string;
631
+ readonly systemData?: TrackedResourceSystemData;
632
+ tags?: {
633
+ [propertyName: string]: string;
634
+ };
635
+ readonly type?: string;
636
+ }
637
+
638
+ // @public
639
+ export interface TrackedResourceSystemData extends SystemData {
640
+ }
641
+
642
+ // @public
643
+ export type Type = string;
644
+
645
+ // @public
646
+ export interface UserAssignedIdentity {
647
+ readonly clientId?: string;
648
+ readonly principalId?: string;
649
+ }
650
+
651
+ // (No @packageDocumentation comment for this package)
652
+
653
+ ```