Skip to content

Commit 4c63865

Browse files
author
maddieclayton
authored
Merge pull request Azure#4885 from maddieclayton/third
Third set of help regeneration
2 parents 080fb1d + 798f127 commit 4c63865

File tree

288 files changed

+6497
-1102
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

288 files changed

+6497
-1102
lines changed

src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,27 @@ Gets the details of an event subscription, or gets a list of all event subscript
1515
### EventSubscriptionTopicNameParameterSet (Default)
1616
```
1717
Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [[-ResourceGroupName] <String>]
18-
[[-TopicName] <String>] [-IncludeFullEndpointUrl] [<CommonParameters>]
18+
[[-TopicName] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>]
19+
[<CommonParameters>]
1920
```
2021

2122
### ResourceIdEventSubscriptionParameterSet
2223
```
2324
Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [-ResourceId] <String>
24-
[-IncludeFullEndpointUrl] [<CommonParameters>]
25+
[-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2526
```
2627

2728
### EventSubscriptionTopicTypeNameParameterSet
2829
```
2930
Get-AzureRmEventGridSubscription [[-ResourceGroupName] <String>] [[-TopicTypeName] <String>]
30-
[[-Location] <String>] [-IncludeFullEndpointUrl] [<CommonParameters>]
31+
[[-Location] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>]
32+
[<CommonParameters>]
3133
```
3234

3335
### EventSubscriptionInputObjectSet
3436
```
35-
Get-AzureRmEventGridSubscription [-InputObject] <PSTopic> [<CommonParameters>]
37+
Get-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>]
38+
[<CommonParameters>]
3639
```
3740

3841
## DESCRIPTION
@@ -121,6 +124,21 @@ Gets the list of all event subscriptions created for the specific resource group
121124

122125
## PARAMETERS
123126

127+
### -DefaultProfile
128+
The credentials, account, tenant, and subscription used for communication with azure
129+
130+
```yaml
131+
Type: IAzureContextContainer
132+
Parameter Sets: (All)
133+
Aliases: AzureRmContext, AzureCredential
134+
135+
Required: False
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
```
141+
124142
### -EventSubscriptionName
125143
The name of the event subscription
126144

src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,22 @@ Gets the details of an Event Grid topic, or gets a list of all Event Grid topics
1212

1313
## SYNTAX
1414

15-
### TopicNameParameterSet (Default)
15+
### ResourceGroupNameParameterSet (Default)
1616
```
17-
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
17+
Get-AzureRmEventGridTopic [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
18+
[<CommonParameters>]
1819
```
1920

20-
### ResourceGroupNameParameterSet
21+
### TopicNameParameterSet
2122
```
22-
Get-AzureRmEventGridTopic [[-ResourceGroupName] <String>] [<CommonParameters>]
23+
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String>
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2325
```
2426

2527
### ResourceIdEventSubscriptionParameterSet
2628
```
27-
Get-AzureRmEventGridTopic [-ResourceId] <String> [<CommonParameters>]
29+
Get-AzureRmEventGridTopic [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
30+
[<CommonParameters>]
2831
```
2932

3033
## DESCRIPTION
@@ -64,6 +67,21 @@ List all the Event Grid topics in the subscription.
6467

6568
## PARAMETERS
6669

70+
### -DefaultProfile
71+
The credentials, account, tenant, and subscription used for communication with azure
72+
73+
```yaml
74+
Type: IAzureContextContainer
75+
Parameter Sets: (All)
76+
Aliases: AzureRmContext, AzureCredential
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
6785
### -Name
6886
EventGrid Topic Name.
6987
@@ -84,10 +102,10 @@ Resource Group Name.
84102
85103
```yaml
86104
Type: String
87-
Parameter Sets: TopicNameParameterSet
105+
Parameter Sets: ResourceGroupNameParameterSet
88106
Aliases: ResourceGroup
89107

90-
Required: True
108+
Required: False
91109
Position: 0
92110
Default value: None
93111
Accept pipeline input: True (ByPropertyName)
@@ -96,10 +114,10 @@ Accept wildcard characters: False
96114
97115
```yaml
98116
Type: String
99-
Parameter Sets: ResourceGroupNameParameterSet
117+
Parameter Sets: TopicNameParameterSet
100118
Aliases: ResourceGroup
101119

102-
Required: False
120+
Required: True
103121
Position: 0
104122
Default value: None
105123
Accept pipeline input: True (ByPropertyName)

src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,20 @@ Gets the shared access keys used to publish events to an Event Grid topic.
1414

1515
### TopicNameParameterSet (Default)
1616
```
17-
Get-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
17+
Get-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
### TopicInputObjectParameterSet
2122
```
22-
Get-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [<CommonParameters>]
23+
Get-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>]
24+
[<CommonParameters>]
2325
```
2426

2527
### ResourceIdEventSubscriptionParameterSet
2628
```
27-
Get-AzureRmEventGridTopicKey [-ResourceId] <String> [<CommonParameters>]
29+
Get-AzureRmEventGridTopicKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
30+
[<CommonParameters>]
2831
```
2932

3033
## DESCRIPTION
@@ -48,6 +51,21 @@ Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`M
4851

4952
## PARAMETERS
5053

54+
### -DefaultProfile
55+
The credentials, account, tenant, and subscription used for communication with azure
56+
57+
```yaml
58+
Type: IAzureContextContainer
59+
Parameter Sets: (All)
60+
Aliases: AzureRmContext, AzureCredential
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
5169
### -InputObject
5270
EventGrid Topic object.
5371

src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Gets the details about the topic types supported by Azure Event Grid.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureRmEventGridTopicType [[-Name] <String>] [-IncludeEventTypeData] [<CommonParameters>]
16+
Get-AzureRmEventGridTopicType [[-Name] <String>] [-IncludeEventTypeData]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -47,6 +48,21 @@ Gets information about the StorageAccounts topic type, including the event types
4748

4849
## PARAMETERS
4950

51+
### -DefaultProfile
52+
The credentials, account, tenant, and subscription used for communication with azure
53+
54+
```yaml
55+
Type: IAzureContextContainer
56+
Parameter Sets: (All)
57+
Aliases: AzureRmContext, AzureCredential
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
5066
### -IncludeEventTypeData
5167
If specified, the response will include the event types supported by a topic type.
5268

src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,36 @@ Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Az
1212

1313
## SYNTAX
1414

15-
### CustomTopicEventSubscriptionParameterSet (Default)
15+
### ResourceGroupNameParameterSet (Default)
1616
```
1717
New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String>
18-
[-ResourceGroupName] <String> [-TopicName] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
18+
[[-ResourceGroupName] <String>] [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
1919
[[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
20-
[-WhatIf] [-Confirm] [<CommonParameters>]
20+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

2323
### ResourceIdEventSubscriptionParameterSet
2424
```
2525
New-AzureRmEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-Endpoint] <String>
2626
[[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>]
27-
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] [-WhatIf] [-Confirm]
28-
[<CommonParameters>]
27+
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
28+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2929
```
3030

3131
### EventSubscriptionInputObjectSet
3232
```
3333
New-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String>
3434
[-Endpoint] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>]
35-
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] [-WhatIf] [-Confirm]
36-
[<CommonParameters>]
35+
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
36+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3737
```
3838

39-
### ResourceGroupNameParameterSet
39+
### CustomTopicEventSubscriptionParameterSet
4040
```
4141
New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String>
42-
[[-ResourceGroupName] <String>] [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
42+
[-ResourceGroupName] <String> [-TopicName] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
4343
[[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
44-
[-WhatIf] [-Confirm] [<CommonParameters>]
44+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
4545
```
4646

4747
## DESCRIPTION
@@ -99,13 +99,28 @@ Creates a new event subscription \`EventSubscription1\` to an EventHub namespace
9999

100100
## PARAMETERS
101101

102+
### -DefaultProfile
103+
The credentials, account, tenant, and subscription used for communication with azure
104+
105+
```yaml
106+
Type: IAzureContextContainer
107+
Parameter Sets: (All)
108+
Aliases: AzureRmContext, AzureCredential
109+
110+
Required: False
111+
Position: Named
112+
Default value: None
113+
Accept pipeline input: False
114+
Accept wildcard characters: False
115+
```
116+
102117
### -Endpoint
103118
Event subscription destination endpoint.
104119
This can be a webhook URL or the Azure resource ID of an EventHub.
105120
106121
```yaml
107122
Type: String
108-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
123+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
109124
Aliases:
110125

111126
Required: True
@@ -133,7 +148,7 @@ This can be webhook or eventhub
133148
134149
```yaml
135150
Type: String
136-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
151+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
137152
Aliases:
138153
Accepted values: webhook, eventhub
139154

@@ -162,7 +177,7 @@ The name of the event subscription
162177
163178
```yaml
164179
Type: String
165-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
180+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
166181
Aliases:
167182

168183
Required: True
@@ -189,7 +204,7 @@ Filter that specifies a list of event types to include.If not specified, all eve
189204
190205
```yaml
191206
Type: String[]
192-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
207+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
193208
Aliases:
194209

195210
Required: False
@@ -231,7 +246,7 @@ Labels for the event subscription
231246
232247
```yaml
233248
Type: String[]
234-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
249+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
235250
Aliases:
236251

237252
Required: False
@@ -258,10 +273,10 @@ The resource group of the topic.
258273
259274
```yaml
260275
Type: String
261-
Parameter Sets: CustomTopicEventSubscriptionParameterSet
276+
Parameter Sets: ResourceGroupNameParameterSet
262277
Aliases: ResourceGroup
263278

264-
Required: True
279+
Required: False
265280
Position: 2
266281
Default value: None
267282
Accept pipeline input: True (ByPropertyName)
@@ -270,10 +285,10 @@ Accept wildcard characters: False
270285
271286
```yaml
272287
Type: String
273-
Parameter Sets: ResourceGroupNameParameterSet
288+
Parameter Sets: CustomTopicEventSubscriptionParameterSet
274289
Aliases: ResourceGroup
275290

276-
Required: False
291+
Required: True
277292
Position: 2
278293
Default value: None
279294
Accept pipeline input: True (ByPropertyName)
@@ -301,7 +316,7 @@ If not specified, events with all subject prefixes will be included.
301316
302317
```yaml
303318
Type: String
304-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
319+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
305320
Aliases:
306321

307322
Required: False
@@ -345,7 +360,7 @@ If not specified, events with all subject suffixes will be included.
345360
346361
```yaml
347362
Type: String
348-
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
363+
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
349364
Aliases:
350365

351366
Required: False

src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a new Azure Event Grid Topic.
1414

1515
```
1616
New-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Location] <String>
17-
[[-Tag] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
17+
[[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -38,6 +38,21 @@ Creates an Event Grid topic \`Topic1\` in the specified geographic location \`we
3838

3939
## PARAMETERS
4040

41+
### -DefaultProfile
42+
The credentials, account, tenant, and subscription used for communication with azure
43+
44+
```yaml
45+
Type: IAzureContextContainer
46+
Parameter Sets: (All)
47+
Aliases: AzureRmContext, AzureCredential
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
4156
### -Location
4257
The location of the topic
4358

0 commit comments

Comments
 (0)