search

Azure / azure-sdk

This is the Azure SDK parent repository and mostly contains documentation around guidelines and policies as well as the releases for the various languages supported by the Azure SDK.
http://azure.github.io/azure-sdk
MIT License
493 stars 300 forks source link

Azure SDK Review - [Introduction to IoT Hub Device Provisioning Service] #5948

Open azure-sdk opened 1 year ago

azure-sdk commented 1 year ago

New SDK Review meeting has been requested.

Service Name: IoT Hub Device Provisioning Service Review Created By: Paymaun Heidari Review Date: 05/03/2023 02:05 PM PT

Hero Scenarios Link: Not Provided Architecture Diagram Link: Not Provided Core Concepts Doc Link: Not Provided APIView Links:

Description: For the IoT device provisioning service, there is a gap in the python ecosystem specifically a modern data plane service sdk. In this meeting we intend to put forth a proposal for preview.

Detailed meeting information and documents provided can be accessed here

ronniegeraghty commented 1 year ago

Hi @digimaun, We'll need the materials for this review added by the end of this week, or we'll have to cancel or push back this meeting. We'll need a link to Hero Scenarios (these can used pseudo code if the libraries have not been created yet), API View Listings for any libraries that have been created already, links to the API Specs for the service, and links to any core concept docs you feel could give the architects better understanding of the service.

digimaun commented 1 year ago

Hi @ronniegeraghty, thanks for the reminder. These materials are understood and intended to be provided by the end of the week, where if we are not ready, we will reschedule / ok to cancel.

ronniegeraghty commented 1 year ago

Hi @digimaun, I just wanted to ping again as a reminder that we will need the materials added to this issue by the end of the day tomorrow.

azure-sdk commented 1 year ago

Meeting updated by Paymaun Heidari

Service Name: IoT Hub Device Provisioning Service Review Created By: Paymaun Heidari Review Date: 05/03/2023 02:05 PM PT

Hero Scenarios Link: here Architecture Diagram Link: Not Provided Core Concepts Doc Link: here APIView Links: Python,

Description: For the IoT device provisioning service, there is a gap in the python ecosystem specifically a modern data plane service sdk. In this meeting we intend to put forth a proposal for preview.

Detailed meeting information and documents provided can be accessed here

annatisch commented 1 year ago

@digimaun - it looks like the APIview is missing the operations. It looks like the current implementation is wrapping the generated client, and forgot to make the actual operations public. This shouldn't be necessary, you should be able to expose the generated client directly, and just patch the credentials if you need to.

digimaun commented 1 year ago

Thanks @annatisch , I'm curious what is the guidance on when to use the patch pattern vs a wrapping client...for example the azure-servicebus SDK's management client does not appear to make use of patch https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/servicebus/azure-servicebus/azure/servicebus/management

annatisch commented 1 year ago

Up until quite recently (last year or so), the "patch" pattern was incomplete and didn't really allow for full flexibility in customizing the generated code. So a lot of earlier SDKs resorted to wrapping the client in order to make the necessary customizations. However, we've made pretty huge investments in autorest generated code, and now you should be able to customize pretty much anything you need to without needing to maintain a client wrapper :)