From 40fefb61824cc06186898162f478f0df5b59d7b8 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Thu, 16 Feb 2023 03:09:14 +0000 Subject: [PATCH] CodeGen from PR 21643 in Azure/azure-rest-api-specs Merge 0f20935eef0448bb02566b44d5b09cce777c2341 into c3daf5a8d294e2cfe91307286d7c58f6311b4c89 --- common/config/rush/pnpm-lock.yaml | 13 +++--- .../arm-digitaltwins/CHANGELOG.md | 24 ++++++---- sdk/digitaltwins/arm-digitaltwins/LICENSE | 2 +- sdk/digitaltwins/arm-digitaltwins/_meta.json | 8 ++-- .../arm-digitaltwins/package.json | 20 +++----- .../review/arm-digitaltwins.api.md | 22 +++++++++ .../src/azureDigitalTwinsManagementClient.ts | 4 +- .../arm-digitaltwins/src/models/index.ts | 46 ++++++++++++++++++- .../arm-digitaltwins/src/models/mappers.ts | 22 +++++++++ .../arm-digitaltwins/src/models/parameters.ts | 12 ++++- .../src/operations/digitalTwins.ts | 2 - .../src/operations/digitalTwinsEndpoint.ts | 1 - .../src/operations/operations.ts | 1 - .../timeSeriesDatabaseConnections.ts | 6 ++- .../arm-digitaltwins/src/pagingHelper.ts | 8 ++-- .../arm-digitaltwins/test/sampleTest.ts | 43 +++++++++++++++++ .../arm-digitaltwins/tsconfig.json | 10 +--- 17 files changed, 186 insertions(+), 58 deletions(-) create mode 100644 sdk/digitaltwins/arm-digitaltwins/test/sampleTest.ts diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 7b9af74c3d6a..c5d7e3bbdda8 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -11726,15 +11726,15 @@ packages: dev: false file:projects/arm-digitaltwins.tgz: - resolution: {integrity: sha512-svnRvsCdoUvQfyHKEk29MPJXUO3mQYmR9/iB1ZQFu0fSBzDOTAAgRk4Jhg0A8esToT8DpbsBJMK+5q7ti7HhuQ==, tarball: file:projects/arm-digitaltwins.tgz} + resolution: {integrity: sha512-rxjJZrgUVA1KMDT4YTZlyYV6pBbKpYNpsbemLUsdv4oXKamqY3kaK+zUjWH55TdORDD6nKsx82JIvezRfNgCAQ==, tarball: file:projects/arm-digitaltwins.tgz} name: '@rush-temp/arm-digitaltwins' version: 0.0.0 dependencies: '@azure/identity': 2.1.0 '@microsoft/api-extractor': 7.34.3_@types+node@14.18.36 - '@rollup/plugin-commonjs': 24.0.1_rollup@2.79.1 - '@rollup/plugin-json': 6.0.0_rollup@2.79.1 - '@rollup/plugin-multi-entry': 6.0.0_rollup@2.79.1 + '@rollup/plugin-commonjs': 21.1.0_rollup@2.79.1 + '@rollup/plugin-json': 4.1.0_rollup@2.79.1 + '@rollup/plugin-multi-entry': 4.1.0_rollup@2.79.1 '@rollup/plugin-node-resolve': 13.3.0_rollup@2.79.1 '@types/chai': 4.3.4 '@types/node': 14.18.36 @@ -17893,7 +17893,7 @@ packages: dev: false file:projects/monitor-ingestion.tgz: - resolution: {integrity: sha512-CtEBzCs8gADc56AozIehMF2iu7e7R/8YroShdvL2gjK6Hol5Tz+LRfNo4m9XoM17Mwsm1VtZe6Di0vA+WdiJ3g==, tarball: file:projects/monitor-ingestion.tgz} + resolution: {integrity: sha512-zodipV0pcRnzrfWjHYqvU42+E4V7E6TqdSYdrmqk/W9isTlZ3lW7OQXvblPPmjo2gTxDBbq+MUcDJ1Bu4FPPYA==, tarball: file:projects/monitor-ingestion.tgz} name: '@rush-temp/monitor-ingestion' version: 0.0.0 dependencies: @@ -18798,7 +18798,7 @@ packages: dev: false file:projects/schema-registry-avro.tgz: - resolution: {integrity: sha512-kLU74faNZXQAJXMne2lL+AAKkVKmU8+obYvymA9G2IuJBpPraaTOxyIOypkQeZqLuWCdZgrgeCno39dVP0MLtg==, tarball: file:projects/schema-registry-avro.tgz} + resolution: {integrity: sha512-mSZh1szK6lxMnczMO7kgXzef/o22kR6Ttc0voG7IKFLpMKRq6gwvWDAtPzvAEz9qjHzskrN9Me89DaPc7H7ccw==, tarball: file:projects/schema-registry-avro.tgz} name: '@rush-temp/schema-registry-avro' version: 0.0.0 dependencies: @@ -18850,7 +18850,6 @@ packages: transitivePeerDependencies: - bufferutil - debug - - encoding - supports-color - utf-8-validate dev: false diff --git a/sdk/digitaltwins/arm-digitaltwins/CHANGELOG.md b/sdk/digitaltwins/arm-digitaltwins/CHANGELOG.md index 6a390be15c99..ab92373f7756 100644 --- a/sdk/digitaltwins/arm-digitaltwins/CHANGELOG.md +++ b/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** diff --git a/sdk/digitaltwins/arm-digitaltwins/LICENSE b/sdk/digitaltwins/arm-digitaltwins/LICENSE index 5d1d36e0af80..3a1d9b6f24f7 100644 --- a/sdk/digitaltwins/arm-digitaltwins/LICENSE +++ b/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 diff --git a/sdk/digitaltwins/arm-digitaltwins/_meta.json b/sdk/digitaltwins/arm-digitaltwins/_meta.json index e63315f28378..51c31e1d1852 100644 --- a/sdk/digitaltwins/arm-digitaltwins/_meta.json +++ b/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" } \ No newline at end of file diff --git a/sdk/digitaltwins/arm-digitaltwins/package.json b/sdk/digitaltwins/arm-digitaltwins/package.json index 836577104150..11d961d648e3 100644 --- a/sdk/digitaltwins/arm-digitaltwins/package.json +++ b/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 +} \ No newline at end of file diff --git a/sdk/digitaltwins/arm-digitaltwins/review/arm-digitaltwins.api.md b/sdk/digitaltwins/arm-digitaltwins/review/arm-digitaltwins.api.md index d103586554ee..3f14babf36a7 100644 --- a/sdk/digitaltwins/arm-digitaltwins/review/arm-digitaltwins.api.md +++ b/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; } diff --git a/sdk/digitaltwins/arm-digitaltwins/src/azureDigitalTwinsManagementClient.ts b/sdk/digitaltwins/arm-digitaltwins/src/azureDigitalTwinsManagementClient.ts index 8171879ab050..e76c4843deca 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/azureDigitalTwinsManagementClient.ts +++ b/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); diff --git a/sdk/digitaltwins/arm-digitaltwins/src/models/index.ts b/sdk/digitaltwins/arm-digitaltwins/src/models/index.ts index 7767a44fd3a4..f2f7ff0668ad 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/models/index.ts +++ b/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. */ diff --git a/sdk/digitaltwins/arm-digitaltwins/src/models/mappers.ts b/sdk/digitaltwins/arm-digitaltwins/src/models/mappers.ts index a37f096ae62f..6a00f9ef1412 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/models/mappers.ts +++ b/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" + } } } } diff --git a/sdk/digitaltwins/arm-digitaltwins/src/models/parameters.ts b/sdk/digitaltwins/arm-digitaltwins/src/models/parameters.ts index fa7ceb425b0f..9ee3c8ef75dd 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/models/parameters.ts +++ b/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" + } + } +}; diff --git a/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwins.ts b/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwins.ts index c99a35ac9bd4..ba72134ba48b 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwins.ts +++ b/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, diff --git a/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwinsEndpoint.ts b/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwinsEndpoint.ts index 177f8e572cbb..617a4fc48a4e 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/operations/digitalTwinsEndpoint.ts +++ b/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, diff --git a/sdk/digitaltwins/arm-digitaltwins/src/operations/operations.ts b/sdk/digitaltwins/arm-digitaltwins/src/operations/operations.ts index 50212b59c16d..1f4e73342df5 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/operations/operations.ts +++ b/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 diff --git a/sdk/digitaltwins/arm-digitaltwins/src/operations/timeSeriesDatabaseConnections.ts b/sdk/digitaltwins/arm-digitaltwins/src/operations/timeSeriesDatabaseConnections.ts index bcd52f99a451..8cf967b21bcf 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/operations/timeSeriesDatabaseConnections.ts +++ b/sdk/digitaltwins/arm-digitaltwins/src/operations/timeSeriesDatabaseConnections.ts @@ -482,7 +482,10 @@ const deleteOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ErrorResponse } }, - queryParameters: [Parameters.apiVersion], + queryParameters: [ + Parameters.apiVersion, + Parameters.cleanupConnectionArtifacts + ], urlParameters: [ Parameters.$host, Parameters.subscriptionId, @@ -504,7 +507,6 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ErrorResponse } }, - queryParameters: [Parameters.apiVersion], urlParameters: [ Parameters.$host, Parameters.subscriptionId, diff --git a/sdk/digitaltwins/arm-digitaltwins/src/pagingHelper.ts b/sdk/digitaltwins/arm-digitaltwins/src/pagingHelper.ts index d85fc13bce1e..269a2b9814b5 100644 --- a/sdk/digitaltwins/arm-digitaltwins/src/pagingHelper.ts +++ b/sdk/digitaltwins/arm-digitaltwins/src/pagingHelper.ts @@ -13,11 +13,11 @@ export interface PageInfo { const pageMap = new WeakMap(); /** - * Given a result page from a pageable operation, returns a - * continuation token that can be used to begin paging from + * Given the last `.value` produced by the `byPage` iterator, + * returns a continuation token that can be used to begin paging from * that point later. - * @param page A result object from calling .byPage() on a paged operation. - * @returns The continuation token that can be passed into byPage(). + * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator. + * @returns The continuation token that can be passed into byPage() during future calls. */ export function getContinuationToken(page: unknown): string | undefined { if (typeof page !== "object" || page === null) { diff --git a/sdk/digitaltwins/arm-digitaltwins/test/sampleTest.ts b/sdk/digitaltwins/arm-digitaltwins/test/sampleTest.ts new file mode 100644 index 000000000000..25aeb3ebcc36 --- /dev/null +++ b/sdk/digitaltwins/arm-digitaltwins/test/sampleTest.ts @@ -0,0 +1,43 @@ +/* + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. + */ + +import { + Recorder, + RecorderStartOptions, + env +} from "@azure-tools/test-recorder"; +import { assert } from "chai"; +import { Context } from "mocha"; + +const replaceableVariables: Record = { + AZURE_CLIENT_ID: "azure_client_id", + AZURE_CLIENT_SECRET: "azure_client_secret", + AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888", + SUBSCRIPTION_ID: "azure_subscription_id" +}; + +const recorderOptions: RecorderStartOptions = { + envSetupForPlayback: replaceableVariables +}; + +describe("My test", () => { + let recorder: Recorder; + + beforeEach(async function(this: Context) { + recorder = new Recorder(this.currentTest); + await recorder.start(recorderOptions); + }); + + afterEach(async function() { + await recorder.stop(); + }); + + it("sample test", async function() { + console.log("Hi, I'm a test!"); + }); +}); diff --git a/sdk/digitaltwins/arm-digitaltwins/tsconfig.json b/sdk/digitaltwins/arm-digitaltwins/tsconfig.json index 15e8d9a4ecc7..3e6ae96443f3 100644 --- a/sdk/digitaltwins/arm-digitaltwins/tsconfig.json +++ b/sdk/digitaltwins/arm-digitaltwins/tsconfig.json @@ -15,17 +15,11 @@ ], "declaration": true, "outDir": "./dist-esm", - "importHelpers": true, - "paths": { - "@azure/arm-digitaltwins": [ - "./src/index" - ] - } + "importHelpers": true }, "include": [ "./src/**/*.ts", - "./test/**/*.ts", - "samples-dev/**/*.ts" + "./test/**/*.ts" ], "exclude": [ "node_modules"