Skip to content

Commit 12821d9

Browse files
author
Maddie Clayton
committed
Regenerate Eventhub help files
1 parent e5da0e5 commit 12821d9

19 files changed

+1028
-687
lines changed

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

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,55 +12,56 @@ This topic displays help for the Azure Event Hub PowerShell resource manager cmd
1212

1313
## AzureRM.EventHub Cmdlets
1414
### [Get-AzureRmEventHub](Get-AzureRmEventHub.md)
15-
Gets the details of a single Event Hub, or gets a list of Event Hub.
15+
Gets the details of a single Event Hub, or gets a list of Event Hubs.
1616

1717
### [Get-AzureRmEventHubAuthorizationRule](Get-AzureRmEventHubAuthorizationRule.md)
18-
Gets the details of an authorization rule, or gets a list of authorization rules of Namespace/Event Hub.
18+
Gets the details of an authorization rule, or gets a list of authorization rules.
1919

2020
### [Get-AzureRmEventHubConsumerGroup](Get-AzureRmEventHubConsumerGroup.md)
21-
Gets the details of a specified Event Hub consumer group, or gets a list of consumer groups in an Event Hub.
21+
Gets the details of a specified Event Hubs consumer group, or gets a list of consumer groups in an Event Hub.
2222

2323
### [Get-AzureRmEventHubKey](Get-AzureRmEventHubKey.md)
24-
Gets the primary key details of the specified Namesapce/Event Hub authorization rule.
24+
Gets the primary key details of the specified Event Hubs authorization rule.
2525

2626
### [Get-AzureRmEventHubNamespace](Get-AzureRmEventHubNamespace.md)
27-
Gets the details of an Event Hub namespace, or gets a list of all Event Hub namespaces in the current Azure subscription.
27+
Gets the details of an Event Hubs namespace, or gets a list of all Event Hubs namespaces in the current Azure subscription.
2828

2929
### [New-AzureRmEventHub](New-AzureRmEventHub.md)
3030
Creates a new Event Hub.
3131

3232
### [New-AzureRmEventHubAuthorizationRule](New-AzureRmEventHubAuthorizationRule.md)
33-
Creates a new Namespace/Event Hub authorization rule.
33+
Creates a new Event Hubs authorization rule for namespace or eventhub.
3434

3535
### [New-AzureRmEventHubConsumerGroup](New-AzureRmEventHubConsumerGroup.md)
3636
Creates a new consumer group for the specified Event Hub.
3737

3838
### [New-AzureRmEventHubKey](New-AzureRmEventHubKey.md)
39-
Creates a new primary or secondary key for the specified Namesapce/Event Hub authorization rule.
39+
Creates a new primary or secondary key for the specified Event Hubs authorization rule.
4040

4141
### [New-AzureRmEventHubNamespace](New-AzureRmEventHubNamespace.md)
42-
Creates an Event Hub namespace.
42+
Creates an Event Hubs namespace.
4343

4444
### [Remove-AzureRmEventHub](Remove-AzureRmEventHub.md)
4545
Removes the specified Event Hub.
4646

4747
### [Remove-AzureRmEventHubAuthorizationRule](Remove-AzureRmEventHubAuthorizationRule.md)
48-
Removes the specified Namespace/Event Hub authorization rule.
48+
Removes the specified Event Hub authorization rule.
4949

5050
### [Remove-AzureRmEventHubConsumerGroup](Remove-AzureRmEventHubConsumerGroup.md)
51-
Removes the specified Event Hub consumer group.
51+
Deletes the specified Event Hubs consumer group.
5252

5353
### [Remove-AzureRmEventHubNamespace](Remove-AzureRmEventHubNamespace.md)
54-
Removes the specified Event Hub namespace.
54+
Removes the specified Event Hubs namespace.
5555

5656
### [Set-AzureRmEventHub](Set-AzureRmEventHub.md)
5757
Updates the specified Event Hub.
5858

5959
### [Set-AzureRmEventHubAuthorizationRule](Set-AzureRmEventHubAuthorizationRule.md)
60-
Updates the specified authorization rule on Namespace/Event Hub.
60+
Updates the specified authorization rule on an Event Hub.
6161

6262
### [Set-AzureRmEventHubConsumerGroup](Set-AzureRmEventHubConsumerGroup.md)
63-
Updates the specified Event Hub consumer group.
63+
Updates the specified Event Hubs consumer group.
6464

6565
### [Set-AzureRmEventHubNamespace](Set-AzureRmEventHubNamespace.md)
66-
Updates the specified Event Hub namespace.
66+
Updates the specified Event Hubs namespace.
67+

src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHub.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Gets the details of a single Event Hub, or gets a list of Event Hubs.
1213
## SYNTAX
1314

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

1820
## DESCRIPTION
@@ -38,18 +40,18 @@ Returns a list of Event Hubs in the namespace \`MyNamespaceName\`.
3840

3941
## PARAMETERS
4042

41-
### -ResourceGroupName
42-
Resource group name.
43+
### -DefaultProfile
44+
The credentials, account, tenant, and subscription used for communication with azure.
4345

4446
```yaml
45-
Type: String
47+
Type: IAzureContextContainer
4648
Parameter Sets: (All)
47-
Aliases:
49+
Aliases: AzureRmContext, AzureCredential
4850

49-
Required: True
50-
Position: 0
51+
Required: False
52+
Position: Named
5153
Default value: None
52-
Accept pipeline input: True (ByPropertyName)
54+
Accept pipeline input: False
5355
Accept wildcard characters: False
5456
```
5557
@@ -62,7 +64,7 @@ Parameter Sets: (All)
6264
Aliases: EventHubName
6365

6466
Required: False
65-
Position: Named
67+
Position: 2
6668
Default value: None
6769
Accept pipeline input: True (ByPropertyName)
6870
Accept wildcard characters: False
@@ -77,12 +79,30 @@ Parameter Sets: (All)
7779
Aliases: NamespaceName
7880

7981
Required: True
80-
Position: Named
82+
Position: 1
8183
Default value: None
8284
Accept pipeline input: True (ByPropertyName)
8385
Accept wildcard characters: False
8486
```
8587
88+
### -ResourceGroupName
89+
Resource group name.
90+
91+
```yaml
92+
Type: String
93+
Parameter Sets: (All)
94+
Aliases:
95+
96+
Required: True
97+
Position: 0
98+
Default value: None
99+
Accept pipeline input: True (ByPropertyName)
100+
Accept wildcard characters: False
101+
```
102+
103+
### CommonParameters
104+
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).
105+
86106
## INPUTS
87107
88108
### System.String

src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubAuthorizationRule.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -13,13 +14,14 @@ Gets the details of an authorization rule, or gets a list of authorization rules
1314

1415
### NamespaceAuthorizationRuleSet (Default)
1516
```
16-
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> -Namespace <String> [-Name <String>]
17+
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1719
```
1820

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

2527
## DESCRIPTION
@@ -45,18 +47,18 @@ Gets a list of all authorization rules in the Event Hub \`MyEventHubName\`, whic
4547

4648
## PARAMETERS
4749

48-
### -ResourceGroupName
49-
Resource group name.
50+
### -DefaultProfile
51+
The credentials, account, tenant, and subscription used for communication with azure.
5052

5153
```yaml
52-
Type: String
54+
Type: IAzureContextContainer
5355
Parameter Sets: (All)
54-
Aliases:
56+
Aliases: AzureRmContext, AzureCredential
5557

56-
Required: True
57-
Position: 0
58+
Required: False
59+
Position: Named
5860
Default value: None
59-
Accept pipeline input: True (ByPropertyName)
61+
Accept pipeline input: False
6062
Accept wildcard characters: False
6163
```
6264
@@ -69,7 +71,7 @@ Parameter Sets: EventhubAuthorizationRuleSet
6971
Aliases: EventHubName
7072

7173
Required: True
72-
Position: Named
74+
Position: 2
7375
Default value: None
7476
Accept pipeline input: True (ByPropertyName)
7577
Accept wildcard characters: False
@@ -84,7 +86,7 @@ Parameter Sets: (All)
8486
Aliases: AuthorizationRuleName
8587

8688
Required: False
87-
Position: Named
89+
Position: 3
8890
Default value: None
8991
Accept pipeline input: True (ByPropertyName)
9092
Accept wildcard characters: False
@@ -95,28 +97,34 @@ Namespace Name.
9597
9698
```yaml
9799
Type: String
98-
Parameter Sets: NamespaceAuthorizationRuleSet
100+
Parameter Sets: (All)
99101
Aliases: NamespaceName
100102

101103
Required: True
102-
Position: Named
104+
Position: 1
103105
Default value: None
104106
Accept pipeline input: True (ByPropertyName)
105107
Accept wildcard characters: False
106108
```
107109
110+
### -ResourceGroupName
111+
Resource group name.
112+
108113
```yaml
109114
Type: String
110-
Parameter Sets: EventhubAuthorizationRuleSet
111-
Aliases: NamespaceName
115+
Parameter Sets: (All)
116+
Aliases:
112117

113-
Required: False
114-
Position: Named
118+
Required: True
119+
Position: 0
115120
Default value: None
116121
Accept pipeline input: True (ByPropertyName)
117122
Accept wildcard characters: False
118123
```
119124
125+
### CommonParameters
126+
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).
127+
120128
## INPUTS
121129
122130
### System.String

src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubConsumerGroup.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml
3+
Module Name: AzureRM
34
online version:
45
schema: 2.0.0
56
---
@@ -12,8 +13,8 @@ Gets the details of a specified Event Hubs consumer group, or gets a list of con
1213
## SYNTAX
1314

1415
```
15-
Get-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> -Namespace <String> -EventHub <String>
16-
[-Name <String>]
16+
Get-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String>
17+
[[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -39,18 +40,18 @@ Gets a list of consumer groups in the Event Hub \`MyEventHubName\`, which exists
3940

4041
## PARAMETERS
4142

42-
### -ResourceGroupName
43-
Resource group name.
43+
### -DefaultProfile
44+
The credentials, account, tenant, and subscription used for communication with azure.
4445

4546
```yaml
46-
Type: String
47+
Type: IAzureContextContainer
4748
Parameter Sets: (All)
48-
Aliases:
49+
Aliases: AzureRmContext, AzureCredential
4950

50-
Required: True
51-
Position: 0
51+
Required: False
52+
Position: Named
5253
Default value: None
53-
Accept pipeline input: True (ByPropertyName)
54+
Accept pipeline input: False
5455
Accept wildcard characters: False
5556
```
5657
@@ -63,7 +64,7 @@ Parameter Sets: (All)
6364
Aliases: EventHubName
6465

6566
Required: True
66-
Position: Named
67+
Position: 2
6768
Default value: None
6869
Accept pipeline input: True (ByPropertyName)
6970
Accept wildcard characters: False
@@ -78,7 +79,7 @@ Parameter Sets: (All)
7879
Aliases: ConsumerGroupName
7980

8081
Required: False
81-
Position: Named
82+
Position: 3
8283
Default value: None
8384
Accept pipeline input: True (ByPropertyName)
8485
Accept wildcard characters: False
@@ -93,12 +94,30 @@ Parameter Sets: (All)
9394
Aliases: NamespaceName
9495

9596
Required: True
96-
Position: Named
97+
Position: 1
98+
Default value: None
99+
Accept pipeline input: True (ByPropertyName)
100+
Accept wildcard characters: False
101+
```
102+
103+
### -ResourceGroupName
104+
Resource group name.
105+
106+
```yaml
107+
Type: String
108+
Parameter Sets: (All)
109+
Aliases:
110+
111+
Required: True
112+
Position: 0
97113
Default value: None
98114
Accept pipeline input: True (ByPropertyName)
99115
Accept wildcard characters: False
100116
```
101117
118+
### CommonParameters
119+
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).
120+
102121
## INPUTS
103122
104123
### System.String

0 commit comments

Comments
 (0)