Skip to content

Commit 07a5035

Browse files
cormacpaynecormacpayne
authored
Merge pull request #3482 from sethmanheim/doc-update
Updates and clarifications to Service Bus PS docs, ported from azure-…
2 parents c96483f + 3ba6e12 commit 07a5035

35 files changed

+246
-232
lines changed

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/Microsoft.Azure.Commands.ServiceBus.dll-Help.xml

Lines changed: 34 additions & 34 deletions
Large diffs are not rendered by default.

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

Lines changed: 3 additions & 5 deletions
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
@@ -64,16 +64,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6464
6565
## INPUTS
6666
67-
###-ResourceGroup
67+
### -ResourceGroup
6868
System.String
6969
70-
###-NamespaceName
70+
### -NamespaceName
7171
System.String
7272
7373
## OUTPUTS
7474
7575
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.NamespaceAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
76-
7776
Name : SB-Example1
7877
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1
7978
Location : West US
@@ -85,7 +84,6 @@ UpdatedAt : 1/20/2017 1:40:24 AM
8584
ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/
8685
Enabled : True
8786

88-
8987
## NOTES
9088

9189
## RELATED LINKS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceAuthorizationRule.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,27 +80,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
###-ResourceGroup
83+
### -ResourceGroup
8484
System.String
8585
86-
###-NamespaceName
86+
87+
### -NamespaceName
8788
System.String
8889
89-
###-AuthorizationRuleName
90+
91+
### -AuthorizationRuleName
9092
System.String
9193
9294
## OUTPUTS
9395
9496
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
95-
9697
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/AuthorizationRules/AuthoRule1
9798
Type : Microsoft.ServiceBus/AuthorizationRules
9899
Name : AuthoRule1
99100
Location :
100101
Tags :
101102
Rights : {Listen, Send}
102103

103-
104104
## NOTES
105105

106106
## RELATED LINKS

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

Lines changed: 6 additions & 5 deletions
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
@@ -80,19 +80,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
###-ResourceGroup
83+
### -ResourceGroup
8484
System.String
8585
86-
###-NamespaceName
86+
87+
### -NamespaceName
8788
System.String
8889
89-
###-AuthorizationRuleName
90+
91+
### -AuthorizationRuleName
9092
System.String
9193
9294
## OUTPUTS
9395
9496
### Microsoft.Azure.Management.ServiceBus.Models.ResourceListKeys
95-
9697
PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
9798
SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
9899
PrimaryKey : {PrimaryKey value}

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueue.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
###-ResourceGroup
83+
### -ResourceGroup
8484
System.String
8585
86-
###-NamespaceName
86+
87+
### -NamespaceName
8788
System.String
8889
89-
###-QueueName
90+
91+
### -QueueName
9092
System.String
9193
9294
## OUTPUTS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueueAuthorizationRule.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9595
9696
## INPUTS
9797
98-
###-ResourceGroup
98+
### -ResourceGroup
9999
System.String
100100
101-
###-NamespaceName
101+
102+
### -NamespaceName
102103
System.String
103104
104-
###-QueueName
105+
106+
### -QueueName
105107
System.String
106108
107-
###-AuthorizationRuleName
109+
110+
### -AuthorizationRuleName
108111
System.String
109112
110113
## OUTPUTS
111114
112115
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
113-
114116
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/SB-Queue_exampl1/authorizati
115117
onRules/SBAuthoRule1
116118
Type : Microsoft.ServiceBus/AuthorizationRules
@@ -119,7 +121,6 @@ Location : West US
119121
Tags :
120122
Rights : {Listen, Send}
121123

122-
123124
## NOTES
124125

125126
## RELATED LINKS

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

Lines changed: 8 additions & 6 deletions
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

@@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9595
9696
## INPUTS
9797
98-
###-ResourceGroup
98+
### -ResourceGroup
9999
System.String
100100
101-
###-NamespaceName
101+
102+
### -NamespaceName
102103
System.String
103104
104-
###-QueueName
105+
106+
### -QueueName
105107
System.String
106108
107-
###-AuthorizationRuleName
109+
110+
### -AuthorizationRuleName
108111
System.String
109112
110113
## OUTPUTS
111114
112115
### Microsoft.Azure.Commands.ServiceBus.Models.ListKeysAttributes
113-
114116
PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e
115117
xampl1
116118
SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e

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

Lines changed: 9 additions & 7 deletions
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

@@ -94,24 +94,26 @@ Accept wildcard characters: False
9494
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
9595
9696
## INPUTS
97-
###-ResourceGroup
97+
98+
### -ResourceGroup
9899
System.String
99100
100-
###-NamespaceName
101+
102+
### -NamespaceName
101103
System.String
102104
103-
###-TopicName
105+
106+
### -TopicName
104107
System.String
105108
106-
###-SubscriptionName
109+
110+
### -SubscriptionName
107111
System.String
108112
109113
110-
111114
## OUTPUTS
112115
113116
### Microsoft.Azure.Commands.ServiceBus.Models.SubscriptionAttributes
114-
115117
Name : SB-TopicSubscription-Example1
116118
Location : West US
117119
AccessedAt : 1/20/2017 3:18:54 AM

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

Lines changed: 6 additions & 6 deletions
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

@@ -80,19 +80,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
###-ResourceGroup
83+
### -ResourceGroup
8484
System.String
8585
86-
###-NamespaceName
86+
87+
### -NamespaceName
8788
System.String
8889
89-
###-TopicName
90+
91+
### -TopicName
9092
System.String
9193
9294
## OUTPUTS
9395
9496
### Microsoft.Azure.Commands.ServiceBus.Models.TopicAttributes
95-
9697
Name : SB-Topic_exampl1
9798
Location : West US
9899
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/S
@@ -120,7 +121,6 @@ SubscriptionCount : 1
120121
SupportOrdering : False
121122
UpdatedAt : 1/20/2017 3:16:43 AM
122123
123-
124124
## NOTES
125125
126126
## RELATED LINKS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopicAuthorizationRule.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9595
9696
## INPUTS
9797
98-
###-ResourceGroup
98+
### -ResourceGroup
9999
System.String
100100
101-
###-NamespaceName
101+
102+
### -NamespaceName
102103
System.String
103104
104-
###-TopicName
105+
106+
### -TopicName
105107
System.String
106108
107-
###-AuthorizationRuleName
109+
110+
### -AuthorizationRuleName
108111
System.String
109112
110113
## OUTPUTS
111114
112115
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
113-
114116
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-Topic_example1/authorizati
115117
onRules/SBTopicAuthoRule1
116118
Type : Microsoft.ServiceBus/AuthorizationRules
@@ -119,7 +121,6 @@ Location : West US
119121
Tags :
120122
Rights : {Listen, Send}
121123

122-
123124
## NOTES
124125

125126
## RELATED LINKS

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

Lines changed: 8 additions & 5 deletions
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

@@ -95,16 +95,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9595
9696
## INPUTS
9797
98-
###-ResourceGroup
98+
### -ResourceGroup
9999
System.String
100100
101-
###-NamespaceName
101+
102+
### -NamespaceName
102103
System.String
103104
104-
###-TopicName
105+
106+
### -TopicName
105107
System.String
106108
107-
###-AuthorizationRuleName
109+
110+
### -AuthorizationRuleName
108111
System.String
109112
110113
## OUTPUTS

0 commit comments

Comments
 (0)