azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[Hub Generated] Review request for Microsoft.Devices to add version stable/2023-06-30

Open MikalaiSavenka opened this issue 2 years ago • 26 comments

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):

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

ARM API Review Checklist

Applicability: :warning:

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.

MikalaiSavenka avatar May 02 '23 17:05 MikalaiSavenka

Hi, @MikalaiSavenka 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. [email protected]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 13 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    iothub.json 2023-06-30(9c60f45) 2021-07-02(main)
    iothub.json 2023-06-30(9c60f45) 2023-06-30-preview(main)

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

    Rule Message
    :warning: 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/2023-06-30/iothub.json#L2061:3
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2069:3
    :warning: 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'RootCertificateProperties' removed or renamed?
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L2061:3
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2069:3
    :warning: 1014 - RemovingHeader The new version removs a required header 'Azure-AsyncOperation'.
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L165:15
    :warning: 1014 - RemovingHeader The new version removs a required header 'Azure-AsyncOperation'.
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L237:15
    :warning: 1014 - RemovingHeader The new version removs a required header 'Azure-AsyncOperation'.
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L1981:15
    :warning: 1019 - RemovedEnumValue The new version is removing enum value(s) 'DigitalTwinChangeEvents, MqttBrokerMessages' from the old version.
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L3294:9
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3319:9
    :warning: 1019 - RemovedEnumValue The new version is removing enum value(s) 'DigitalTwinChangeEvents, MqttBrokerMessages' from the old version.
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L4095:9
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L4114:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L3230:9
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3256:9
    :warning: 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L3217:9
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3244:9
    :warning: 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'deviceStreams' renamed or removed?
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L2300:7
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2308:7
    :warning: 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'encryption' renamed or removed?
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L2300:7
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2308:7
    :warning: 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'rootCertificate' renamed or removed?
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L2300:7
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2308:7
    :warning: 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'ipVersion' renamed or removed?
    New: Microsoft.Devices/stable/2023-06-30/iothub.json#L2300:7
    Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L2308:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.4) new version base version
    package-2023-06 package-2023-06(9c60f45) default(main)

    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/2023-06-30/iothub.json#L60
    OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L61
    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/2023-06-30/iothub.json#L64
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L76
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L76
    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/2023-06-30/iothub.json#L110
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L165
    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/2023-06-30/iothub.json#L178
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L181
    PatchResponseCode LRO PATCH must have 200 and 202 return codes.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L187
    PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L218
    PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L218
    LroPatch202 The async patch operation should return 202.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231
    MissingDefaultResponse Operation is missing a default response.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231
    DeleteResponseBodyEmpty The delete response body must be empty.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L291
    MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L298
    NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L298
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L301
    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/2023-06-30/iothub.json#L304
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L307
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L314
    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/2023-06-30/iothub.json#L342
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L355
    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/2023-06-30/iothub.json#L386
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L399
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L399
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L429
    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/2023-06-30/iothub.json#L433
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus'
    Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L443
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView 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).
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    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-python-track2 - track2_azure-mgmt-iothub - 2.4.0
    -	Model RoutingCosmosDBSqlApiProperties has a new required parameter container_name
    -	Model RoutingCosmosDBSqlApiProperties no longer has parameter collection_name
    -	Model RoutingEndpoints no longer has parameter cosmos_db_sql_collections
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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.IotHub [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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 minor version of npm available! 9.6.7 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-iothub [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model RoutingEndpoints has a new parameter cosmos_db_sql_containers
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model RoutingCosmosDBSqlApiProperties has a new required parameter container_name
      info	[Changelog]   - Model RoutingCosmosDBSqlApiProperties no longer has parameter collection_name
      info	[Changelog]   - Model RoutingEndpoints no longer has parameter cosmos_db_sql_collections
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-iothub [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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/iothub/armiothub [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New struct `RoutingCosmosDBSQLAPIProperties`
      info	[Changelog] - New field `CosmosDBSQLContainers` in struct `RoutingEndpoints`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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-iothub [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface IotHubManualFailoverHeaders
      info	[Changelog]   - Added Interface IotHubResourceDeleteHeaders
      info	[Changelog]   - Added Interface PrivateEndpointConnectionsDeleteHeaders
      info	[Changelog]   - Added Interface RoutingCosmosDBSqlApiProperties
      info	[Changelog]   - Interface RoutingEndpoints has a new optional parameter cosmosDBSqlContainers
      info	[Changelog]   - Added function getContinuationToken
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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
    • ️✔️iothub [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 8fa9b5051129dd4808c9be1f5b753af226b044db. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ⚠️Az.iothub.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.iothub.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/iothub/armiothub https://apiview.dev/Assemblies/Review/cfdbf397122d45e39a179f625c25d314
    .Net Azure.ResourceManager.IotHub https://apiview.dev/Assemblies/Review/96680a869b2e4fe2aac0528b9f1500b9
    Java azure-resourcemanager-iothub https://apiview.dev/Assemblies/Review/21e00204a59e4c79986cc1b4cd590a6d
    JavaScript @azure/arm-iothub https://apiview.dev/Assemblies/Review/9b11eaddfa39417bb3feb758f4cd3a5d

        },
    

    are these create/update only?


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3255 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

        },
    

    Having name, subscriptionId, and resourceGroup, and id seems redundant - are they all identifying the same resource? Or are there diffeent resources here?


    In reply to: 1542562663


    In reply to: 1542562663


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3225 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

          "description": "Id of the cosmos DB sql container endpoint",
    

    Want to include an example?


    In reply to: 1542563183


    In reply to: 1542563183


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3215 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

        },
    

    consider annotating as a resource id.

    x-ms-arm-id-details - indicates the allowed resources that can be referred to by an arm-id formatted string field.


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3217 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

        },
    

    format: uri?


    In reply to: 1542565328


    In reply to: 1542565328


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3229 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

          "description": "The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.",
    

    Why is it required if PartitionKeyName is specified?


    In reply to: 1542566830


    In reply to: 1542566830


    In reply to: 1542566830


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3269 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

          "description": "The user assigned identity."
    

    objectid of? principalid of? resource id of?


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:4485 in 17667df. [](commit_id = 17667df197c95816c8ec1868405cf4b3cf964acc, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

        "cosmosDBSqlContainers": {
    

    Are you going to add an example for this? It'd be nice if your examples cover all the different kind of routing endpoints with a common set of parameters.


    In reply to: 1542569674


    In reply to: 1542569674


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:2952 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar May 10 '23 17:05 TimLovellSmith

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    Hi, @MikalaiSavenka. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    ghost avatar May 28 '23 16:05 ghost

        },
    

    not sure I understand question


    In reply to: 1542561780


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3255 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 22:06 MikalaiSavenka

        },
    

    what is annotating as a resource id? do you have any documentation link?


    In reply to: 1542565092


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3217 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 22:06 MikalaiSavenka

        },
    

    name - name of endpoint set by customer id - internal id resourceGroup - it is azure resource group where cosmosdb account reside


    In reply to: 1542562663


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3225 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 22:06 MikalaiSavenka

        },
    

    the example is: https://ailn-systemstore-test2.documents.azure.com:443/

    I dont see we use format in this doc at all


    In reply to: 1542565328


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3229 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 22:06 MikalaiSavenka

          "description": "The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.",
    

    partitionkeyname is name stamped to document partitinkeytemplate is value stamped to document


    In reply to: 1542566830


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3269 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 22:06 MikalaiSavenka

        "cosmosDBSqlContainers": {
    

    I will add example for cosmosdb endpoint, as far as this PR is for cosmosdb endpoint


    In reply to: 1542569674


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:2952 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 15 '23 23:06 MikalaiSavenka

        "cosmosDBSqlContainers": {
    

    added


    In reply to: 1542569674


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:2952 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    MikalaiSavenka avatar Jun 27 '23 20:06 MikalaiSavenka

    Hi @MikalaiSavenka! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

        },
    

    So now, looks like you're using x-ms-secret, which implies x-ms-mutability is create/update only. I think its probably good to make that explicit though.

    Do I understand right that you allow the customer to pass the keys they like, to enable iothub to connect to their cosmosDB instance?

    This sounds like a pretty painful way of doing it, for anyone who wants to or has to (compliance) implementi key autorotations. Firstly, they can't even tell/audit what key values are in use.


    In reply to: 1593816631


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3255 in 09336e3. [](commit_id = 09336e3a5ddf329ae15f5c593921f5cc06086eb8, deletion_comment = False)

    TimLovellSmith avatar Jun 27 '23 20:06 TimLovellSmith

        },
    

    Is either databaseName or name, specifically the name of the ARM cosmosDB resource? Trying to understand intended usage.


    In reply to: 1612439265


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3261 in 13514e2. [](commit_id = 13514e28bd3f4c8c3236a093234a7af885448028, deletion_comment = False)

    TimLovellSmith avatar Jun 29 '23 05:06 TimLovellSmith

        },
    

    name of database created within cosmosdb resource


    In reply to: 1612439265


    Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3261 in 13514e2. [](commit_id = 13514e28bd3f4c8c3236a093234a7af885448028, deletion_comment = False)

    MikalaiSavenka avatar Jun 29 '23 18:06 MikalaiSavenka

    Added DoNotMerge at requet of PR author

    TimLovellSmith avatar Jul 11 '23 22:07 TimLovellSmith

    Hi, @MikalaiSavenka. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    Hi, @MikalaiSavenka. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    /azp run

    TimLovellSmith avatar Aug 14 '23 17:08 TimLovellSmith

    Azure Pipelines successfully started running 2 pipeline(s).

    azure-pipelines[bot] avatar Aug 14 '23 17:08 azure-pipelines[bot]