Skip to content

Commit 2b7cd5b

Browse files
cormacpaynecormacpayne
authored
Merge pull request #3486 from sethmanheim/eh-ps
Event Hubs PowerShell: Generating Markdown files
2 parents 1740ba8 + 14cf47b commit 2b7cd5b

26 files changed

+3702
-304
lines changed

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

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

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

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
Module Name: AzureRM.EventHub
3+
Module Guid: 5728d353-7ad5-42d8-b00a-46aaecf07b91
4+
Download Help Link: None_Azure
5+
Help Version: 4.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.EventHub Module
10+
## Description
11+
This topic displays help for the Azure Event Hubs PowerShell resource manager cmdlets.
12+
13+
## AzureRM.EventHub Cmdlets
14+
### [Get-AzureRmEventHub](Get-AzureRmEventHub.md)
15+
Gets the details of a single Event Hub, or gets a list of Event Hubs.
16+
17+
### [Get-AzureRmEventHubAuthorizationRule](Get-AzureRmEventHubAuthorizationRule.md)
18+
Gets the details of an authorization rule, or gets a list of authorization rules.
19+
20+
### [Get-AzureRmEventHubConsumerGroup](Get-AzureRmEventHubConsumerGroup.md)
21+
Gets the details of a specified Event Hubs consumer group, or gets a list of consumer groups in an Event Hub.
22+
23+
### [Get-AzureRmEventHubKey](Get-AzureRmEventHubKey.md)
24+
Gets the primary key details of the specified Event Hubs authorization rule.
25+
26+
### [Get-AzureRmEventHubNamespace](Get-AzureRmEventHubNamespace.md)
27+
Gets the details of an Event Hubs namespace, or gets a list of all Event Hubs namespaces in the current Azure subscription.
28+
29+
### [Get-AzureRmEventHubNamespaceAuthorizationRule](Get-AzureRmEventHubNamespaceAuthorizationRule.md)
30+
Gets the details of an Event Hubs namespace authorization rule, or gets a list of authorization rules.
31+
32+
### [Get-AzureRmEventHubNamespaceKey](Get-AzureRmEventHubNamespaceKey.md)
33+
Gets the primary key details of the specified Event Hubs namespace authorization rule.
34+
35+
### [New-AzureRmEventHub](New-AzureRmEventHub.md)
36+
Creates a new Event Hub.
37+
38+
### [New-AzureRmEventHubAuthorizationRule](New-AzureRmEventHubAuthorizationRule.md)
39+
Creates a new Event Hubs authorization rule.
40+
41+
### [New-AzureRmEventHubConsumerGroup](New-AzureRmEventHubConsumerGroup.md)
42+
Creates a new consumer group for the specified Event Hub.
43+
44+
### [New-AzureRmEventHubKey](New-AzureRmEventHubKey.md)
45+
Creates a new primary or secondary key for the specified Event Hubs authorization rule.
46+
47+
### [New-AzureRmEventHubNamespace](New-AzureRmEventHubNamespace.md)
48+
Creates an Event Hubs namespace.
49+
50+
### [New-AzureRmEventHubNamespaceAuthorizationRule](New-AzureRmEventHubNamespaceAuthorizationRule.md)
51+
Creates a new authorization rule on the specified namespace.
52+
53+
### [New-AzureRmEventHubNamespaceKey](New-AzureRmEventHubNamespaceKey.md)
54+
Creates a new primary or secondary key for the authorization rule on the specified Event Hubs namespace.
55+
56+
### [Remove-AzureRmEventHub](Remove-AzureRmEventHub.md)
57+
Removes the specified Event Hub.
58+
59+
### [Remove-AzureRmEventHubAuthorizationRule](Remove-AzureRmEventHubAuthorizationRule.md)
60+
Removes the specified Event Hub authorization rule.
61+
62+
### [Remove-AzureRmEventHubConsumerGroup](Remove-AzureRmEventHubConsumerGroup.md)
63+
Deletes the specified Event Hubs consumer group.
64+
65+
### [Remove-AzureRmEventHubNamespace](Remove-AzureRmEventHubNamespace.md)
66+
Removes the specified Event Hubs namespace.
67+
68+
### [Remove-AzureRmEventHubNamespaceAuthorizationRule](Remove-AzureRmEventHubNamespaceAuthorizationRule.md)
69+
Deletes the specified authorization rule on the given Event Hubs namespace.
70+
71+
### [Set-AzureRmEventHub](Set-AzureRmEventHub.md)
72+
Updates the specified Event Hub.
73+
74+
### [Set-AzureRmEventHubAuthorizationRule](Set-AzureRmEventHubAuthorizationRule.md)
75+
Updates the specified authorization rule on an Event Hub.
76+
77+
### [Set-AzureRmEventHubConsumerGroup](Set-AzureRmEventHubConsumerGroup.md)
78+
Updates the specified Event Hubs consumer group.
79+
80+
### [Set-AzureRmEventHubNamespace](Set-AzureRmEventHubNamespace.md)
81+
Updates the specified Event Hubs namespace.
82+
83+
### [Set-AzureRmEventHubNamespaceAuthorizationRule](Set-AzureRmEventHubNamespaceAuthorizationRule.md)
84+
Updates the authorization rule on the specified Event Hubs namespace.
85+

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
---
6+
7+
# Get-AzureRmEventHub
8+
9+
## SYNOPSIS
10+
Gets the details of a single Event Hub, or gets a list of Event Hubs.
11+
12+
## SYNTAX
13+
14+
```
15+
Get-AzureRmEventHub [-ResourceGroupName] <String> [-NamespaceName] <String> [[-EventHubName] <String>]
16+
[<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The **Get-AzureRmEventHub** cmdlet returns either the details of an Event Hub, or a list of all Event Hubs in the current namespace. If the Event Hub name is provided, the details of a single Event Hub are returned. If an Event Hub name is not provided, a list of all Event Hubs in the specified namespace is returned.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```
26+
PS C:\> Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName
27+
```
28+
29+
Returns the details of the Event Hub `EventHubName`.
30+
31+
### Example 2
32+
```
33+
PS C:\> Get-AzureRmEventHub -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName
34+
```
35+
36+
Returns a list of Event Hubs in the namespace `MyNamespaceName`.
37+
38+
## PARAMETERS
39+
40+
### -EventHubName
41+
The Event Hub name.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: False
49+
Position: 2
50+
Default value: None
51+
Accept pipeline input: True (ByPropertyName)
52+
Accept wildcard characters: False
53+
```
54+
55+
### -NamespaceName
56+
The Event Hubs namespace name.
57+
58+
```yaml
59+
Type: String
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: 1
65+
Default value: None
66+
Accept pipeline input: True (ByPropertyName)
67+
Accept wildcard characters: False
68+
```
69+
70+
### -ResourceGroupName
71+
Resource group name.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: True
79+
Position: 0
80+
Default value: None
81+
Accept pipeline input: True (ByPropertyName)
82+
Accept wildcard characters: False
83+
```
84+
85+
### CommonParameters
86+
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).
87+
88+
## INPUTS
89+
90+
### System.String
91+
92+
## OUTPUTS
93+
94+
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventHub.Models.EventHubAttributes, Microsoft.Azure.Commands.EventHub, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
95+
96+
## NOTES
97+
98+
## RELATED LINKS
99+

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

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
---
6+
7+
# Get-AzureRmEventHubAuthorizationRule
8+
9+
## SYNOPSIS
10+
Gets the details of an authorization rule, or gets a list of authorization rules.
11+
12+
## SYNTAX
13+
14+
```
15+
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-NamespaceName] <String>
16+
[-EventHubName] <String> [-AuthorizationRuleName <String>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The **Get-AzureRmEventHubAuthorizationRule** cmdlet gets either the details of an authorization rule, or a list of all authorization rules for a specified Event Hub. If the name of an authorization rule is provided, the details of that single authorization rule are returned. If the name of an authorization rule is not provided, a list of all authorization rules for the specified Event Hub is returned.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```
26+
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRule MyAuthRuleName
27+
```
28+
29+
Gets the authorization rule `MyAuthRuleName` in the Event Hub `MyEventHubName`, which is scoped by the namespace `MyNamespaceName`.
30+
31+
### Example 2
32+
```
33+
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName
34+
```
35+
36+
Gets a list of all authorization rules in the Event Hub `MyEventHubName`, which is scoped by the namespace `MyNamespaceName`.
37+
38+
## PARAMETERS
39+
40+
### -EventHubName
41+
The Event Hub name.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: 2
50+
Default value: None
51+
Accept pipeline input: True (ByPropertyName)
52+
Accept wildcard characters: False
53+
```
54+
55+
### -NamespaceName
56+
The Event Hubs namespace name.
57+
58+
```yaml
59+
Type: String
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: 1
65+
Default value: None
66+
Accept pipeline input: True (ByPropertyName)
67+
Accept wildcard characters: False
68+
```
69+
70+
### -ResourceGroupName
71+
Resource group name.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: True
79+
Position: 0
80+
Default value: None
81+
Accept pipeline input: True (ByPropertyName)
82+
Accept wildcard characters: False
83+
```
84+
85+
### -AuthorizationRuleName
86+
Event Hub authorization rule name.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: True (ByPropertyName)
97+
Accept wildcard characters: False
98+
```
99+
100+
### CommonParameters
101+
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).
102+
103+
## INPUTS
104+
105+
### System.String
106+
107+
## OUTPUTS
108+
109+
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventHub.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.EventHub, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
110+
111+
## NOTES
112+
113+
## RELATED LINKS
114+

0 commit comments

Comments
 (0)