@azure/arm-databasewatcher 1.0.0-beta.1

package/review/arm-databasewatcher.api.md

@@ -0,0 +1,562 @@
+## API Report File for "@azure/arm-databasewatcher"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type AlertRuleCreationProperties = string;
+
+// @public
+export interface AlertRuleResource extends ProxyResource {
+    properties?: AlertRuleResourceProperties;
+}
+
+// @public
+export interface AlertRuleResourceProperties {
+    alertRuleResourceId: string;
+    alertRuleTemplateId: string;
+    alertRuleTemplateVersion: string;
+    createdWithProperties: AlertRuleCreationProperties;
+    creationTime: Date;
+    readonly provisioningState?: ResourceProvisioningState;
+}
+
+// @public
+export interface AlertRuleResourcesCreateOrUpdateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface AlertRuleResourcesDeleteOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface AlertRuleResourcesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface AlertRuleResourcesListByParentOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface AlertRuleResourcesOperations {
+    createOrUpdate: (resourceGroupName: string, watcherName: string, alertRuleResourceName: string, resource: AlertRuleResource, options?: AlertRuleResourcesCreateOrUpdateOptionalParams) => Promise<AlertRuleResource>;
+    delete: (resourceGroupName: string, watcherName: string, alertRuleResourceName: string, options?: AlertRuleResourcesDeleteOptionalParams) => Promise<void>;
+    get: (resourceGroupName: string, watcherName: string, alertRuleResourceName: string, options?: AlertRuleResourcesGetOptionalParams) => Promise<AlertRuleResource>;
+    listByParent: (resourceGroupName: string, watcherName: string, options?: AlertRuleResourcesListByParentOptionalParams) => PagedAsyncIterableIterator<AlertRuleResource>;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public (undocumented)
+export class DatabaseWatcherClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: DatabaseWatcherClientOptionalParams);
+    readonly alertRuleResources: AlertRuleResourcesOperations;
+    readonly healthValidations: HealthValidationsOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+    readonly sharedPrivateLinkResources: SharedPrivateLinkResourcesOperations;
+    readonly targets: TargetsOperations;
+    readonly watchers: WatchersOperations;
+}
+
+// @public
+export interface DatabaseWatcherClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export type DatabaseWatcherProvisioningState = string;
+
+// @public
+export interface Datastore {
+    adxClusterResourceId?: string;
+    kustoClusterDisplayName?: string;
+    kustoClusterUri: string;
+    kustoDatabaseName: string;
+    kustoDataIngestionUri: string;
+    kustoManagementUrl: string;
+    kustoOfferingType: KustoOfferingType;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, any>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface HealthValidation extends ProxyResource {
+    properties?: HealthValidationProperties;
+}
+
+// @public
+export interface HealthValidationProperties {
+    readonly endTime: Date;
+    readonly issues: ValidationIssue[];
+    readonly provisioningState?: ResourceProvisioningState;
+    readonly startTime: Date;
+    readonly status: ValidationStatus;
+}
+
+// @public
+export interface HealthValidationsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface HealthValidationsListByParentOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface HealthValidationsOperations {
+    get: (resourceGroupName: string, watcherName: string, healthValidationName: string, options?: HealthValidationsGetOptionalParams) => Promise<HealthValidation>;
+    listByParent: (resourceGroupName: string, watcherName: string, options?: HealthValidationsListByParentOptionalParams) => PagedAsyncIterableIterator<HealthValidation>;
+    startValidation: (resourceGroupName: string, watcherName: string, healthValidationName: string, options?: HealthValidationsStartValidationOptionalParams) => PollerLike<OperationState<HealthValidation>, HealthValidation>;
+}
+
+// @public
+export interface HealthValidationsStartValidationOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAlertRuleCreationProperties {
+    CreatedWithActionGroup = "CreatedWithActionGroup",
+    None = "None"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownDatabaseWatcherProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownKustoOfferingType {
+    Adx = "adx",
+    Fabric = "fabric",
+    Free = "free"
+}
+
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAndUserAssigned = "SystemAssigned, UserAssigned",
+    SystemAssigned = "SystemAssigned",
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownSharedPrivateLinkResourceStatus {
+    Approved = "Approved",
+    Disconnected = "Disconnected",
+    Pending = "Pending",
+    Rejected = "Rejected"
+}
+
+// @public
+export enum KnownTargetAuthenticationType {
+    Aad = "Aad",
+    Sql = "Sql"
+}
+
+// @public
+export enum KnownValidationStatus {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    NotStarted = "NotStarted",
+    Running = "Running",
+    Succeeded = "Succeeded",
+    TimedOut = "TimedOut"
+}
+
+// @public
+export enum KnownVersions {
+    V20250102 = "2025-01-02"
+}
+
+// @public
+export enum KnownWatcherStatus {
+    Deleting = "Deleting",
+    Running = "Running",
+    Starting = "Starting",
+    Stopped = "Stopped",
+    Stopping = "Stopping"
+}
+
+// @public
+export type KustoOfferingType = string;
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public
+export interface ManagedServiceIdentityV4 {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: Record<string, UserAssignedIdentity>;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceProvisioningState = string;
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: DatabaseWatcherClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+
+// @public (undocumented)
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    abortSignal?: AbortSignalLike;
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SharedPrivateLinkResource extends ProxyResource {
+    properties?: SharedPrivateLinkResourceProperties;
+}
+
+// @public
+export interface SharedPrivateLinkResourceProperties {
+    dnsZone?: string;
+    groupId: string;
+    privateLinkResourceId: string;
+    readonly provisioningState?: ResourceProvisioningState;
+    requestMessage: string;
+    readonly status?: SharedPrivateLinkResourceStatus;
+}
+
+// @public
+export interface SharedPrivateLinkResourcesCreateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SharedPrivateLinkResourcesDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SharedPrivateLinkResourcesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface SharedPrivateLinkResourcesListByWatcherOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface SharedPrivateLinkResourcesOperations {
+    create: (resourceGroupName: string, watcherName: string, sharedPrivateLinkResourceName: string, resource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOptionalParams) => PollerLike<OperationState<SharedPrivateLinkResource>, SharedPrivateLinkResource>;
+    delete: (resourceGroupName: string, watcherName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, watcherName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams) => Promise<SharedPrivateLinkResource>;
+    listByWatcher: (resourceGroupName: string, watcherName: string, options?: SharedPrivateLinkResourcesListByWatcherOptionalParams) => PagedAsyncIterableIterator<SharedPrivateLinkResource>;
+}
+
+// @public
+export type SharedPrivateLinkResourceStatus = string;
+
+// @public
+export interface SqlDbElasticPoolTargetProperties extends TargetProperties {
+    anchorDatabaseResourceId: string;
+    readIntent?: boolean;
+    sqlEpResourceId: string;
+    targetType: "SqlEp";
+}
+
+// @public
+export interface SqlDbSingleDatabaseTargetProperties extends TargetProperties {
+    readIntent?: boolean;
+    sqlDbResourceId: string;
+    targetType: "SqlDb";
+}
+
+// @public
+export interface SqlMiTargetProperties extends TargetProperties {
+    connectionTcpPort?: number;
+    readIntent?: boolean;
+    sqlMiResourceId: string;
+    targetType: "SqlMi";
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface Target extends ProxyResource {
+    properties?: TargetPropertiesUnion;
+}
+
+// @public
+export type TargetAuthenticationType = string;
+
+// @public
+export interface TargetProperties {
+    connectionServerName: string;
+    readonly provisioningState?: ResourceProvisioningState;
+    targetAuthenticationType: TargetAuthenticationType;
+    targetType: string;
+    targetVault?: VaultSecret;
+}
+
+// @public
+export type TargetPropertiesUnion = SqlDbSingleDatabaseTargetProperties | SqlDbElasticPoolTargetProperties | SqlMiTargetProperties | TargetProperties;
+
+// @public
+export interface TargetsCreateOrUpdateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface TargetsDeleteOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface TargetsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface TargetsListByWatcherOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface TargetsOperations {
+    createOrUpdate: (resourceGroupName: string, watcherName: string, targetName: string, resource: Target, options?: TargetsCreateOrUpdateOptionalParams) => Promise<Target>;
+    delete: (resourceGroupName: string, watcherName: string, targetName: string, options?: TargetsDeleteOptionalParams) => Promise<void>;
+    get: (resourceGroupName: string, watcherName: string, targetName: string, options?: TargetsGetOptionalParams) => Promise<Target>;
+    listByWatcher: (resourceGroupName: string, watcherName: string, options?: TargetsListByWatcherOptionalParams) => PagedAsyncIterableIterator<Target>;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// @public
+export interface ValidationIssue {
+    readonly additionalDetails?: string;
+    readonly errorCode: string;
+    readonly errorMessage: string;
+    readonly recommendationMessage: string;
+    readonly recommendationUrl?: string;
+    readonly relatedResourceId?: string;
+    readonly relatedResourceType?: string;
+}
+
+// @public
+export type ValidationStatus = string;
+
+// @public
+export interface VaultSecret {
+    akvResourceId?: string;
+    akvTargetPassword?: string;
+    akvTargetUser?: string;
+}
+
+// @public
+export interface Watcher extends TrackedResource {
+    identity?: ManagedServiceIdentityV4;
+    properties?: WatcherProperties;
+}
+
+// @public
+export interface WatcherProperties {
+    datastore?: Datastore;
+    defaultAlertRuleIdentityResourceId?: string;
+    readonly provisioningState?: DatabaseWatcherProvisioningState;
+    readonly status?: WatcherStatus;
+}
+
+// @public
+export interface WatchersCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WatchersDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WatchersGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WatchersListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WatchersListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WatchersOperations {
+    createOrUpdate: (resourceGroupName: string, watcherName: string, resource: Watcher, options?: WatchersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Watcher>, Watcher>;
+    delete: (resourceGroupName: string, watcherName: string, options?: WatchersDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, watcherName: string, options?: WatchersGetOptionalParams) => Promise<Watcher>;
+    listByResourceGroup: (resourceGroupName: string, options?: WatchersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Watcher>;
+    listBySubscription: (options?: WatchersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Watcher>;
+    start: (resourceGroupName: string, watcherName: string, options?: WatchersStartOptionalParams) => PollerLike<OperationState<void>, void>;
+    stop: (resourceGroupName: string, watcherName: string, options?: WatchersStopOptionalParams) => PollerLike<OperationState<void>, void>;
+    update: (resourceGroupName: string, watcherName: string, properties: WatcherUpdate, options?: WatchersUpdateOptionalParams) => PollerLike<OperationState<Watcher>, Watcher>;
+}
+
+// @public
+export interface WatchersStartOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WatchersStopOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type WatcherStatus = string;
+
+// @public
+export interface WatchersUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WatcherUpdate {
+    identity?: ManagedServiceIdentityV4;
+    properties?: WatcherUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface WatcherUpdateProperties {
+    datastore?: Datastore;
+    defaultAlertRuleIdentityResourceId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```