Skip to content

Commit

Permalink
[ServiceBus] b7 release doc fixes (#14247)
Browse files Browse the repository at this point in the history
* b7 release doc fixes (link changes to newest preview permalink, release date in changelog)

* use 'latest' in blob doc paths instead of the actual version string to be future-proof, and fix a schedule->Send typo in migration guide.

* add pypi link to ignore-links
  • Loading branch information
KieranBrantnerMagee authored Oct 5, 2020
1 parent 657a918 commit a049376
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
3 changes: 2 additions & 1 deletion eng/ignore-links.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
https://docs.microsoft.com/python/api/overview/azure/{{package_doc_id}}
https://docs.microsoft.com/python/api/overview/azure/{{package_doc_id}}
https://pypi.org/project/azure-servicebus/7.0.0b7/
2 changes: 1 addition & 1 deletion sdk/servicebus/azure-servicebus/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release History

## 7.0.0b7 (Unreleased)
## 7.0.0b7 (2020-10-05)

**Breaking Changes**
* Passing any type other than `ReceiveMode` as parameter `receive_mode` now throws a `TypeError` instead of `AttributeError`.
Expand Down
2 changes: 1 addition & 1 deletion sdk/servicebus/azure-servicebus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
[cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview
[cloud_shell_bash]: https://shell.azure.com/bash
[pip]: https://pypi.org/project/pip/
[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b6/
[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b7/
[python]: https://www.python.org/downloads/
[venv]: https://docs.python.org/3/library/venv.html
[virtualenv]: https://virtualenv.pypa.io
Expand Down
20 changes: 10 additions & 10 deletions sdk/servicebus/azure-servicebus/migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Note: The large version gap is in order to normalize service bus SDK versions ac

### Specific clients for sending and receiving
In v7 we've simplified the API surface, making two distinct clients, rather than one for each of queue, topic, and subscription:
* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusSender)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender)
* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusReceiver)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver)
* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver)
* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusSender)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender)
* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusReceiver)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver)
* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver)
and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver)

As a user this will be largely transparent to you, as initialization will still occur primarily via the top level ServiceBusClient,
the primary difference will be that rather than creating a queue_client, for instance, and then a sender off of that, you would simply
Expand Down Expand Up @@ -156,12 +156,12 @@ with queue_client.get_sender() as sender:
# Send one at a time.
for i in range(100):
message = Message("Sample message no. {}".format(i))
sender.schedule_messages(message)
sender.send(message)

# Send as a batch.
messages_to_batch = [Message("Batch message no. {}".format(i)) for i in range(10)]
batch = BatchMessage(messages_to_batch)
sender.schedule_messages(batch)
sender.send(batch)
```

In v7:
Expand All @@ -172,11 +172,11 @@ with ServiceBusClient.from_connection_string(conn_str=CONNECTION_STR) as client:
# Sending one at a time.
for i in range(100):
message = Message("Sample message no. {}".format(i))
sender.schedule_messages(message)
sender.send_messages(message)

# Send as a batch
batch = new BatchMessage()
for i in range(10):
batch.add(Message("Batch message no. {}".format(i)))
sender.schedule_messages(batch)
sender.send_messages(batch)
```

0 comments on commit a049376

Please sign in to comment.