@azure/arm-digitaltwins 3.2.1-alpha.20230303.1 → 3.3.0

package/src/lroImpl.ts

@@ -6,29 +6,37 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { AbortSignalLike } from "@azure/abort-controller";
 import { LongRunningOperation, LroResponse } from "@azure/core-lro";
 
-export class LroImpl<T> implements LongRunningOperation<T> {
-  constructor(
-    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
-    private args: Record<string, unknown>,
-    private spec: {
-      readonly requestBody?: unknown;
-      readonly path?: string;
-      readonly httpMethod: string;
-    } & Record<string, any>,
-    public requestPath: string = spec.path!,
-    public requestMethod: string = spec.httpMethod
-  ) {}
-  public async sendInitialRequest(): Promise<LroResponse<T>> {
-    return this.sendOperationFn(this.args, this.spec);
-  }
-  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
-    const { requestBody, ...restSpec } = this.spec;
-    return this.sendOperationFn(this.args, {
-      ...restSpec,
-      path,
-      httpMethod: "GET"
-    });
-  }
+export function createLroSpec<T>(inputs: {
+  sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>;
+  args: Record<string, unknown>;
+  spec: {
+    readonly requestBody?: unknown;
+    readonly path?: string;
+    readonly httpMethod: string;
+  } & Record<string, any>;
+}): LongRunningOperation<T> {
+  const { args, spec, sendOperationFn } = inputs;
+  return {
+    requestMethod: spec.httpMethod,
+    requestPath: spec.path!,
+    sendInitialRequest: () => sendOperationFn(args, spec),
+    sendPollRequest: (
+      path: string,
+      options?: { abortSignal?: AbortSignalLike }
+    ) => {
+      const { requestBody, ...restSpec } = spec;
+      return sendOperationFn(args, {
+        ...restSpec,
+        httpMethod: "GET",
+        path,
+        abortSignal: options?.abortSignal
+      });
+    }
+  };
 }

package/src/models/index.ts

@@ -507,8 +507,12 @@ export interface AzureDataExplorerConnectionProperties
   adxEndpointUri: string;
   /** The name of the Azure Data Explorer database. */
   adxDatabaseName: string;
-  /** The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents. */
+  /** The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents. */
   adxTableName?: string;
+  /** The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified. */
+  adxTwinLifecycleEventsTableName?: string;
+  /** The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified. */
+  adxRelationshipLifecycleEventsTableName?: string;
   /** The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// */
   eventHubEndpointUri: string;
   /** The EventHub name in the EventHub namespace for identity-based authentication. */
@@ -517,6 +521,8 @@ export interface AzureDataExplorerConnectionProperties
   eventHubNamespaceResourceId: string;
   /** The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default. */
   eventHubConsumerGroup?: string;
+  /** Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX. */
+  recordPropertyAndItemRemovals?: RecordPropertyAndItemRemovals;
 }
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
@@ -864,6 +870,42 @@ export enum KnownTimeSeriesDatabaseConnectionState {
  */
 export type TimeSeriesDatabaseConnectionState = string;
 
+/** Known values of {@link CleanupConnectionArtifacts} that the service accepts. */
+export enum KnownCleanupConnectionArtifacts {
+  /** True */
+  True = "true",
+  /** False */
+  False = "false"
+}
+
+/**
+ * Defines values for CleanupConnectionArtifacts. \
+ * {@link KnownCleanupConnectionArtifacts} can be used interchangeably with CleanupConnectionArtifacts,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **true** \
+ * **false**
+ */
+export type CleanupConnectionArtifacts = string;
+
+/** Known values of {@link RecordPropertyAndItemRemovals} that the service accepts. */
+export enum KnownRecordPropertyAndItemRemovals {
+  /** True */
+  True = "true",
+  /** False */
+  False = "false"
+}
+
+/**
+ * Defines values for RecordPropertyAndItemRemovals. \
+ * {@link KnownRecordPropertyAndItemRemovals} can be used interchangeably with RecordPropertyAndItemRemovals,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **true** \
+ * **false**
+ */
+export type RecordPropertyAndItemRemovals = string;
+
 /** Optional parameters. */
 export interface DigitalTwinsGetOptionalParams
   extends coreClient.OperationOptions {}
@@ -1079,6 +1121,8 @@ export type TimeSeriesDatabaseConnectionsCreateOrUpdateResponse = TimeSeriesData
 /** Optional parameters. */
 export interface TimeSeriesDatabaseConnectionsDeleteOptionalParams
   extends coreClient.OperationOptions {
+  /** Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data. */
+  cleanupConnectionArtifacts?: CleanupConnectionArtifacts;
   /** Delay to wait until next poll, in milliseconds. */
   updateIntervalInMs?: number;
   /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */

package/src/models/mappers.ts

@@ -1212,6 +1212,20 @@ export const AzureDataExplorerConnectionProperties: coreClient.CompositeMapper =
           name: "String"
         }
       },
+      adxTwinLifecycleEventsTableName: {
+        serializedName: "adxTwinLifecycleEventsTableName",
+        nullable: true,
+        type: {
+          name: "String"
+        }
+      },
+      adxRelationshipLifecycleEventsTableName: {
+        serializedName: "adxRelationshipLifecycleEventsTableName",
+        nullable: true,
+        type: {
+          name: "String"
+        }
+      },
       eventHubEndpointUri: {
         serializedName: "eventHubEndpointUri",
         required: true,
@@ -1240,6 +1254,14 @@ export const AzureDataExplorerConnectionProperties: coreClient.CompositeMapper =
         type: {
           name: "String"
         }
+      },
+      recordPropertyAndItemRemovals: {
+        defaultValue: "false",
+        serializedName: "recordPropertyAndItemRemovals",
+        nullable: true,
+        type: {
+          name: "String"
+        }
       }
     }
   }

package/src/models/parameters.ts

@@ -47,7 +47,7 @@ export const $host: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2022-10-31",
+    defaultValue: "2023-01-31",
     isConstant: true,
     serializedName: "api-version",
     type: {
@@ -219,3 +219,13 @@ export const timeSeriesDatabaseConnectionDescription: OperationParameter = {
   parameterPath: "timeSeriesDatabaseConnectionDescription",
   mapper: TimeSeriesDatabaseConnectionMapper
 };
+
+export const cleanupConnectionArtifacts: OperationQueryParameter = {
+  parameterPath: ["options", "cleanupConnectionArtifacts"],
+  mapper: {
+    serializedName: "cleanupConnectionArtifacts",
+    type: {
+      name: "String"
+    }
+  }
+};

package/src/operations/digitalTwins.ts

@@ -13,8 +13,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { AzureDigitalTwinsManagementClient } from "../azureDigitalTwinsManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   DigitalTwinsDescription,
   DigitalTwinsListNextOptionalParams,
@@ -207,8 +211,8 @@ export class DigitalTwinsImpl implements DigitalTwins {
     digitalTwinsCreate: DigitalTwinsDescription,
     options?: DigitalTwinsCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<DigitalTwinsCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<DigitalTwinsCreateOrUpdateResponse>,
       DigitalTwinsCreateOrUpdateResponse
     >
   > {
@@ -218,7 +222,7 @@ export class DigitalTwinsImpl implements DigitalTwins {
     ): Promise<DigitalTwinsCreateOrUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -251,13 +255,16 @@ export class DigitalTwinsImpl implements DigitalTwins {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, resourceName, digitalTwinsCreate, options },
-      createOrUpdateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { resourceGroupName, resourceName, digitalTwinsCreate, options },
+      spec: createOrUpdateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DigitalTwinsCreateOrUpdateResponse,
+      OperationState<DigitalTwinsCreateOrUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -301,8 +308,8 @@ export class DigitalTwinsImpl implements DigitalTwins {
     digitalTwinsPatchDescription: DigitalTwinsPatchDescription,
     options?: DigitalTwinsUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<DigitalTwinsUpdateResponse>,
+    SimplePollerLike<
+      OperationState<DigitalTwinsUpdateResponse>,
       DigitalTwinsUpdateResponse
     >
   > {
@@ -312,7 +319,7 @@ export class DigitalTwinsImpl implements DigitalTwins {
     ): Promise<DigitalTwinsUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -345,18 +352,21 @@ export class DigitalTwinsImpl implements DigitalTwins {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      {
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
         resourceGroupName,
         resourceName,
         digitalTwinsPatchDescription,
         options
       },
-      updateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+      spec: updateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DigitalTwinsUpdateResponse,
+      OperationState<DigitalTwinsUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -396,8 +406,8 @@ export class DigitalTwinsImpl implements DigitalTwins {
     resourceName: string,
     options?: DigitalTwinsDeleteOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<DigitalTwinsDeleteResponse>,
+    SimplePollerLike<
+      OperationState<DigitalTwinsDeleteResponse>,
       DigitalTwinsDeleteResponse
     >
   > {
@@ -407,7 +417,7 @@ export class DigitalTwinsImpl implements DigitalTwins {
     ): Promise<DigitalTwinsDeleteResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -440,13 +450,16 @@ export class DigitalTwinsImpl implements DigitalTwins {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, resourceName, options },
-      deleteOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { resourceGroupName, resourceName, options },
+      spec: deleteOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DigitalTwinsDeleteResponse,
+      OperationState<DigitalTwinsDeleteResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -741,7 +754,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -761,7 +773,6 @@ const listByResourceGroupNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operations/digitalTwinsEndpoint.ts

@@ -13,8 +13,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { AzureDigitalTwinsManagementClient } from "../azureDigitalTwinsManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   DigitalTwinsEndpointResource,
   DigitalTwinsEndpointListNextOptionalParams,
@@ -169,8 +173,8 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
     endpointDescription: DigitalTwinsEndpointResource,
     options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<DigitalTwinsEndpointCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<DigitalTwinsEndpointCreateOrUpdateResponse>,
       DigitalTwinsEndpointCreateOrUpdateResponse
     >
   > {
@@ -180,7 +184,7 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
     ): Promise<DigitalTwinsEndpointCreateOrUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -213,19 +217,22 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      {
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
         resourceGroupName,
         resourceName,
         endpointName,
         endpointDescription,
         options
       },
-      createOrUpdateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+      spec: createOrUpdateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DigitalTwinsEndpointCreateOrUpdateResponse,
+      OperationState<DigitalTwinsEndpointCreateOrUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -270,8 +277,8 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
     endpointName: string,
     options?: DigitalTwinsEndpointDeleteOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<DigitalTwinsEndpointDeleteResponse>,
+    SimplePollerLike<
+      OperationState<DigitalTwinsEndpointDeleteResponse>,
       DigitalTwinsEndpointDeleteResponse
     >
   > {
@@ -281,7 +288,7 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
     ): Promise<DigitalTwinsEndpointDeleteResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -314,13 +321,16 @@ export class DigitalTwinsEndpointImpl implements DigitalTwinsEndpoint {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, resourceName, endpointName, options },
-      deleteOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { resourceGroupName, resourceName, endpointName, options },
+      spec: deleteOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DigitalTwinsEndpointDeleteResponse,
+      OperationState<DigitalTwinsEndpointDeleteResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -493,7 +503,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operations/operations.ts

@@ -143,7 +143,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

package/src/operations/privateEndpointConnections.ts

@@ -11,8 +11,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { AzureDigitalTwinsManagementClient } from "../azureDigitalTwinsManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   PrivateEndpointConnectionsListOptionalParams,
   PrivateEndpointConnectionsListResponse,
@@ -90,14 +94,14 @@ export class PrivateEndpointConnectionsImpl
     resourceName: string,
     privateEndpointConnectionName: string,
     options?: PrivateEndpointConnectionsDeleteOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>> {
+  ): Promise<SimplePollerLike<OperationState<void>, void>> {
     const directSendOperation = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ): Promise<void> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -130,18 +134,18 @@ export class PrivateEndpointConnectionsImpl
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      {
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
         resourceGroupName,
         resourceName,
         privateEndpointConnectionName,
         options
       },
-      deleteOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+      spec: deleteOperationSpec
+    });
+    const poller = await createHttpPoller<void, OperationState<void>>(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -185,8 +189,8 @@ export class PrivateEndpointConnectionsImpl
     privateEndpointConnection: PrivateEndpointConnection,
     options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>,
       PrivateEndpointConnectionsCreateOrUpdateResponse
     >
   > {
@@ -196,7 +200,7 @@ export class PrivateEndpointConnectionsImpl
     ): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -229,19 +233,22 @@ export class PrivateEndpointConnectionsImpl
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      {
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
         resourceGroupName,
         resourceName,
         privateEndpointConnectionName,
         privateEndpointConnection,
         options
       },
-      createOrUpdateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+      spec: createOrUpdateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      PrivateEndpointConnectionsCreateOrUpdateResponse,
+      OperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();