Skip to content

Commit 69d68cd

Browse files
author
Maddie Clayton
committed
Regenerate ServiceBus help files
1 parent 12821d9 commit 69d68cd

28 files changed

+919
-423
lines changed

src/ResourceManager/ServiceBus/Commands.ServiceBus/help/AzureRM.ServiceBus.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,81 @@ Locale: en-US
1111
This topic displays help topics for the Azure Service Bus cmdlets.
1212

1313
## AzureRM.ServiceBus Cmdlets
14+
### [Get-AzureRmServiceBusAuthorizationRule](Get-AzureRmServiceBusAuthorizationRule.md)
15+
Gets a description of the specified authorization rule for a given Namespace or Queue or Topic.
16+
17+
### [Get-AzureRmServiceBusKey](Get-AzureRmServiceBusKey.md)
18+
Gets the primary and secondary connection strings for the given Namespace or Queue or Topic.
19+
1420
### [Get-AzureRmServiceBusNamespace](Get-AzureRmServiceBusNamespace.md)
1521
Gets a description for the specified Service Bus namespace within the resource group.
1622

23+
### [Get-AzureRmServiceBusOperation](Get-AzureRmServiceBusOperation.md)
24+
List supported ServiceBus Operations
25+
1726
### [Get-AzureRmServiceBusQueue](Get-AzureRmServiceBusQueue.md)
1827
Returns a description for the specified Service Bus queue.
1928

29+
### [Get-AzureRmServiceBusRule](Get-AzureRmServiceBusRule.md)
30+
Gets a description of the specified rule for a given Subscription of Topic.
31+
2032
### [Get-AzureRmServiceBusSubscription](Get-AzureRmServiceBusSubscription.md)
2133
Returns a subscription description for the specified topic.
2234

2335
### [Get-AzureRmServiceBusTopic](Get-AzureRmServiceBusTopic.md)
2436
Returns a description for the specified Service Bus topic.
2537

38+
### [New-AzureRmServiceBusAuthorizationRule](New-AzureRmServiceBusAuthorizationRule.md)
39+
Creates a new authorization rule for the specified Service Bus given Namespace or Queue or Topic.
40+
41+
### [New-AzureRmServiceBusKey](New-AzureRmServiceBusKey.md)
42+
Regenerates the primary or secondary connection strings for the Service Bus namespace or queue or topic.
43+
2644
### [New-AzureRmServiceBusNamespace](New-AzureRmServiceBusNamespace.md)
2745
Creates a new Service Bus namespace.
2846

2947
### [New-AzureRmServiceBusQueue](New-AzureRmServiceBusQueue.md)
3048
Creates a Service Bus queue in the specified Service Bus namespace.
3149

50+
### [New-AzureRmServiceBusRule](New-AzureRmServiceBusRule.md)
51+
Creates a new rule for a given Subscription of Topic.
52+
3253
### [New-AzureRmServiceBusSubscription](New-AzureRmServiceBusSubscription.md)
3354
Creates a subscription to the specified Service Bus topic.
3455

3556
### [New-AzureRmServiceBusTopic](New-AzureRmServiceBusTopic.md)
3657
Creates a new Service Bus topic in the specified Service Bus namespace.
3758

59+
### [Remove-AzureRmServiceBusAuthorizationRule](Remove-AzureRmServiceBusAuthorizationRule.md)
60+
Removes the authorization rule of a Service Bus namespace or queue or topic from the specified resource group.
61+
3862
### [Remove-AzureRmServiceBusNamespace](Remove-AzureRmServiceBusNamespace.md)
3963
Removes the namespace from the specified resource group.
4064

4165
### [Remove-AzureRmServiceBusQueue](Remove-AzureRmServiceBusQueue.md)
4266
Removes the queue from the specified Service Bus namespace.
4367

68+
### [Remove-AzureRmServiceBusRule](Remove-AzureRmServiceBusRule.md)
69+
Removes the speficied rule of a given subscription .
70+
4471
### [Remove-AzureRmServiceBusSubscription](Remove-AzureRmServiceBusSubscription.md)
4572
Removes the subscription to a topic from the specified Service Bus namespace.
4673

4774
### [Remove-AzureRmServiceBusTopic](Remove-AzureRmServiceBusTopic.md)
4875
Removes the topic from the specified Service Bus namespace.
4976

77+
### [Set-AzureRmServiceBusAuthorizationRule](Set-AzureRmServiceBusAuthorizationRule.md)
78+
Updates the specified authorization rule description for the given Service Bus namespace or queue or topic.
79+
5080
### [Set-AzureRmServiceBusNamespace](Set-AzureRmServiceBusNamespace.md)
5181
Updates the description of an existing Service Bus namespace.
5282

5383
### [Set-AzureRmServiceBusQueue](Set-AzureRmServiceBusQueue.md)
5484
Updates the description of a Service Bus queue in the specified Service Bus namespace.
5585

86+
### [Set-AzureRmServiceBusRule](Set-AzureRmServiceBusRule.md)
87+
Updates the specified rule description for the given subscription.
88+
5689
### [Set-AzureRmServiceBusSubscription](Set-AzureRmServiceBusSubscription.md)
5790
Updates a subscription description for a Service Bus topic in the specified Service Bus namespace.
5891

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

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -14,18 +15,19 @@ Gets a description of the specified authorization rule for a given Namespace or
1415
### NamespaceAuthorizationRuleSet (Default)
1516
```
1617
Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1719
```
1820

1921
### QueueAuthorizationRuleSet
2022
```
21-
Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-Queue] <String>
22-
[[-Name] <String>]
23+
Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String>
24+
[[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2325
```
2426

2527
### TopicAuthorizationRuleSet
2628
```
27-
Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-Topic] <String>
28-
[[-Name] <String>]
29+
Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String>
30+
[[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2931
```
3032

3133
## DESCRIPTION
@@ -56,6 +58,21 @@ Returns the specified authorization rule description for a specified topic.
5658

5759
## PARAMETERS
5860

61+
### -DefaultProfile
62+
The credentials, account, tenant, and subscription used for communication with azure.
63+
64+
```yaml
65+
Type: IAzureContextContainer
66+
Parameter Sets: (All)
67+
Aliases: AzureRmContext, AzureCredential
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
5976
### -Name
6077
AuthorizationRule Name.
6178
@@ -76,7 +93,7 @@ Namespace Name.
7693
7794
```yaml
7895
Type: String
79-
Parameter Sets: NamespaceAuthorizationRuleSet
96+
Parameter Sets: (All)
8097
Aliases: NamespaceName
8198

8299
Required: True
@@ -86,18 +103,6 @@ Accept pipeline input: True (ByPropertyName)
86103
Accept wildcard characters: False
87104
```
88105
89-
```yaml
90-
Type: String
91-
Parameter Sets: QueueAuthorizationRuleSet, TopicAuthorizationRuleSet
92-
Aliases: NamespaceName
93-
94-
Required: False
95-
Position: 1
96-
Default value: None
97-
Accept pipeline input: True (ByPropertyName)
98-
Accept wildcard characters: False
99-
```
100-
101106
### -Queue
102107
Queue Name.
103108
@@ -143,16 +148,17 @@ Accept pipeline input: True (ByPropertyName)
143148
Accept wildcard characters: False
144149
```
145150
151+
### CommonParameters
152+
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).
153+
146154
## INPUTS
147155
148156
### System.String
149157
150-
151158
## OUTPUTS
152159
153160
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.4.2.0, Culture=neutral, PublicKeyToken=null]]
154161

155-
156162
## NOTES
157163

158-
## RELATED LINKS
164+
## RELATED LINKS

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

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -14,18 +15,19 @@ Gets the primary and secondary connection strings for the given Namespace or Que
1415
### NamespaceAuthorizationRuleSet (Default)
1516
```
1617
Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1719
```
1820

1921
### QueueAuthorizationRuleSet
2022
```
21-
Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-Queue] <String>
22-
[-Name] <String>
23+
Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> [-Name] <String>
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2325
```
2426

2527
### TopicAuthorizationRuleSet
2628
```
27-
Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-Topic] <String>
28-
[-Name] <String>
29+
Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-Name] <String>
30+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2931
```
3032

3133
## DESCRIPTION
@@ -56,6 +58,21 @@ Primary and secondary connection string to the specified topic.
5658

5759
## PARAMETERS
5860

61+
### -DefaultProfile
62+
The credentials, account, tenant, and subscription used for communication with azure.
63+
64+
```yaml
65+
Type: IAzureContextContainer
66+
Parameter Sets: (All)
67+
Aliases: AzureRmContext, AzureCredential
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
5976
### -Name
6077
AuthorizationRule Name.
6178
@@ -76,7 +93,7 @@ Namespace Name.
7693
7794
```yaml
7895
Type: String
79-
Parameter Sets: NamespaceAuthorizationRuleSet
96+
Parameter Sets: (All)
8097
Aliases: NamespaceName
8198

8299
Required: True
@@ -86,18 +103,6 @@ Accept pipeline input: True (ByPropertyName)
86103
Accept wildcard characters: False
87104
```
88105
89-
```yaml
90-
Type: String
91-
Parameter Sets: QueueAuthorizationRuleSet, TopicAuthorizationRuleSet
92-
Aliases: NamespaceName
93-
94-
Required: False
95-
Position: 1
96-
Default value: None
97-
Accept pipeline input: True (ByPropertyName)
98-
Accept wildcard characters: False
99-
```
100-
101106
### -Queue
102107
Queue Name.
103108
@@ -143,16 +148,17 @@ Accept pipeline input: True (ByPropertyName)
143148
Accept wildcard characters: False
144149
```
145150
151+
### CommonParameters
152+
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).
153+
146154
## INPUTS
147155
148156
### System.String
149157
150-
151158
## OUTPUTS
152159
153160
### Microsoft.Azure.Commands.ServiceBus.Models.ListKeysAttributes
154161
155-
156162
## NOTES
157163
158164
## RELATED LINKS

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

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Gets a description for the specified Service Bus namespace within the resource g
1213
## SYNTAX
1314

1415
```
15-
Get-AzureRmServiceBusNamespace [[-ResourceGroup] <String>] [[-NamespaceName] <String>] [<CommonParameters>]
16+
Get-AzureRmServiceBusNamespace [[-ResourceGroupName] <String>] [[-Name] <String>]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1618
```
1719

1820
## DESCRIPTION
@@ -29,13 +31,28 @@ Returns a description of the specified Service Bus namespace.
2931

3032
## PARAMETERS
3133

32-
### -NamespaceName
33-
The Service Bus namespace name.
34+
### -DefaultProfile
35+
The credentials, account, tenant, and subscription used for communication with azure.
36+
37+
```yaml
38+
Type: IAzureContextContainer
39+
Parameter Sets: (All)
40+
Aliases: AzureRmContext, AzureCredential
41+
42+
Required: False
43+
Position: Named
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
### -Name
50+
Namespace Name.
3451
3552
```yaml
3653
Type: String
3754
Parameter Sets: (All)
38-
Aliases:
55+
Aliases: NamespaceName
3956

4057
Required: False
4158
Position: 1
@@ -44,13 +61,13 @@ Accept pipeline input: True (ByPropertyName)
4461
Accept wildcard characters: False
4562
```
4663
47-
### -ResourceGroup
48-
The name of the resource group.
64+
### -ResourceGroupName
65+
The name of the resource group
4966
5067
```yaml
5168
Type: String
5269
Parameter Sets: (All)
53-
Aliases:
70+
Aliases: ResourceGroup
5471

5572
Required: False
5673
Position: 0
@@ -59,7 +76,6 @@ Accept pipeline input: True (ByPropertyName)
5976
Accept wildcard characters: False
6077
```
6178
62-
6379
### CommonParameters
6480
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).
6581
@@ -85,4 +101,6 @@ ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/
85101

86102
## NOTES
87103

88-
## RELATED LINKS
104+
105+
## RELATED LINKS
106+

0 commit comments

Comments
 (0)