[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

yunhaoling · 2021-04-21T20:22:37Z

Addressing issue: #13043
guideline: https://azure.github.io/azure-sdk/python_design.html#python-client-flatten-args

New Features

ServiceBusAdministrationClient.update_* methods now accept keyword arguments to override the properties specified in the model instance.

Bug Fixes

Fixed a bug where update_queue and update_subscription methods were mutating the properties forward_to and forward_dead_lettered_messages_to of the model instance when those properties are entities instead of full paths.

yunhaoling · 2021-04-22T16:27:07Z

/azp run python - serviecbus - tests

azure-pipelines · 2021-04-22T16:27:12Z

No pipelines are associated with this pull request.

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py

sdk/servicebus/azure-servicebus/azure/servicebus/management/_utils.py

sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_queues_async.py

sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_subscriptions_async.py

sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_topics_async.py

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py

sdk/servicebus/azure-servicebus/CHANGELOG.md

yunhaoling · 2021-04-22T19:50:19Z

/azp run python - serviecbus - tests

azure-pipelines · 2021-04-22T19:50:43Z

No pipelines are associated with this pull request.

yunhaoling · 2021-04-22T19:54:21Z

/azp run python - serviecbus - tests

azure-pipelines · 2021-04-22T19:54:26Z

No pipelines are associated with this pull request.

yunhaoling · 2021-04-22T19:54:49Z

/azp run python - servicebus - tests

…eyword_overrides

…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides

yunhaoling · 2021-04-26T13:36:56Z

/azp run python - servicebus - tests

azure-pipelines · 2021-04-26T13:37:10Z

Azure Pipelines successfully started running 1 pipeline(s).

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py

…eyword_overrides

check-enforcer · 2021-04-29T19:23:01Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

yunhaoling · 2021-04-29T20:28:04Z

/azp run python - serviecbus - tests

azure-pipelines · 2021-04-29T20:28:09Z

No pipelines are associated with this pull request.

swathipil · 2021-04-29T21:44:58Z

/azp run python - servicebus - tests

azure-pipelines · 2021-04-29T21:45:03Z

Pull request contains merge conflicts.

yunhaoling · 2021-05-03T13:06:16Z

/azp run python - servicebus - tests

azure-pipelines · 2021-05-03T13:06:29Z

Azure Pipelines successfully started running 1 pipeline(s).

… raw input

…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides

yunhaoling · 2021-05-03T19:37:01Z

/azp run python - servicebus - tests

azure-pipelines · 2021-05-03T19:37:15Z

Azure Pipelines successfully started running 1 pipeline(s).

rakshith91 · 2021-05-04T05:37:52Z

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py

@@ -919,6 +903,10 @@ async def update_subscription(

        Before calling this method, you should use `get_subscription`, `update_subscription` or `list_subscription`
        to get a `SubscriptionProperties` instance, then update the properties.
+        You could also pass keyword arguments for updating properties in the form of
+        `<property_name>=<property_value>` which will override whatever was specified in


should these keywords be documeneted?

I was trying to be vague here -- I'm not sure whether those keywords should be documented.
as once documented, then it feels like we're promoting using keyword arguments to do updates -- two ways to do the same thing.

@annatisch , do you think we'd better document those keyword arguments?

hmm I don't feel strongly either way.... documentation can always be updated as needed.
You could add an example in the code snippet to show their use rather than call them all out explicitly.

code snippets updated! @rakshith91 are you good with updating the docs later?

annatisch · 2021-05-04T16:44:56Z

sdk/servicebus/azure-servicebus/azure/servicebus/management/_models.py

-        self._internal_rule.created_at = self.created_at_utc
-        self._internal_rule.name = self.name
+
+        self._internal_rule.created_at = kwargs.pop("created_at_utc", self.created_at_utc)


Seems like this would be a read-only property that shouldn't be overridden from kwargs?

the funny part is that users could still pass their own value, but the service would simply ignore it -- created_at_utc is unchanged -- so I'd prefer not doing client validation and relying on service.

yunhaoling · 2021-05-04T18:08:50Z

/azp run python - servicebus - tests

azure-pipelines · 2021-05-04T18:09:03Z

Azure Pipelines successfully started running 1 pipeline(s).

…into azure_purview_catalog * 'master' of https://github.com/Azure/azure-sdk-for-python: (109 commits) [Tables] Adds support for AzureNamedKeyCredential (Azure#18456) [Tables] delete_entity takes an entity instead of row and partition key (Azure#18269) [Tables] Removed TableEntity attribute wrapper (Azure#18489) [EventHub&ServiceBus] Bump uAMQP dependency (Azure#17942) [ServiceBus] add keyword override support to update_ methods in mgmt module (Azure#18210) Add compatibility switch to disable CAE (Azure#18148) Service Bus Named Key Credential (Azure#18471) Change to use dynamic resource connection string for chat tests and identity samples (Azure#18502) Increase dependency (Azure#18500) show detailed error (Azure#18229) prerelease (Azure#18507) [Container Registry] addressing issues (Azure#18486) update per_call_policies & per_retry_policies (Azure#18406) Eh named key (Azure#18292) [Tables] Updating EntityProperty (Azure#18177) [Service Bus] fix async auth test (Azure#18499) [communication] Live Testing - Introduce CloudConfig into test.yml (Azure#18469) Release azure-servicefabric 8.0 (Azure#18488) [Communication]: Updated test_search_available_phone_numbers_with_invalid_country_code async test to be consistent with sync test (Azure#18466) [Container Registry] DeleteRepositoryResult Changed (Azure#18443) ...

…into azure_purview_scanning * 'master' of https://github.com/Azure/azure-sdk-for-python: (550 commits) del useless files (Azure#18528) delete existing useless files for trafficmanager (Azure#18525) Define new replacer to replace keys in recording (Azure#18294) [purview] add purview nspkg to ci (Azure#18523) ignore analysis for swagger readmes (Azure#18520) [purview] add azure-purview-nspkg (Azure#18518) [AppConfiguration] Appconfig consistency (Azure#18493) [Container Registry] Improved samples (Azure#18263) [Container Registry] renamings (Azure#18492) [ServiceBus] internal code rename and sample readme update (Azure#18516) [EventHub] update link in sample readme (Azure#18517) Post Process Event Names Script (Azure#18419) [Tables] use etag from entity if match condition is given (Azure#18271) adding operation-location to headers that are scrubbed (Azure#18514) [Tables] Adds support for AzureNamedKeyCredential (Azure#18456) [Tables] delete_entity takes an entity instead of row and partition key (Azure#18269) [Tables] Removed TableEntity attribute wrapper (Azure#18489) [EventHub&ServiceBus] Bump uAMQP dependency (Azure#17942) [ServiceBus] add keyword override support to update_ methods in mgmt module (Azure#18210) Add compatibility switch to disable CAE (Azure#18148) ...

add keyword override support

1305015

ghost added the Service Bus label Apr 21, 2021

yunhaoling linked an issue Apr 21, 2021 that may be closed by this pull request

[ServiceBus] Update parameters should take keyword name overrides #13043

Closed

yunhaoling added 4 commits April 22, 2021 08:26

updat impl

1a6c80e

add test and recordings

7b09800

version bump, changelog update

8d535cf

bug fix log

fd4f29b

yunhaoling marked this pull request as ready for review April 22, 2021 15:35

yunhaoling requested review from 00Kai0, annatisch, changlong-liu, jsntcy, msyyc, rakshith91 and swathipil as code owners April 22, 2021 15:35

yunhaoling removed request for jsntcy, 00Kai0, changlong-liu and msyyc April 22, 2021 15:36

fix pylint

c54e4fd

swathipil reviewed Apr 22, 2021

View reviewed changes

yunhaoling added 2 commits April 22, 2021 11:08

fix pylint and mypy

5e06035

pr review feedback

ae831d1

yunhaoling added 2 commits April 26, 2021 06:34

Merge remote-tracking branch 'central/master' into yuling/sb/update_k…

a633599

…eyword_overrides

Merge branch 'yuling/sb/update_keyword_overrides' of https://github.c…

366a063

…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides

annatisch reviewed Apr 29, 2021

View reviewed changes

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py Outdated Show resolved Hide resolved

sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py Show resolved Hide resolved

yunhaoling added 2 commits April 29, 2021 10:50

Merge remote-tracking branch 'central/master' into yuling/sb/update_k…

3602c2f

…eyword_overrides

review feedback

4250615

yunhaoling added 2 commits April 29, 2021 13:01

fix mypy and pylint

a55b94e

fix pylint

f36310e

Merge branch 'master' into yuling/sb/update_keyword_overrides

106973d

yunhaoling requested a review from annatisch May 3, 2021 16:31

yunhaoling added 2 commits May 3, 2021 12:16

header bearer should use normalized path to generate token instead of…

0370d6b

… raw input

Merge branch 'yuling/sb/update_keyword_overrides' of https://github.c…

8ff0874

…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides

rakshith91 reviewed May 4, 2021

View reviewed changes

annatisch approved these changes May 4, 2021

View reviewed changes

update code snippets to show update keyword argument usage

1f3ffa4

yunhaoling merged commit 17c2f18 into Azure:master May 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

yunhaoling commented Apr 21, 2021 •

edited

Loading

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

yunhaoling commented Apr 26, 2021

azure-pipelines bot commented Apr 26, 2021

check-enforcer bot commented Apr 29, 2021

yunhaoling commented Apr 29, 2021

azure-pipelines bot commented Apr 29, 2021

swathipil commented Apr 29, 2021

azure-pipelines bot commented Apr 29, 2021

yunhaoling commented May 3, 2021

azure-pipelines bot commented May 3, 2021

yunhaoling commented May 3, 2021

azure-pipelines bot commented May 3, 2021

rakshith91 May 4, 2021

yunhaoling May 4, 2021

annatisch May 4, 2021

yunhaoling May 4, 2021 •

edited

Loading

annatisch May 4, 2021

yunhaoling May 4, 2021 •

edited

Loading

yunhaoling commented May 4, 2021

azure-pipelines bot commented May 4, 2021

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

Conversation

yunhaoling commented Apr 21, 2021 • edited Loading

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

yunhaoling commented Apr 22, 2021

yunhaoling commented Apr 26, 2021

azure-pipelines bot commented Apr 26, 2021

check-enforcer bot commented Apr 29, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

yunhaoling commented Apr 29, 2021

azure-pipelines bot commented Apr 29, 2021

swathipil commented Apr 29, 2021

azure-pipelines bot commented Apr 29, 2021

yunhaoling commented May 3, 2021

azure-pipelines bot commented May 3, 2021

yunhaoling commented May 3, 2021

azure-pipelines bot commented May 3, 2021

rakshith91 May 4, 2021

Choose a reason for hiding this comment

yunhaoling May 4, 2021

Choose a reason for hiding this comment

annatisch May 4, 2021

Choose a reason for hiding this comment

yunhaoling May 4, 2021 • edited Loading

Choose a reason for hiding this comment

annatisch May 4, 2021

Choose a reason for hiding this comment

yunhaoling May 4, 2021 • edited Loading

Choose a reason for hiding this comment

yunhaoling commented May 4, 2021

azure-pipelines bot commented May 4, 2021

yunhaoling commented Apr 21, 2021 •

edited

Loading

yunhaoling May 4, 2021 •

edited

Loading

yunhaoling May 4, 2021 •

edited

Loading