[AutoPR @azure/arm-digitaltwins] [Hub Generated] Review request for Microsoft.DigitalTwins to add version stable/2023-01-31

sdk/digitaltwins/arm-digitaltwins/CHANGELOG.md

@@ -1,15 +1,19 @@
 # Release History
+
+## 3.3.0 (2023-02-16)
+
+**Features**
 
-## 3.2.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
+  - Added Type Alias CleanupConnectionArtifacts
+  - Added Type Alias RecordPropertyAndItemRemovals
+  - Interface AzureDataExplorerConnectionProperties has a new optional parameter adxRelationshipLifecycleEventsTableName
+  - Interface AzureDataExplorerConnectionProperties has a new optional parameter adxTwinLifecycleEventsTableName
+  - Interface AzureDataExplorerConnectionProperties has a new optional parameter recordPropertyAndItemRemovals
+  - Interface TimeSeriesDatabaseConnectionsDeleteOptionalParams has a new optional parameter cleanupConnectionArtifacts
+  - Added Enum KnownCleanupConnectionArtifacts
+  - Added Enum KnownRecordPropertyAndItemRemovals
+    
+    
 ## 3.2.0 (2022-11-30)
 
 **Features**

sdk/digitaltwins/arm-digitaltwins/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Microsoft
+Copyright (c) 2023 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

sdk/digitaltwins/arm-digitaltwins/_meta.json

@@ -1,8 +1,8 @@
 {
-  "commit": "2f2e48923cebd95f7d184608a29bcd06d9cb3653",
+  "commit": "e2b5c08c05b34eb5883bdcce73635588f60002f7",
   "readme": "specification/digitaltwins/resource-manager/readme.md",
-  "autorest_command": "autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\digitaltwins\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.3.20221108.1 --generate-sample=true",
+  "autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/digitaltwins/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.5",
   "repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
-  "release_tool": "@azure-tools/js-sdk-release-tools@2.4.2",
-  "use": "@autorest/typescript@6.0.0-rc.3.20221108.1"
+  "release_tool": "@azure-tools/js-sdk-release-tools@2.6.2",
+  "use": "@autorest/typescript@6.0.0-rc.5"
 }

sdk/digitaltwins/arm-digitaltwins/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for AzureDigitalTwinsManagementClient.",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -29,9 +29,9 @@
   "types": "./types/arm-digitaltwins.d.ts",
   "devDependencies": {
     "@microsoft/api-extractor": "^7.31.1",
-    "@rollup/plugin-commonjs": "^24.0.0",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-multi-entry": "^6.0.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-multi-entry": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "mkdirp": "^1.0.4",
     "rollup": "^2.66.1",
@@ -110,13 +110,5 @@
       }
     ]
   },
-  "autoPublish": true,
-  "//sampleConfiguration": {
-    "productName": "",
-    "productSlugs": [
-      "azure"
-    ],
-    "disableDocsMs": true,
-    "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-digitaltwins?view=azure-node-preview"
-  }
-}
+  "autoPublish": true
+}

sdk/digitaltwins/arm-digitaltwins/review/arm-digitaltwins.api.md

@@ -17,13 +17,16 @@ export type AuthenticationType = string;
 export interface AzureDataExplorerConnectionProperties extends TimeSeriesDatabaseConnectionProperties {
     adxDatabaseName: string;
     adxEndpointUri: string;
+    adxRelationshipLifecycleEventsTableName?: string;
     adxResourceId: string;
     adxTableName?: string;
+    adxTwinLifecycleEventsTableName?: string;
     connectionType: "AzureDataExplorer";
     eventHubConsumerGroup?: string;
     eventHubEndpointUri: string;
     eventHubEntityPath: string;
     eventHubNamespaceResourceId: string;
+    recordPropertyAndItemRemovals?: RecordPropertyAndItemRemovals;
 }
 
 // @public (undocumented)
@@ -69,6 +72,9 @@ export interface CheckNameResult {
     reason?: Reason;
 }
 
+// @public
+export type CleanupConnectionArtifacts = string;
+
 // @public
 export interface ConnectionProperties {
     groupIds?: string[];
@@ -385,6 +391,12 @@ export enum KnownAuthenticationType {
     KeyBased = "KeyBased"
 }
 
+// @public
+export enum KnownCleanupConnectionArtifacts {
+    False = "false",
+    True = "true"
+}
+
 // @public
 export enum KnownConnectionPropertiesProvisioningState {
     Approved = "Approved",
@@ -478,6 +490,12 @@ export enum KnownReason {
     Invalid = "Invalid"
 }
 
+// @public
+export enum KnownRecordPropertyAndItemRemovals {
+    False = "false",
+    True = "true"
+}
+
 // @public
 export enum KnownTimeSeriesDatabaseConnectionState {
     Canceled = "Canceled",
@@ -634,6 +652,9 @@ export type PublicNetworkAccess = string;
 // @public
 export type Reason = string;
 
+// @public
+export type RecordPropertyAndItemRemovals = string;
+
 // @public
 export interface ServiceBus extends DigitalTwinsEndpointResourceProperties {
     endpointType: "ServiceBus";
@@ -695,6 +716,7 @@ export type TimeSeriesDatabaseConnectionsCreateOrUpdateResponse = TimeSeriesData
 
 // @public
 export interface TimeSeriesDatabaseConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+    cleanupConnectionArtifacts?: CleanupConnectionArtifacts;
     resumeFrom?: string;
     updateIntervalInMs?: number;
 }

sdk/digitaltwins/arm-digitaltwins/src/azureDigitalTwinsManagementClient.ts

@@ -64,7 +64,7 @@ export class AzureDigitalTwinsManagementClient extends coreClient.ServiceClient
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-digitaltwins/3.2.1`;
+    const packageDetails = `azsdk-js-arm-digitaltwins/3.3.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -117,7 +117,7 @@ export class AzureDigitalTwinsManagementClient extends coreClient.ServiceClient
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-10-31";
+    this.apiVersion = options.apiVersion || "2023-01-31";
     this.digitalTwins = new DigitalTwinsImpl(this);
     this.digitalTwinsEndpoint = new DigitalTwinsEndpointImpl(this);
     this.operations = new OperationsImpl(this);

sdk/digitaltwins/arm-digitaltwins/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. */

sdk/digitaltwins/arm-digitaltwins/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"
+        }
       }
     }
   }

sdk/digitaltwins/arm-digitaltwins/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"
+    }
+  }
+};

sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwins.ts

@@ -741,7 +741,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -761,7 +760,6 @@ const listByResourceGroupNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwinsEndpoint.ts

@@ -493,7 +493,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

sdk/digitaltwins/arm-digitaltwins/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