Skip to content

Commit a5d1d85

Browse files
Improve structure of the asb tool docs (#6996)
1 parent 99fda38 commit a5d1d85

10 files changed

+151
-153
lines changed

nservicebus/hosting/azure-functions-service-bus/in-process/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Use the [`asb-transport` command line (CLI) tool](/transports/azure-service-bus/
7878
asb-transport endpoint create <queue name>
7979
```
8080

81-
See the [full documentation](/transports/azure-service-bus/operational-scripting.md#operational-scripting-asb-transport-endpoint-create) for the `asb-transport endpoint create` command for more details.
81+
See the [full documentation](/transports/azure-service-bus/operational-scripting.md#available-commands-asb-transport-endpoint-create) for the `asb-transport endpoint create` command for more details.
8282

8383
> [!WARNING]
8484
> If the `asb-tranport` command-line tool is not used to create the queue, it is recommended to set the `MaxDeliveryCount` setting to the maximum value.
@@ -89,7 +89,7 @@ See the [full documentation](/transports/azure-service-bus/operational-scripting
8989
asb-transport endpoint subscribe <queue name> <eventtype>
9090
```
9191

92-
See the [full documentation](/transports/azure-service-bus/operational-scripting.md#operational-scripting-asb-transport-endpoint-subscribe) for the `asb-transport endpoint subscribe` command for more details.
92+
See the [full documentation](/transports/azure-service-bus/operational-scripting.md#available-commands-asb-transport-endpoint-subscribe) for the `asb-transport endpoint subscribe` command for more details.
9393

9494
partial: assembly-scanner
9595

nservicebus/hosting/azure-functions-service-bus/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To manually provision the entities in the namespace for the Function endpoint, u
6666
asb-transport endpoint create <queue name>
6767
```
6868

69-
For more details, see the [operation scripting documentation](/transports/azure-service-bus/operational-scripting.md#operational-scripting-asb-transport-endpoint-create) for the `asb-transport endpoint create` command.
69+
For more details, see the [operation scripting documentation](/transports/azure-service-bus/operational-scripting.md#available-commands-asb-transport-endpoint-create) for the `asb-transport endpoint create` command.
7070

7171
> [!WARNING]
7272
> If the `asb-transport` command-line tool is not used to create the queue, set the `MaxDeliveryCount` setting to the maximum value.
@@ -77,6 +77,6 @@ For more details, see the [operation scripting documentation](/transports/azure-
7777
asb-transport endpoint subscribe <queue name> <eventtype>
7878
```
7979

80-
For more details, see the [operational scripting documentation](/transports/azure-service-bus/operational-scripting.md#operational-scripting-asb-transport-endpoint-subscribe) for the `asb-transport endpoint subscribe` command.
80+
For more details, see the [operational scripting documentation](/transports/azure-service-bus/operational-scripting.md#available-commands-asb-transport-endpoint-subscribe) for the `asb-transport endpoint subscribe` command.
8181

8282
partial: package-requirements

servicecontrol/queues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ServiceControl relies on a number of queues to function. The simplest way to con
99

1010
These queues can be manually created before deploying a ServiceControl instance. The technique used will differ depending on the transport in use:
1111

12-
- [Azure Service Bus](/transports/azure-service-bus/operational-scripting.md#operational-scripting-asb-transport-queue-create)
12+
- [Azure Service Bus](/transports/azure-service-bus/operational-scripting.md#available-commands-asb-transport-queue-create)
1313
- [Azure Storage Queues](/transports/azure-storage-queues/operations-scripting.md#create-queues)
1414
- [SQL Server](/transports/sql/operations-scripting.md#create-queues)
1515
- [MSMQ](/transports/msmq/operations-scripting.md#create-queues)

transports/azure-service-bus/operational-scripting.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ Once installed, the `asb-transport` command line tool will be available for use.
1919

2020
`asb-transport <command> [options]`
2121

22+
## Available commands
23+
24+
- `endpoint create`
25+
- `endpoint subscribe`
26+
- `endpoint unsubscribe`
27+
- `queue create`
28+
- `queue delete`
29+
2230
partial: endpoint-command
2331

2432
### asb-transport queue create
@@ -56,22 +64,24 @@ asb-transport queue delete name
5664

5765
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
5866

59-
### Examples
67+
partial: migration-endpoint-command
68+
69+
## Examples
6070

61-
#### Provisioning the audit and the error queues
71+
### Provisioning the audit and the error queues
6272

6373
```
6474
asb-transport queue create audit -c "<connection-string>"
6575
asb-transport queue create error -c "<connection-string>"
6676
```
6777

68-
#### Using connection strings
78+
### Using connection strings
6979

7080
```
7181
asb-transport [command] [subcommand] -c "<connection-string>"
7282
```
7383

74-
#### Using cached credentials
84+
### Using cached credentials
7585

7686
```
7787
asb-transport [command] [subcommand] -n "somenamespace.servicebus.windows.net"

transports/azure-service-bus/operational-scripting_endpoint-command_asbs_[,5).partial.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
### Available commands
2-
3-
- `endpoint create`
4-
- `endpoint subscribe`
5-
- `endpoint unsubscribe`
6-
- `queue create`
7-
- `queue delete`
8-
91
### asb-transport endpoint create
102

11-
Create a new endpoint using:
3+
Creates infrastructure for an endpoint: input queue, topic, and subscription.
124

135
```
146
asb-transport endpoint create name
@@ -39,7 +31,7 @@ asb-transport endpoint create name
3931

4032
### asb-transport endpoint subscribe
4133

42-
Create a new subscription for an endpoint using:
34+
Creates a new subscription for an endpoint.
4335

4436
```
4537
asb-transport endpoint subscribe name event-type
@@ -62,7 +54,7 @@ asb-transport endpoint subscribe name event-type
6254

6355
### asb-transport endpoint unsubscribe
6456

65-
Delete a subscription for an endpoint using:
57+
Deletes a subscription for an endpoint.
6658

6759
```
6860
asb-transport endpoint unsubscribe name event-type
Lines changed: 3 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
1-
### Available commands
2-
3-
- `endpoint create`
4-
- `endpoint subscribe`
5-
- `endpoint unsubscribe`
6-
- `migration endpoint create`
7-
- `migration endpoint subscribe`
8-
- `migration endpoint unsubscribe`
9-
- `migration endpoint subscribe migrated`
10-
- `migration endpoint unsubscribe migrated`
11-
- `queue create`
12-
- `queue delete`
13-
141
### asb-transport endpoint create
152

16-
Create a new endpoint using:
3+
Creates infrastructure for an endpoint -- input queue.
174

185
```
196
asb-transport endpoint create name
@@ -33,7 +20,7 @@ asb-transport endpoint create name
3320

3421
### asb-transport endpoint subscribe
3522

36-
Create a new subscription for an endpoint using:
23+
Creates a new subscription for an endpoint.
3724

3825
```
3926
asb-transport endpoint subscribe name topic
@@ -50,7 +37,7 @@ asb-transport endpoint subscribe name topic
5037

5138
### asb-transport endpoint unsubscribe
5239

53-
Delete a subscription for an endpoint using:
40+
Deletes a subscription for an endpoint.
5441

5542
```
5643
asb-transport endpoint unsubscribe name topic
@@ -64,114 +51,3 @@ asb-transport endpoint unsubscribe name topic
6451
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
6552

6653
`-b` | `--subscription`: Subscription name (defaults to endpoint name)
67-
68-
### asb-transport migration endpoint create
69-
70-
Create a new endpoint that uses migration topology using:
71-
72-
```
73-
asb-transport migration endpoint create name
74-
[--size]
75-
[--partitioned]
76-
[--topic]
77-
[--topic-to-publish-to] [--topic-to-subscribe-on]
78-
[--subscription]
79-
```
80-
81-
#### options
82-
83-
`-c` | `--connection-string` : Overrides the environment variable 'AzureServiceBus_ConnectionString'
84-
85-
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
86-
87-
`-s` | `--size` : Queue size in GB (defaults to 5)
88-
89-
`-p` | `--partitioned`: Enable partitioning
90-
91-
`-t` | `--topic`: Topic name (defaults to 'bundle-1')
92-
93-
`-tp` | `--topic-to-publish-to`: The topic name to publish to.
94-
95-
`-ts` | `--topic-to-subscribe-on`: The topic name to subscribe on.
96-
97-
`-b` | `--subscription`: Subscription name (defaults to endpoint name)
98-
99-
### asb-transport migration endpoint subscribe
100-
101-
Create a new subscription for an endpoint that uses migration topology using:
102-
103-
```
104-
asb-transport migration endpoint subscribe name event-type
105-
[--topic]
106-
[--subscription]
107-
[--rule-name]
108-
```
109-
110-
#### Options
111-
112-
`-c` | `--connection-string` : Overrides the environment variable 'AzureServiceBus_ConnectionString'
113-
114-
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
115-
116-
`-t` | `--topic`: Topic name to subscribe on (defaults to 'bundle-1')
117-
118-
`-b` | `--subscription`: Subscription name (defaults to endpoint name)
119-
120-
`-r` | `--rule-name`: Rule name (defaults to event type)
121-
122-
### asb-transport migration endpoint unsubscribe
123-
124-
Delete a subscription for an endpoint that uses migration topology using:
125-
126-
```
127-
asb-transport migration endpoint unsubscribe name event-type
128-
[--topic]
129-
[--subscription]
130-
[--rule-name]
131-
```
132-
133-
#### Options
134-
135-
`-c` | `--connection-string` : Overrides the environment variable 'AzureServiceBus_ConnectionString'
136-
137-
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
138-
139-
`-t` | `--topic`: Topic name to unsubscribe from (defaults to 'bundle-1')
140-
141-
`-b` | `--subscription`: Subscription name (defaults to endpoint name)
142-
143-
`-r` | `--rule-name`: Rule name (defaults to event type)
144-
145-
### asb-transport migration endpoint subscribe-migrated
146-
147-
Create a new subscription for an endpoint that uses migration topology using:
148-
149-
```
150-
asb-transport migration endpoint subscribe-migrated name topic
151-
[--subscription]
152-
```
153-
154-
#### Options
155-
156-
`-c` | `--connection-string` : Overrides the environment variable 'AzureServiceBus_ConnectionString'
157-
158-
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
159-
160-
`-b` | `--subscription`: Subscription name (defaults to endpoint name)
161-
162-
### asb-transport migration endpoint unsubscribe-migrated
163-
164-
Delete a subscription for an endpoint that uses migration topology using:
165-
166-
```
167-
asb-transport migration endpoint unsubscribe-migrated name topic
168-
[--subscription]
169-
```
170-
171-
#### Options
172-
173-
`-c` | `--connection-string` : Overrides the environment variable 'AzureServiceBus_ConnectionString'
174-
175-
`-n` | `--namespace` : Sets the fully qualified namespace to connect with cached credentials, e.g., credentials from Azure PowerShell or CLI. This setting cannot be used in conjunction with the connection string setting.
176-
177-
`-b` | `--subscription`: Subscription name (defaults to endpoint name)

transports/azure-service-bus/operational-scripting_examples_asbs_[,5).partial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### Provisioning endpoints
1+
### Provisioning endpoints
22

33
Create the topology for an endpoint named `MyEndpoint` using the default settings:
44

@@ -18,7 +18,7 @@ Create the topology for an endpoint named `MyEndpoint` and override the publish
1818
asb-transport endpoint create MyEndpoint -tp custom-publish-topic -ts custom-subscribe-topic -c "<connection-string>"
1919
```
2020

21-
#### Subscribing to events
21+
### Subscribing to events
2222

2323
Subscribe `MyOtherEndpoint` to the event `Contracts.Events.SomeEvent` using the default settings:
2424

transports/azure-service-bus/operational-scripting_examples_asbs_[5,).partial.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
#### Provisioning endpoints
1+
### Provisioning endpoints
22

33
Create the topology for an endpoint named `MyEndpoint`:
44

55
```
66
asb-transport endpoint create MyEndpoint -c "<connection-string>"
77
```
88

9-
#### Subscribing to events
9+
### Subscribing to events
1010

1111
Subscribe `MyOtherEndpoint` to the event `Contracts.Events.SomeEvent` using the default settings:
1212

@@ -20,7 +20,7 @@ Subscribe `MyOtherEndpoint` to the event `Contracts.Events.SomeEvent` and overri
2020
asb-transport endpoint subscribe MyOtherEndpoint Contracts.Events.SomeEvent -s my-other-endpoint -c "<connection-string>"
2121
```
2222

23-
#### Provisioning endpoints that use migration topology
23+
### Provisioning endpoints that use migration topology
2424

2525
Create the topology for an endpoint named `MyEndpoint` using the default settings:
2626

@@ -40,7 +40,7 @@ Create the topology for an endpoint named `MyEndpoint` and override the publish
4040
asb-transport migration endpoint create MyEndpoint -tp custom-publish-topic -ts custom-subscribe-topic -c "<connection-string>"
4141
```
4242

43-
#### Subscribing to events
43+
### Subscribing to events
4444

4545
Subscribe `MyOtherEndpoint` to the event `Contracts.Events.SomeEvent` using the default settings:
4646

transports/azure-service-bus/operational-scripting_migration-endpoint-command_asbs_[,5).partial.md

Whitespace-only changes.

0 commit comments

Comments
 (0)