You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/service-bus-messaging/explorer.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Operations run on an Azure Service Bus namespace are of two kinds.
21
21
22
22
> [!IMPORTANT]
23
23
> - Service Bus Explorer doesn't support **management operations** and **sessions**.
24
-
> - We advice against using the Service Bus Explorer for larger messages, as this may result in timeouts, depending on the message size, network latency between client and Service Bus service etc. Instead, we recommend that you use your own client to work with larger messages, where you can specify your own timeout values.
24
+
> - We advice against using the Service Bus Explorer for larger messages, as it may result in timeouts, depending on the message size, network latency between client and Service Bus service etc. Instead, we recommend that you use your own client to work with larger messages, where you can specify your own timeout values.
25
25
26
26
27
27
## Prerequisites
@@ -43,7 +43,7 @@ To use the Service Bus Explorer tool, you need to do the following tasks:
43
43
44
44
To use the Service Bus Explorer, navigate to the Service Bus namespace on which you want to do data operations.
45
45
46
-
1. If you're looking to run operations against a queue, select **Queues** from the navigation menu. If you're looking to run operations against a topic (and it's related subscriptions), select **Topics**.
46
+
1. If you're looking to run operations against a queue, select **Queues** from the navigation menu. If you're looking to run operations against a topic (and its related subscriptions), select **Topics**.
47
47
48
48
:::image type="content" source="./media/service-bus-explorer/queue-topics-left-navigation.png" alt-text="Screenshot of left side navigation, where entity can be selected." lightbox="./media/service-bus-explorer/queue-topics-left-navigation.png":::
49
49
1. After selecting **Queues** or **Topics**, select the specific queue or topic.
@@ -57,6 +57,11 @@ To use the Service Bus Explorer, navigate to the Service Bus namespace on which
57
57
> When peeking or receiving from a subscription, first select the specific **Subscription** from the dropdown selector.
58
58
> :::image type="content" source="./media/service-bus-explorer/subscription-selected.png" alt-text="Screenshot of dropdown for topic subscriptions." lightbox="./media/service-bus-explorer/subscription-selected.png":::
59
59
60
+
> [!NOTE]
61
+
> When you navigate to Service Bus explorer for an entity in a namespace that has the public access disabled, you see the following message eventhough you access it from a virtual machine that's in the same virtual network as the private endpoint. You can ignore it.
62
+
>
63
+
> "The namespace has public network access disabled. Data operations such as Peek, Send, or Receive against this Service Bus entit don't work until you switch to all networks or allowlist your client IP in selected networks."
64
+
60
65
## Peek a message
61
66
62
67
With the peek functionality, you can use the Service Bus Explorer to view the top 100 messages in a queue, subscription, or dead-letter queue.
@@ -82,10 +87,10 @@ With the peek functionality, you can use the Service Bus Explorer to view the to
82
87
:::image type="content" source="./media/service-bus-explorer/peek-message-from-queue-2.png" alt-text="Screenshot with overview of peeked messages and message properties shown for peeked messages." lightbox="./media/service-bus-explorer/peek-message-from-queue-2.png":::
83
88
84
89
> [!NOTE]
85
-
> Since peek is not a destructive operation the message **won't** be removed from the entity.
90
+
> Since peek isn't a destructive operation the message **won't** be removed from the entity.
86
91
87
92
> [!NOTE]
88
-
> For performance reasons, when peeking messages from a queue or subscription which has it's maximum message size set over 1MB, the message body will not be retrieved by default. Instead, you can load the message body for a specific message by clicking on the **Load message body** button. If the message body is over 1MB it will be truncated before being displayed.
93
+
> For performance reasons, when peeking messages from a queue or subscription which has it's maximum message size set over 1 MB, the message body isn't retrieved by default. Instead, you can load the message body for a specific message by clicking on the **Load message body** button. If the message body is over 1 MB it's not truncated before being displayed.
89
94
> :::image type="content" source="./media/service-bus-explorer/peek-message-from-queue-with-large-message-support.png" alt-text="Screenshot with overview of peeked messages and button to load message body shown." lightbox="./media/service-bus-explorer/peek-message-from-queue-with-large-message-support.png":::
90
95
91
96
### Peek a message with advanced options
@@ -113,7 +118,7 @@ The peek with options functionality allows you to use the Service Bus Explorer t
113
118
:::image type="content" source="./media/service-bus-explorer/peek-message-from-queue-4.png" alt-text="Screenshot with overview of peeked messages and message properties shown for peek with advanced options." lightbox="./media/service-bus-explorer/peek-message-from-queue-4.png":::
114
119
115
120
> [!NOTE]
116
-
> Since peek is not a destructive operation the message **won't** be removed from the queue.
121
+
> Since peek isn't a destructive operation the message **won't** be removed from the queue.
117
122
118
123
## Receive a message
119
124
@@ -132,7 +137,7 @@ The receive function on the Service Bus Explorer permits receiving messages from
132
137
:::image type="content" source="./media/service-bus-explorer/receive-message-from-queue.png" alt-text="Screenshot indicating the Receive button, and a page where the options can be set." lightbox="./media/service-bus-explorer/receive-message-from-queue.png":::
133
138
134
139
> [!IMPORTANT]
135
-
> Please note that the ReceiveAndDelete mode is a ***destructive receive***, i.e. the message is removed from the queue when it is displayed on the Service Bus Explorer tool.
140
+
> Note that the ReceiveAndDelete mode is a ***destructive receive***, i.e. the message is removed from the queue when it's displayed on the Service Bus Explorer tool.
136
141
>
137
142
> To browse messages without removing them from the queue, consider using the **Peek** functionality, or using the **PeekLock** receive mode.
138
143
@@ -143,7 +148,7 @@ The receive function on the Service Bus Explorer permits receiving messages from
143
148
:::image type="content" source="./media/service-bus-explorer/receive-message-from-queue-3.png" alt-text="Screenshot with overview of received messages and message properties shown." lightbox="./media/service-bus-explorer/receive-message-from-queue-3.png":::
144
149
145
150
> [!NOTE]
146
-
> For performance reasons, when receiving messages from a queue or subscription which has it's maximum message size set over 1MB, only one message will be received at a time. If the message body is over 1MB it will be truncated before being displayed.
151
+
> For performance reasons, when receiving messages from a queue or subscription which has it's maximum message size set over 1 MB, only one message is received at a time. If the message body is over 1 MB, it's truncated before being displayed.
147
152
148
153
After a message is received in **PeekLock** mode, there are various actions you can take on it.
149
154
@@ -158,7 +163,7 @@ After a message is received in **PeekLock** mode, there are various actions you
158
163
:::image type="content" source="./media/service-bus-explorer/receive-message-from-queue-complete.png" alt-text="Screenshot indicating the Complete button." lightbox="./media/service-bus-explorer/receive-message-from-queue-complete.png":::
159
164
160
165
> [!IMPORTANT]
161
-
> Please note that completing a message is a ***destructive receive***, i.e. the message is removed from the queue when **Complete** has been selected in the Service Bus Explorer tool.
166
+
> Please note that completing a message is a ***destructive receive***, that is, the message is removed from the queue when **Complete** has been selected in the Service Bus Explorer tool.
162
167
163
168
### Defer a message
164
169
@@ -174,7 +179,7 @@ After a message is received in **PeekLock** mode, there are various actions you
174
179
175
180
:::image type="content" source="./media/service-bus-explorer/receive-message-from-queue-abandon-lock.png" alt-text="Screenshot indicating the Abandon Lock button." lightbox="./media/service-bus-explorer/receive-message-from-queue-abandon-lock.png":::
176
181
177
-
After the lock is abandoned, the message will be available for receive operations again.
182
+
After the lock is abandoned, the message is available for receive operations again.
178
183
179
184
### Dead-letter
180
185
@@ -183,7 +188,7 @@ After the lock is abandoned, the message will be available for receive operation
183
188
184
189
:::image type="content" source="./media/service-bus-explorer/receive-message-from-queue-dead-letter.png" alt-text="Screenshot indicating the Dead-letter button." lightbox="./media/service-bus-explorer/receive-message-from-queue-dead-letter.png":::
185
190
186
-
After a message is dead-lettered, it will be available from the **Dead-letter** subqueue.
191
+
After a message is dead-lettered, it's available from the **Dead-letter** subqueue.
187
192
188
193
### Purge messages
189
194
@@ -213,7 +218,7 @@ To send a message to a **queue** or a **topic**, select the **Send messages** bu
213
218
214
219
## Resend a message
215
220
216
-
After peeking or receiving a message, you can resend it, which will send a copy of the message to the same entity, while allowing us to update it's content and properties. The original remains and isn't deleted even when resend is from the deadletter queue.
221
+
After peeking or receiving a message, you can resend it, which sends a copy of the message to the same entity, while allowing us to update it's content and properties. The original remains and isn't deleted even when resend is from the deadletter queue.
217
222
218
223
1. In the grid, select one or more messages you want to resend.
219
224
1. Select the **Re-send selected messages** button.
@@ -227,7 +232,7 @@ After peeking or receiving a message, you can resend it, which will send a copy
227
232
228
233
> [!NOTE]
229
234
> - The resend operation sends a copy of the original message. It doesn't remove the original message that you resubmit.
230
-
> - If you resend a message in a dead-letter queue of a subscription, a copy of the message is sent to the topic. Therefore, all subscriptions will receive a copy of the message.
235
+
> - If you resend a message in a dead-letter queue of a subscription, a copy of the message is sent to the topic. Therefore, all subscriptions receive a copy of the message.
0 commit comments