Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IotHub] Adding user assigned capability for customer provided endpoints [2021-03-03-preview] #13243

Merged
merged 7 commits into from
Mar 18, 2021

Conversation

nimengan
Copy link
Contributor

@nimengan nimengan commented Mar 2, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

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

@openapi-workflow-bot
Copy link

Hi, @nimengan 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 2, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 4 Warnings warning [Detail]

    Rule Message
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'includeConfigurations' renamed or removed?
    New: Microsoft.Devices/preview/2021-03-03-preview/iothub.json#L4146:7
    Old: Microsoft.Devices/stable/2020-08-31/iothub.json#L4101:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'configurationsBlobName' renamed or removed?
    New: Microsoft.Devices/preview/2021-03-03-preview/iothub.json#L4146:7
    Old: Microsoft.Devices/stable/2020-08-31/iothub.json#L4101:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'includeConfigurations' renamed or removed?
    New: Microsoft.Devices/preview/2021-03-03-preview/iothub.json#L4184:7
    Old: Microsoft.Devices/stable/2020-08-31/iothub.json#L4143:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'configurationsBlobName' renamed or removed?
    New: Microsoft.Devices/preview/2021-03-03-preview/iothub.json#L4184:7
    Old: Microsoft.Devices/stable/2020-08-31/iothub.json#L4143:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 7 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'TagsResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'TagsResource-tags' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"The schema 'RoutingTwin-properties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"iothub/resource-manager/readme.md",
    "tag":"package-preview-2021-03",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 2, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6c738b5. 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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6c738b5. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
    • ️✔️@azure/arm-iothub [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/iotHubClient.js → ./dist/arm-iothub.js...
      cmderr	[npmPack] created ./dist/arm-iothub.js in 447ms
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6c738b5. 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] 2021-03-18 01:36:42 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-iothub;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-03-18 01:36:42 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-03-18 01:36:42 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.20 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/iothub/azure-resourcemanager-iothub --java.namespace=com.azure.resourcemanager.iothub   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-iothub
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Skip] pom already has module azure-resourcemanager-iothub
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Skip] pom already has module sdk/iothub
      cmderr	[generate.py] 2021-03-18 01:37:32 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-iothub [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Got artifact_id: azure-resourcemanager-iothub
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Got artifact: azure-resourcemanager-iothub-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Got artifact: azure-resourcemanager-iothub-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Got artifact: azure-resourcemanager-iothub-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG Match jar package: azure-resourcemanager-iothub-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-03-18 01:41:17 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13243/azure-sdk-for-java/azure-resourcemanager-iothub/azure-resourcemanager-iothub-1.0.0-beta.2.jar\" -o azure-resourcemanager-iothub-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-iothub -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-iothub-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 6c738b5. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • Microsoft.Azure.Management.IotHub [View full logs]  [Release SDK Changes]
      cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/iothub/Microsoft.Azure.Management.IotHub/tests/ScenarioTests/IotHubTestBase.cs(239,20): error CS1929: 'ICertificatesOperations' does not contain a definition for 'CreateOrUpdateAsync' and the best extension method overload 'ConsumerGroupsOperationsExtensions.CreateOrUpdateAsync(IConsumerGroupsOperations, string, string, string, string, ConsumerGroupCreateOrUpdateParameters, CancellationToken)' requires a receiver of type 'IConsumerGroupsOperations' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/iothub/Microsoft.Azure.Management.IotHub/tests/Microsoft.Azure.Management.IotHub.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/iothub/Microsoft.Azure.Management.IotHub/tests/ScenarioTests/IotHubTestBase.cs(239,20): error CS1929: 'ICertificatesOperations' does not contain a definition for 'CreateOrUpdateAsync' and the best extension method overload 'ConsumerGroupsOperationsExtensions.CreateOrUpdateAsync(IConsumerGroupsOperations, string, string, string, string, ConsumerGroupCreateOrUpdateParameters, CancellationToken)' requires a receiver of type 'IConsumerGroupsOperations' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/iothub/Microsoft.Azure.Management.IotHub/tests/Microsoft.Azure.Management.IotHub.Tests.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6c738b5. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
    • ️✔️iothub [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  WARN template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 2, 2021
    @openapi-workflow-bot
    Copy link

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

    @nimengan
    Copy link
    Contributor Author

    nimengan commented Mar 2, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @nimengan nimengan marked this pull request as ready for review March 10, 2021 18:48
    @nimengan nimengan added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 10, 2021
    @nimengan
    Copy link
    Contributor Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @filizt filizt self-requested a review March 10, 2021 22:42
    @filizt
    Copy link
    Contributor

    filizt commented Mar 12, 2021

      "properties": {
    

    if properties are read only please mark them as such


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:4344 in 831d5b2. [](commit_id = 831d5b2, deletion_comment = False)

    @filizt
    Copy link
    Contributor

    filizt commented Mar 12, 2021

    "ManagedIdentity": {
    

    Is there an example for a managed identity case?


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:4341 in 831d5b2. [](commit_id = 831d5b2, deletion_comment = False)

    @nimengan
    Copy link
    Contributor Author

      "properties": {
    

    if properties are read only please mark them as such

    Refers to: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:4344 in 831d5b2. [](commit_id = 831d5b2, deletion_comment = False)

    No properties are not read only

    @nimengan nimengan closed this Mar 15, 2021
    @nimengan
    Copy link
    Contributor Author

    "ManagedIdentity": {
    

    Is there an example for a managed identity case?

    Refers to: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:4341 in 831d5b2. [](commit_id = 831d5b2, deletion_comment = False)

    Added an example.

    @nimengan
    Copy link
    Contributor Author

    @filizt addressed you comments. could please approve from your side ?

    @nimengan nimengan reopened this Mar 15, 2021
    @filizt filizt removed their request for review March 17, 2021 20:40
    Copy link
    Contributor

    @ravbhatnagar ravbhatnagar left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Signing off from ARM side.

    @ravbhatnagar ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 17, 2021
    @nimengan
    Copy link
    Contributor Author

    @chunyu3 could you please merge this pull request ?

    @chunyu3 chunyu3 self-requested a review March 18, 2021 01:27
    @chunyu3 chunyu3 merged commit 6c738b5 into Azure:master Mar 18, 2021
    This was referenced Mar 18, 2021
    MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
    …nts [2021-03-03-preview] (Azure#13243)
    
    * Adds base for updating Microsoft.Devices from version preview/2021-02-01-preview to version 2021-03-03-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Adding identity property for customer provided endpoints
    
    * Adding disableLocalAuth property to IothubProperties.
    
    * Removing disableLocalAuth prop and adding a example
    
    * Prettier fix
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …nts [2021-03-03-preview] (Azure#13243)
    
    * Adds base for updating Microsoft.Devices from version preview/2021-02-01-preview to version 2021-03-03-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Adding identity property for customer provided endpoints
    
    * Adding disableLocalAuth property to IothubProperties.
    
    * Removing disableLocalAuth prop and adding a example
    
    * Prettier fix
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants