Skip to content

Commit 7c9c7e1

Browse files
committed
Updates and clarifications to Service Bus PS docs, ported from azure-docs-powershell repo
1 parent e5b96d7 commit 7c9c7e1

21 files changed

+28
-28
lines changed

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Returns a description of the specified Service Bus namespace.
3030
## PARAMETERS
3131

3232
### -NamespaceName
33-
Namespace name.
33+
The Service Bus namespace name.
3434

3535
```yaml
3636
Type: String

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Accept wildcard characters: False
4646
```
4747
4848
### -NamespaceName
49-
Service Bus namespace name.
49+
The Service Bus namespace name.
5050
5151
```yaml
5252
Type: String

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueueKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusQueueKey** cmdlet returns the primary and secondary c
2626
PS C:\> Get-AzureRmServiceBusQueueKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1
2727
```
2828

29-
The primary and secondary connection strings are returned for the given Service Bus queue.
29+
Returns the primary and secondary connection strings for the specified Service Bus queue.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusSubscription** cmdlet returns a subscription descript
2626
PS C:\> Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
2727
```
2828

29-
Returns a subscription description for the specified Service Bus Topic.
29+
Returns a subscription description for the specified Service Bus topic.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusTopic** cmdlet returns a topic description for the sp
2626
PS C:\> Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
2727
```
2828

29-
Returns the description of the specified topic for given Service Bus namespace.
29+
Returns the description of the specified topic for the given Service Bus namespace.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopicKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusTopicKey** cmdlet returns the primary and secondary c
2626
PS C:\> Get-AzureRmServiceBusTopicKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -AuthorizationRuleName SBTopicAuthoRule1
2727
```
2828

29-
The primary and secondary connection strings are returned for the given Service Bus topic.
29+
Returns the primary and secondary connection strings for the specified Service Bus topic.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusNamespace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# New-AzureRmServiceBusNamespace
88

99
## SYNOPSIS
10-
Create a new Service Bus namespace.
10+
Creates a new Service Bus namespace.
1111

1212
## SYNTAX
1313

@@ -17,7 +17,7 @@ New-AzureRmServiceBusNamespace [-ResourceGroupName] <String> [-Location] <String
1717
```
1818

1919
## DESCRIPTION
20-
The **New-AzureRmServiceBusNamespace** cmdlet creates a new Service Bus namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
20+
The **New-AzureRmServiceBusNamespace** cmdlet creates a new Service Bus namespace. Once created, the namespace resource manifest is immutable. This operation is idempotent.
2121

2222
## EXAMPLES
2323

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusNamespaceKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ New-AzureRmServiceBusNamespaceKey [-ResourceGroup] <String> [-NamespaceName] <St
1717
```
1818

1919
## DESCRIPTION
20-
The **New-AzureRmServiceBusNamespace** cmdlet RegenerateKeys new primary or secondary connection strings for the specified Namespace and authorization rule.
20+
The **New-AzureRmServiceBusNamespace** cmdlet generates new primary or secondary connection strings for the specified namespace and authorization rule.
2121

2222
## EXAMPLES
2323

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusQueue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# New-AzureRmServiceBusQueue
88

99
## SYNOPSIS
10-
Create a new Service Bus queue in the specified Service Bus namespace.
10+
Creates a Service Bus queue in the specified Service Bus namespace.
1111

1212
## SYNTAX
1313

@@ -22,7 +22,7 @@ New-AzureRmServiceBusQueue [-ResourceGroup] <String> [-NamespaceName] <String> [
2222
```
2323

2424
## DESCRIPTION
25-
The **New-AzureRmServiceBusQueue** cmdlet creates a new Service Bus queue in the specified Service Bus namespace.
25+
The **New-AzureRmServiceBusQueue** cmdlet creates a Service Bus queue in the specified Service Bus namespace.
2626

2727
## EXAMPLES
2828

@@ -36,7 +36,7 @@ Creates a new Service Bus queue `SB-Queue_exampl1` in the specified Service Bus
3636
## PARAMETERS
3737

3838
### -AutoDeleteOnIdle
39-
Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
39+
Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval, after which the queue is automatically deleted. The minimum duration is 5 minutes.
4040

4141
```yaml
4242
Type: String

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusQueueAuthorizationRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The **New-AzureRmServiceBusQueueAuthorizationRule** cmdlet creates a new authori
2727
PS C:\> New-AzureRmServiceBusQueueAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1 -Rights @("Listen","Send")
2828
```
2929

30-
Creates `SBAuthoRule1` with **Listen and Send** rights for the queue `SB-Queue_exampl1`.
30+
Creates authorization rule `SBAuthoRule1` with **Listen and Send** rights for the queue `SB-Queue_exampl1`.
3131

3232
## PARAMETERS
3333

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusQueueKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ New-AzureRmServiceBusQueueKey [-ResourceGroup] <String> [-NamespaceName] <String
1717
```
1818

1919
## DESCRIPTION
20-
The **New-AzureRmServiceBusQueueKey** cmdlet regenerates new primary or secondary connection strings for the specified Service Bus queue and authorization rule.
20+
The **New-AzureRmServiceBusQueueKey** cmdlet regenerates the primary or secondary connection strings for the specified Service Bus queue and authorization rule.
2121

2222
## EXAMPLES
2323

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusSubscription.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# New-AzureRmServiceBusSubscription
88

99
## SYNOPSIS
10-
Create a new subscription to the specified ServiceBus topic.
10+
Creates a subscription to the specified Service Bus topic.
1111

1212
## SYNTAX
1313

@@ -29,12 +29,12 @@ The **New-AzureRmServiceBusSubscription** cmdlet creates a new subscription to t
2929
PS C:\> New-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
3030
```
3131

32-
Creates a new subscription `SB-TopicSubscription-Example1` for the specified Service Bus topic `SB-Topic_exampl1`.
32+
Creates the subscription `SB-TopicSubscription-Example1` for the specified Service Bus topic `SB-Topic_exampl1`.
3333

3434
## PARAMETERS
3535

3636
### -AutoDeleteOnIdle
37-
Specifies the TimeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.
37+
Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval, after which the subscription is automatically deleted. The minimum duration is 5 minutes.
3838

3939
```yaml
4040
Type: String

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusTopic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# New-AzureRmServiceBusTopic
88

99
## SYNOPSIS
10-
Create a new Service Bus topic in the specified Service Bus namespace.
10+
Creates a new Service Bus topic in the specified Service Bus namespace.
1111

1212
## SYNTAX
1313

@@ -36,7 +36,7 @@ Creates a new Service Bus topic `SB-Topic_exampl1` in the specified Service Bus
3636
## PARAMETERS
3737

3838
### -AutoDeleteOnIdle
39-
Specifies the TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
39+
Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
4040

4141
```yaml
4242
Type: String
@@ -66,7 +66,7 @@ Accept wildcard characters: False
6666
```
6767
6868
### -DuplicateDetectionHistoryTimeWindow
69-
Specifies the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
69+
Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
7070
7171
```yaml
7272
Type: String

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusTopicAuthorizationRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The **New-AzureRmServiceBusTopicAuthorizationRule** cmdlet creates a new authori
2727
PS C:\> New-AzureRmServiceBusTopicAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -AuthorizationRuleName SBTopicAuthoRule1 -Rights @("Listen","Send")
2828
```
2929

30-
Creates `SBTopicAuthoRule1` with **Listen and Send** rights for the topic `SB-Topic_exampl1`.
30+
Creates authorization rule `SBTopicAuthoRule1` with **Listen** and **Send** rights for the topic `SB-Topic_exampl1`.
3131

3232
## PARAMETERS
3333

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusTopicKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ New-AzureRmServiceBusTopicKey [-ResourceGroup] <String> [-NamespaceName] <String
1717
```
1818

1919
## DESCRIPTION
20-
The **New-AzureRmServiceBusTopicKey** cmdlet regenerates a new primary or secondary connection string for the specified Service Bus topic and authorization rule.
20+
The **New-AzureRmServiceBusTopicKey** cmdlet generates a new primary or secondary connection string for the specified Service Bus topic and authorization rule.
2121

2222
## EXAMPLES
2323

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusQueue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Remove-AzureRmServiceBusQueue** cmdlet removes the queue from the specifie
2626
PS C:\> Remove-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1
2727
```
2828

29-
Removes `SB-Queue_exampl1` from the namespace `SB-Example1`.
29+
Removes the queue `SB-Queue_exampl1` from the namespace `SB-Example1`.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Remove-AzureRmServiceBusSubscription** cmdlet removes the subscription to
2626
PS C:\> Remove-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
2727
```
2828

29-
Removes the subscription `SB-TopicSubscription-Example1` to the topic `SB-Topic_exampl1` for the specified Service Bus namespace `SB-Example1`.
29+
Removes the subscription `SB-TopicSubscription-Example1` to the topic `SB-Topic_exampl1` in the specified Service Bus namespace `SB-Example1`.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusTopic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Remove-AzureRmServiceBusTopic** cmdlet removes the topic from the specifie
2626
PS C:\> Remove-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
2727
```
2828

29-
Removes the `SB-Topic_exampl1` topic from the namespace `SB-Example1`.
29+
Removes the topic `SB-Topic_exampl1` from the namespace `SB-Example1`.
3030

3131
## PARAMETERS
3232

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusNamespaceAuthorizationRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Set-AzureRmServiceBusNamespaceAuthorizationRule [-ResourceGroup] <String> [-Name
1818
```
1919

2020
## DESCRIPTION
21-
The **Set-AzureRmServiceBusNamespaceAuthorizationRule** cmdlet updates the description for the specified authorization rule of the given Service Bus namespace.
21+
The **Set-AzureRmServiceBusNamespaceAuthorizationRule** cmdlet updates the description for the specified authorization rule in the given Service Bus namespace.
2222

2323
## EXAMPLES
2424

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusQueue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ PS C:\> $QueueObj.SupportOrdering = $True
3232
PS C:\> Set-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -QueueObj $QueueObj
3333
```
3434

35-
Updates the specified queue with a new description in the specified namespace.
35+
Updates the specified queue with a new description in the specified namespace. This example updates the **DeadLetteringOnMessageExpiration** property to **true** and **SupportOrdering** to **true**.
3636

3737
## PARAMETERS
3838

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusTopic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ PS C:\> $topicObj.EnableExpress = $True
3030
PS C:\> Set-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -TopicObj $topicObj
3131
```
3232

33-
Updates the specified topic with a new description in the specified namespace, and updates the **EnableExpress** property to **true**.
33+
Updates the specified topic with a new description in the specified namespace. This example updates the **EnableExpress** property to **true**.
3434

3535
## PARAMETERS
3636

0 commit comments

Comments
 (0)