New stable API version 2022-12-12 for CORS deviceprovisioningservices microsoft.devices #21737

fmjosuel · 2022-12-02T17:35:00Z

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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:

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
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.
Dec 16, 2022
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
Dec 09, 2022
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.

…05 to version 2022-12-12

openapi-workflow-bot · 2022-12-02T17:35:04Z

Hi, @fmjosuel 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-workflow-bot · 2022-12-02T17:35:06Z

Hi, @fmjosuel your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

openapi-pipeline-app · 2022-12-02T17:35:07Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️❌Breaking Change(Cross-Version): 2 Errors, 11 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
iotdps.json	2022-12-12(5fa7a04)	2022-02-05(main)
iotdps.json	2022-12-12(5fa7a04)	2020-09-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L2303:9 Old: Microsoft.Devices/stable/2022-02-05/iotdps.json#L2291:9
`❌` 1026 - TypeChanged	The new version has a different type 'integer' than the previous one 'string'. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L2303:9 Old: Microsoft.Devices/stable/2022-02-05/iotdps.json#L2291:9

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ArmIdentity' removed or renamed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1621:3 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1607:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'EncryptionPropertiesDescription' removed or renamed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1621:3 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1607:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'EncryptionKeyIdentity' removed or renamed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1621:3 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1607:3
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L189:13 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L189:13
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1630:9 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1616:9
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L2303:9 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L2345:9
⚠️ 1026 - TypeChanged	The new version has a different type 'integer' than the previous one 'string'. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L2303:9 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L2345:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1736:9 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1714:9
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'certificate' renamed or removed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1684:7 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1656:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryption' renamed or removed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1820:7 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1794:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'identity' renamed or removed? New: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1789:7 Old: Microsoft.Devices/preview/2020-09-01-preview/iotdps.json#L1763:7

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

There is no credential detected.

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

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-12	package-2022-12(5fa7a04)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
`❌` BodyTopLevelProperties	Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ProvisioningServiceDescription' has extra properties ['resourcegroup']. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1786	RPC-Put-V1-06
`❌` BodyTopLevelProperties	Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ProvisioningServiceDescription' has extra properties ['subscriptionid']. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L1786	RPC-Put-V1-06

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.Devices/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L60
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L64
`❌` ResourceNameRestriction	The resource name parameter 'provisioningServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L76
`❌` ResourceNameRestriction	The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L76
`❌` ParametersOrder	The parameters:certificateName,resourceGroupName,provisioningServiceName should be kept in the same order as they present in the path. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L77
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L135
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L208
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L349
`❌` ResourceNameRestriction	The resource name parameter 'provisioningServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L358
`❌` ParametersOrder	The parameters:provisioningServiceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L359
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L400
`❌` CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L414
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L471
`❌` PatchSkuProperty	The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L516
`❌` LroPatch202	The async patch operation should return 202. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L529
`❌` RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L529
`❌` DeleteOperationAsyncResponseValidation	An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L544
`❌` ParametersOrder	The parameters:provisioningServiceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L544
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L584
`❌` MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L593
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L596
`❌` ResourceNameRestriction	The resource name parameter 'provisioningServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L605
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L650
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L687
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L737
`❌` ResourceNameRestriction	The resource name parameter 'provisioningServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L749
`❌` ParametersOrder	The parameters:operationId,resourceGroupName,provisioningServiceName should be kept in the same order as they present in the path. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L750
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L809
`❌` ResourceNameRestriction	The resource name parameter 'provisioningServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L818
`❌` ParametersOrder	The parameters:provisioningServiceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Devices/stable/2022-12-12/iotdps.json#L819

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

Validation passes for Avocado.

️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Devices' for api version '2022-12-12'. The supported api-versions are '2015-08-15-preview, 2016-02-03, 2017-01-19, 2017-07-01, 2018-01-22, 2018-04-01, 2018-12-01-preview, 2019-03-22-preview, 2019-03-22, 2019-07-01-preview, 2019-11-04, 2020-03-01, 2020-04-01, 2020-06-15, 2020-07-10-preview, 2020-08-01, 2020-08-31-preview, 2020-08-31, 2021-02-01-preview, 2021-03-03-preview, 2021-03-31, 2021-07-01-preview, 2021-07-01, 2021-07-02-preview, 2021-07-02, 2022-04-30-preview'."

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

Tag package-2022-12; Prod region: Not deployed; Canary region: Deployed

Test run on region: eastus2euap; Operation coverage: total: 24, untested: 0, failed: 23, passed: 1

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

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` CLIENT_ERROR	statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2022-12-12' for type 'ProvisioningServices'. The supported api-versions are '2017-08-21-preview, 2017-11-15, 2018-01-22, 2020-01-01, 2020-03-01, 2021-10-15, 2022-02-05, 2022-08-07-preview'. The supported locations are 'westus, australiacentral2, australiasoutheast, canadaeast, centralus, eastus, francesouth, koreasouth, japanwest, southindia, southeastasia, westeurope, uksouth, southcentralus, australiacentral, australiaeast, brazilsouth, canadacentral, centralindia, eastasia, francecentral, japaneast, koreacentral, northeurope, ukwest, westus2, westcentralus, northcentralus, eastus2, germanywestcentral, uaenorth, eastus2euap, centraluseuap'. Source: runtime OperationId: IotDpsResource_CreateOrUpdate
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_CreateOrUpdate
`❌` CLIENT_ERROR	statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ProvisioningServices' could not be found in the namespace 'Microsoft.Devices' for api version '2022-12-12'. The supported api-versions are '2017-08-21-preview,2017-11-15,2018-01-22,2020-01-01,2020-03-01,2021-10-15,2022-02-05,2022-08-07-preview'. Source: runtime OperationId: IotDpsResource_ListBySubscription
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListBySubscription
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_Get
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_Get
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/resourcevyln2e' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_GetPrivateLinkResources
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_GetPrivateLinkResources
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/resourcevyln2e' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_ListPrivateEndpointConnections
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListPrivateEndpointConnections
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/resourcevyln2e' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_ListPrivateLinkResources
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListPrivateLinkResources
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_listValidSkus
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_listValidSkus
`❌` CLIENT_ERROR	statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ProvisioningServices' could not be found in the namespace 'Microsoft.Devices' for api version '2022-12-12'. The supported api-versions are '2017-08-21-preview,2017-11-15,2018-01-22,2020-01-01,2020-03-01,2021-10-15,2022-02-05,2022-08-07-preview'. Source: runtime OperationId: IotDpsResource_ListByResourceGroup
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListByResourceGroup
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_GetOperationResult
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_GetOperationResult
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_Update
`❌` INVALID_RESPONSE_CODE	The swagger file does not define '404' response code Source: response OperationId: IotDpsResource_Update
`❌` CLIENT_ERROR	statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'checkProvisioningServiceNameAvailability' could not be found in the namespace 'Microsoft.Devices' for api version '2022-12-12'. The supported api-versions are '2017-08-21-preview,2017-11-15,2018-01-22,2020-01-01,2020-03-01,2021-10-15,2022-02-05'. Source: runtime OperationId: IotDpsResource_CheckProvisioningServiceNameAvailability
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_CheckProvisioningServiceNameAvailability
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_ListKeys
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListKeys
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: IotDpsResource_ListKeysForKeyName
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: IotDpsResource_ListKeysForKeyName
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DpsCertificate_CreateOrUpdate
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: DpsCertificate_CreateOrUpdate
`❌` CLIENT_ERROR	statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/ProvisioningServices/provisio25lz1n' under resource group 'apiTest-pecxWC-21737' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DpsCertificate_List
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: error Source: response OperationId: DpsCertificate_List

️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]

️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

️️✔️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.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2022-12-02T17:35:07Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices - Approved - 2.0.0

+	Type of `ErrorDetails.Code` has been changed from `*string` to `*int32`

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 56f4ef7. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.DeviceProvisioningServices [View full logs] [Release SDK Changes]
- Azure.ResourceManager.DeviceProvisioningServices.1.1.0-alpha.20230128.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 56f4ef7. 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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-iothubprovisioningservices [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model IotDpsPropertiesDescription has a new parameter portal_operations_host_name
info	[Changelog]   - Model ProvisioningServiceDescription has a new parameter resourcegroup
info	[Changelog]   - Model ProvisioningServiceDescription has a new parameter subscriptionid
info	[Changelog]   - Model Resource has a new parameter resourcegroup
info	[Changelog]   - Model Resource has a new parameter subscriptionid

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

⚠️Warning [Logs]Release - Generate from 56f4ef7. 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-5] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
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.
cmderr	[generate.py] [ForkJoinPool-1-worker-1] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
cmderr	[generate.py] [ForkJoinPool-1-worker-7] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
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-deviceprovisioningservices [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from 56f4ef7. 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/deviceprovisioningservices/armdeviceprovisioningservices [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `ErrorDetails.Code` has been changed from `*string` to `*int32`
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `PortalOperationsHostName` in struct `IotDpsPropertiesDescription`
info	[Changelog] - New field `Resourcegroup` in struct `ProvisioningServiceDescription`
info	[Changelog] - New field `Subscriptionid` in struct `ProvisioningServiceDescription`
info	[Changelog] - New field `Resourcegroup` in struct `Resource`
info	[Changelog] - New field `Subscriptionid` in struct `Resource`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 3 additive change(s).

️❌ azure-sdk-for-js failed [Detail]

❌Failed [Logs]Release - Generate from 56f4ef7. 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
cmderr	[automation_generate.sh] [ERROR] Error:
cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/deviceprovisioningservices/resource-manager/readme.md":
cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/arm-deviceprovisioningservices
cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/arm-deviceprovisioningservices
cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:87:33)
cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
cmderr	[automation_generate.sh] [ERROR]     at processTicksAndRejections (node:internal/process/task_queues:96:5)"

❌@azure/arm-deviceprovisioningservices [View full logs] [Release SDK Changes]

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

⚠️Warning [Logs]Release - Generate from 56f4ef7. 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

️✔️deviceprovisioningservices [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from 56f4ef7. 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.deviceprovisioningservices [View full logs] [Release SDK Changes]

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

openapi-pipeline-app · 2022-12-02T17:35:08Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices	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-deviceprovisioningservices	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net	Azure.ResourceManager.DeviceProvisioningServices	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 · 2022-12-02T17:42:30Z

Hi @fmjosuel, 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.

openapi-workflow-bot · 2022-12-02T17:42:30Z

Hi, @fmjosuel, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

openapi-workflow-bot · 2022-12-02T21:13:43Z

Hi @fmjosuel, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

visingla-ms · 2022-12-04T20:27:25Z

.../deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json

@@ -0,0 +1,2571 @@
+{


There is one more PR, with a different new API version than this: #21736. That also similar changes, which one to review?

Yes, please ignore the #21736 one (closed).

Also for context. The changes in this API version have already been approved in a private preview version. But we were not able to publish the changes to the public repo. As a result we were asked (by OpenAPI support) to create another PR manually in public repo.

Ask: can we leverage that previous approval to expedite review on this pull request? We had gone through breaking change review as well. Here is the PR that was approved: https://github.com/Azure/azure-rest-api-specs-pr/pull/8870

Please advise.

Any update on the above? @visingla-ms
We would like to move along with this since it is a dependency for two features launch for us. Thank you!

TimLovellSmith · 2023-01-17T23:20:20Z

.../deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json

+        "provisioningState": {
+          "description": "The ARM provisioning state of the provisioning service.",
+          "type": "string"
+        },


You are recommended to model provisioningState using an enum.

TimLovellSmith · 2023-01-19T02:46:30Z

.../deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json

+        "subscriptionid": {
+          "type": "string",
+          "description": "The subscription id of the resource."
+        },


'resourcegroup' and 'subscriptionid' these are nonstandard casing. You should camelCase property names in your API. You probably won't fix it if you already return the properties like this per s360, but just going to call that out...

TimLovellSmith · 2023-01-19T05:04:16Z

.../deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json

+      "type": "string",
+      "x-ms-parameter-location": "method"
+    },
+    "groupId": {


groupId

I don't see most other services defining a groupId parameter for use in private links apis, so I wonder what is different. I think they would normally call the parameter you are calling 'groupIds' 'privateLinkName' or something like that.
But its breaking, so never mind for now.

TimLovellSmith

TimLovellSmith · 2023-01-19T05:06:00Z

As you can see I have a bunch of feedback, but its not really ARM review blockers per se. You might want to discuss when is the right time to fix RPC violations with breaking changes reviewers -- since it will possibly be needed to fix certain bugs you find out about later.

fmjosuel · 2023-01-22T05:26:57Z

Approved private preview PR link: https://github.com/Azure/azure-rest-api-specs-pr/pull/8870

leni-msft · 2023-01-26T01:32:05Z

/azp run

azure-pipelines · 2023-01-26T01:32:14Z

Azure Pipelines successfully started running 1 pipeline(s).

fmjosuel · 2023-01-26T07:30:01Z

Commenting here for context to everyone - These changes have already been cleared for breaking change review in private preview (see merged PR here). But we had an issue promoting the changes to a public GA API and were suggested to start the GA api version manually (thus this current PR).

fmjosuel · 2023-01-26T07:42:00Z

Commenting here for context to everyone - These changes have already been cleared for breaking change review in private preview (see merged PR here). But we had an issue promoting the changes to a public GA API and were suggested to start the GA api version manually (thus this current PR).

Specific reference to the breaking change review: https://github.com/Azure/azure-rest-api-specs-pr/pull/8519#issuecomment-1251842254

…-12 for CORS deviceprovisioningservices microsoft.devices (#2756) Create to sync Azure/azure-rest-api-specs#21737 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/deviceprovisioningservices?expand=1)

fmjosuel and others added 4 commits December 2, 2022 09:03

Adds base for updating Microsoft.Devices from version stable/2022-02-…

0d4b205

…05 to version 2022-12-12

Updates readme

4c95338

Updates API version in new specs and examples

869f4f8

Adding CORS changes for stable API version 2022-12-02

478e266

openapi-assignment-bot bot assigned honghr Dec 2, 2022

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 2, 2022

AzureRestAPISpecReview added CI-FixRequiredOnFailure CI-MissingBaseCommit new-api-version resource-manager labels Dec 2, 2022

Adding S360swagger changes -- already in preview api version

dc5a12a

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Dec 2, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Go label Dec 2, 2022

visingla-ms reviewed Dec 4, 2022

View reviewed changes

TimLovellSmith reviewed Jan 17, 2023

View reviewed changes

TimLovellSmith reviewed Jan 19, 2023

View reviewed changes

TimLovellSmith approved these changes Jan 19, 2023

View reviewed changes

TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 19, 2023

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 19, 2023

fmjosuel added 2 commits January 23, 2023 12:30

Fixing model validations issues

5ee6fc9

Clean up!

5fa7a04

AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels Jan 24, 2023

AzureRestAPISpecReview added the CI-FixRequiredOnFailure label Jan 26, 2023

honghr added the Approved-LintDiff label Jan 26, 2023

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jan 27, 2023

honghr added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jan 28, 2023

honghr merged commit 56f4ef7 into Azure:main Jan 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New stable API version 2022-12-12 for CORS deviceprovisioningservices microsoft.devices #21737

New stable API version 2022-12-12 for CORS deviceprovisioningservices microsoft.devices #21737

fmjosuel commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

visingla-ms Dec 4, 2022

fmjosuel Dec 5, 2022 •

edited

Loading

fmjosuel Dec 27, 2022

TimLovellSmith Jan 17, 2023

TimLovellSmith Jan 19, 2023 •

edited

Loading

TimLovellSmith Jan 19, 2023

TimLovellSmith left a comment

TimLovellSmith commented Jan 19, 2023

fmjosuel commented Jan 22, 2023 •

edited

Loading

leni-msft commented Jan 26, 2023

azure-pipelines bot commented Jan 26, 2023

fmjosuel commented Jan 26, 2023

fmjosuel commented Jan 26, 2023

New stable API version 2022-12-12 for CORS deviceprovisioningservices microsoft.devices #21737

New stable API version 2022-12-12 for CORS deviceprovisioningservices microsoft.devices #21737

Conversation

fmjosuel commented Dec 2, 2022

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

openapi-pipeline-app bot commented Dec 2, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 2, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 2, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

openapi-workflow-bot bot commented Dec 2, 2022

visingla-ms Dec 4, 2022

Choose a reason for hiding this comment

fmjosuel Dec 5, 2022 • edited Loading

Choose a reason for hiding this comment

fmjosuel Dec 27, 2022

Choose a reason for hiding this comment

TimLovellSmith Jan 17, 2023

Choose a reason for hiding this comment

TimLovellSmith Jan 19, 2023 • edited Loading

Choose a reason for hiding this comment

TimLovellSmith Jan 19, 2023

Choose a reason for hiding this comment

TimLovellSmith left a comment

Choose a reason for hiding this comment

TimLovellSmith commented Jan 19, 2023

fmjosuel commented Jan 22, 2023 • edited Loading

leni-msft commented Jan 26, 2023

azure-pipelines bot commented Jan 26, 2023

fmjosuel commented Jan 26, 2023

fmjosuel commented Jan 26, 2023

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2022 •

edited

Loading

fmjosuel Dec 5, 2022 •

edited

Loading

TimLovellSmith Jan 19, 2023 •

edited

Loading

fmjosuel commented Jan 22, 2023 •

edited

Loading