-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
[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
/azp run python - serviecbus - tests |
No pipelines are associated with this pull request. |
sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py
Outdated
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/azure/servicebus/management/_utils.py
Outdated
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/azure/servicebus/management/_utils.py
Outdated
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/azure/servicebus/management/_utils.py
Outdated
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_queues_async.py
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_subscriptions_async.py
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_topics_async.py
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/tests/async_tests/mgmt_tests/test_mgmt_topics_async.py
Show resolved
Hide resolved
sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py
Show resolved
Hide resolved
/azp run python - serviecbus - tests |
No pipelines are associated with this pull request. |
/azp run python - serviecbus - tests |
No pipelines are associated with this pull request. |
/azp run python - servicebus - tests |
…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides
/azp run python - servicebus - tests |
Azure Pipelines successfully started running 1 pipeline(s). |
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
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: 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 python - serviecbus - tests |
No pipelines are associated with this pull request. |
/azp run python - servicebus - tests |
Pull request contains merge conflicts. |
/azp run python - servicebus - tests |
Azure Pipelines successfully started running 1 pipeline(s). |
…om/yunhaoling/azure-sdk-for-python into yuling/sb/update_keyword_overrides
/azp run python - servicebus - tests |
Azure Pipelines successfully started running 1 pipeline(s). |
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should these keywords be documeneted?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
code snippets updated! @rakshith91 are you good with updating the docs later?
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like this would be a read-only property that shouldn't be overridden from kwargs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
/azp run python - servicebus - tests |
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) ...
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
update_queue
andupdate_subscription
methods were mutating the propertiesforward_to
andforward_dead_lettered_messages_to
of the model instance when those properties are entities instead of full paths.