[Hub Generated] Review request for Microsoft.DigitalTwins to add version preview/2021-06-30-preview

[dejimarquis]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

1. What's the purpose of the update?
   • new service onboarding
   • new API version
   • update existing version for new feature
   • update existing version to fix swagger quality issue in s360
   • Other, please clarify
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

• I commit to follow the Breaking Change Policy of "no breaking changes"
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

• Change to data plane APIs
• Adding new properties
• All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

• Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version
    -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

• Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

[openapi-workflow-bot]

Hi, @dejimarquis Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.9.7)]	new version	base version
digitaltwins.json	2021-06-30-preview(a9e1de7)	2021-06-30-preview(main)

Rule	Message
❌ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2104:9 Old: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2104:9
❌ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2122:9 Old: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2121:9

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2021-06-30-preview	package-2021-06-30-preview(a9e1de7)	package-2021-06-30-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ R4037 - MissingTypeObject	The schema 'DigitalTwinsResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1251
❌ R4037 - MissingTypeObject	The schema 'DigitalTwinsIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1302
❌ R4037 - MissingTypeObject	The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1331
❌ R4037 - MissingTypeObject	The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1340
❌ R4037 - MissingTypeObject	The schema 'DigitalTwinsEndpointResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1603
❌ R4037 - MissingTypeObject	The schema 'DigitalTwinsEndpointResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1620
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1353
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1391
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1244
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1841
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2001
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L642
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L729
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'endpoints' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1603
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'privateLinkResources' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1837
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'privateEndpointConnections' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1980
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'timeSeriesDatabaseConnections' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L2059
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1420
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2021-06-30-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L4

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️❌~[Staging] ServiceAPIReadinessTest: 14 Errors, 0 Warnings failed [Detail]

Test run on tag: package-2021-06-30-preview, operation coverage: 22/22, failed operations: 7

Service API Readiness Test failed. Check pipeline artifact for detail report.

Rule	Message
❌ CLIENT_ERROR	"statusCode: 409, errorCode: Conflict, errorMessage: Can't update instance SubscriptionId: db5eb68e-73e2-4fa8-b18a-46cd1be4cce5, ResourceGroup: apiTest-TybaRU, ResourceName : resourcena5yifrb state from Activating to Updating"
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 409"
❌ CLIENT_ERROR	"statusCode: 400, errorCode: BadRequest, errorMessage: Cannot perform action while Digital Twins instance is in 'Activating' state. Instance must be in state 'Active'."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 400"
❌ CLIENT_ERROR	"statusCode: 404, errorCode: NotFound, errorMessage: The time series database connection was not found."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 404"
❌ CLIENT_ERROR	"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 404"
❌ CLIENT_ERROR	"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 404"
❌ CLIENT_ERROR	"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 404"
❌ CLIENT_ERROR	"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found."
❌ ASSERTION_ERROR	"expected response code to be 2XX but found 404"

️⚠️~[Staging] TrafficValidation: 1 Warnings warning [Detail]

restlerResult: Request coverage (successful / total): 7 / 22 Attempted requests: 10 / 22
Traffic validation failed. Check pipeline artifact for restler output and detail report.

Rule	Message
⚠️ Traffic validation result.	"Starting task Test...\nUsing python: 'python3' (Python 3.10.5)\nRequest coverage (successful / total): 7 / 22\nAttempted requests: 10 / 22\nNo bugs were found.\nTask Test succeeded.\nCollecting logs...\n"

️❌ModelValidation: 8 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L187:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsPatch_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L187:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsPatch_WithIdentity_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L187:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsPatch_WithPublicNetworkAccess.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L237:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsDelete_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L237:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsDelete_WithIdentity_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L451:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsEndpointDelete_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L451:22 ExampleUrl: preview/2021-06-30-preview/examples/DigitalTwinsEndpointDelete_WithIdentity_example.json
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json#L1093:22 ExampleUrl: preview/2021-06-30-preview/examples/TimeSeriesDatabaseConnectionsDelete_example.json

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

• The following tags are being changed in this PR
• "https://github.com/Azure/azure-rest-api-specs/blob/a9e1de7022faab4cfcaf330443a1933d95ccfd38/specification/digitaltwins/resource-manager/readme.md#tag-package-2021-06-30-preview">digitaltwins/resource-manager/readme.md#package-2021-06-30-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"digitaltwins/resource-manager/readme.md", "tag":"package-2021-06-30-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 4b5fe2f. SDK Automation 14.0.0

  command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
  cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
  command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

• ️✔️track2_azure-mgmt-digitaltwins [View full logs]  [Release SDK Changes]
  • azure-mgmt-digitaltwins-6.2.0.zip
  • azure_mgmt_digitaltwins-6.2.0-py3-none-any.whl

  info	[Changelog]

️⚠️ azure-sdk-for-java warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 4b5fe2f. SDK Automation 14.0.0

  command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
  command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  cmderr	[generate.py] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.

• ️✔️azure-resourcemanager-digitaltwins [View full logs]  [Release SDK Changes]
  • pom.xml
  • azure-resourcemanager-digitaltwins-1.1.0-beta.1-sources.jar
  • azure-resourcemanager-digitaltwins-1.1.0-beta.1.jar

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 4b5fe2f. SDK Automation 14.0.0

  command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
  command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

• ️✔️sdk/resourcemanager/digitaltwins/armdigitaltwins [View full logs]  [Release SDK Changes]

  info	[Changelog] ### Other Changes
  info	[Changelog]
  info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 4b5fe2f. SDK Automation 14.0.0

  command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
  warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
  command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

• ️✔️@azure/arm-digitaltwins [View full logs]  [Release SDK Changes]
  • azure-arm-digitaltwins-3.2.0.tgz

  info	[Changelog] **Features**
  info	[Changelog]
  info	[Changelog]   - Added Interface AzureDataExplorerConnectionProperties
  info	[Changelog]   - Added Interface ConnectionPropertiesPrivateLinkServiceConnectionState
  info	[Changelog]   - Added Interface DigitalTwinsDescription
  info	[Changelog]   - Added Interface DigitalTwinsEndpointResource
  info	[Changelog]   - Added Interface EventGrid
  info	[Changelog]   - Added Interface EventHub
  info	[Changelog]   - Added Interface ServiceBus
  info	[Changelog]   - Added Interface TimeSeriesDatabaseConnection

️⚠️ azure-resource-manager-schemas warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 4b5fe2f. Schema Automation 14.0.0

  command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
  cmderr	[initScript.sh] WARN old lockfile
  cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
  cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
  cmderr	[initScript.sh] npm WARN old lockfile
  cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
  cmderr	[initScript.sh] npm WARN old lockfile
  warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
  command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

• ️✔️digitaltwins [View full logs]  [Release Schema Changes]

️️✔️ azure-powershell succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 4b5fe2f. SDK Automation 14.0.0

  command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
  command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

• ️✔️Az.DigitalTwins [View full logs]  [Release SDK Changes]
  • Az.DigitalTwins.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/digitaltwins/armdigitaltwins	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Python	track2_azure-mgmt-digitaltwins	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java	azure-resourcemanager-digitaltwins	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript	@azure/arm-digitaltwins	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

[openapi-workflow-bot]

Hi @dejimarquis, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[sjiherzig]

Please note that this PR adds a default value annotation in response to a Swagger Correctness alert. The service has always been producing a default value for adxTableName and eventHubConsumerGroup, but it was previously not explicitly specified in the swagger.