Skip to content

Commit 29594b4

Browse files
committed
Regenerate documentation
1 parent 8a2cc34 commit 29594b4

19 files changed

+194
-228
lines changed

src/ResourceManager/IotHub/Commands.IotHub/Microsoft.Azure.Commands.IotHub.dll-help.xml

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

src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,24 @@ Creates a consumer group in the Eventhub associated with the specified IotHub.
2222

2323
## EXAMPLES
2424

25-
### Example 1: Add a consumer group to the telemetry eventhub
26-
25+
### Example 1: Add a consumer group to the telemetry eventhub
2726
```
2827
PS C:\> Add-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "events" -EventHubConsumerGroupName "myconsumergroup"
2928
```
30-
Adds a new consumergroup named "myconsumergroup" to the eventhub for telemetry events in the iothub named "myiothub"
3129

32-
### Example 2: Add a consumer group to the operations monitoring eventhub
30+
Adds a new consumergroup named "myconsumergroup" to the eventhub for telemetry events in the iothub named "myiothub"
3331

32+
### Example 2: Add a consumer group to the operations monitoring eventhub
3433
```
3534
PS C:\> Add-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents" -EventHubConsumerGroupName "myconsumergroup"
3635
```
36+
3737
Adds a new consumergroup named "myconsumergroup" to the eventhub for operations monitoring events in the iothub named "myiothub"
3838

3939
## PARAMETERS
4040

4141
### -EventHubConsumerGroupName
42-
EventHubConsumerGroupName.
42+
Name of the EventHub ConsumerGroup that you want to add.
4343

4444
```yaml
4545
Type: String
@@ -54,8 +54,7 @@ Accept wildcard characters: False
5454
```
5555
5656
### -EventHubEndpointName
57-
EventHubEndpointName.
58-
Possible values events, operationsMonitoringEvents
57+
Name of the EventHub endpoint. The possible values for this are events, operationsMonitoringEvents
5958
6059
```yaml
6160
Type: String
@@ -70,7 +69,7 @@ Accept wildcard characters: False
7069
```
7170
7271
### -Name
73-
Name
72+
Name of the Iot Hub.
7473
7574
```yaml
7675
Type: String
@@ -85,7 +84,7 @@ Accept wildcard characters: False
8584
```
8685
8786
### -ResourceGroupName
88-
Resource Group Name
87+
Name of the Resource Group.
8988
9089
```yaml
9190
Type: String

src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ Creates a Key for the provided IotHub. KeyNames are not unique and need to be ma
2525
```
2626
PS C:\> Add-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "newkey" -PrimaryKey "4GT/3sQXHYLDVOG5c8GQCpxIAw+OQtE5RxpdFC6O5Jk=" -SecondaryKey "4GT/3sQXHYLDVOG5c8GQCpxIAw+OQtE5RxpdFC6O5Jk=" -Rights RegistryRead
2727
```
28+
2829
Creates a key named "mykey" for the iothub "myiothub" with RegistryRead permissions.
2930

3031
## PARAMETERS
3132

3233
### -KeyName
33-
Name
34+
Name of the key.
3435

3536
```yaml
3637
Type: String
@@ -45,7 +46,7 @@ Accept wildcard characters: False
4546
```
4647
4748
### -Name
48-
Name
49+
Name of the Iot Hub.
4950
5051
```yaml
5152
Type: String
@@ -60,7 +61,7 @@ Accept wildcard characters: False
6061
```
6162
6263
### -PrimaryKey
63-
PrimaryKey
64+
The Primary Key.
6465
6566
```yaml
6667
Type: String
@@ -75,7 +76,7 @@ Accept wildcard characters: False
7576
```
7677
7778
### -ResourceGroupName
78-
Resource Group Name
79+
Name of the resource group.
7980
8081
```yaml
8182
Type: String
@@ -90,7 +91,7 @@ Accept wildcard characters: False
9091
```
9192
9293
### -Rights
93-
Rights
94+
Access Rights that determine what kind of access the key will provide to the user of the key.
9495
9596
```yaml
9697
Type: PSAccessRights
@@ -106,7 +107,7 @@ Accept wildcard characters: False
106107
```
107108
108109
### -SecondaryKey
109-
SecondaryKey
110+
The Secondary Key.
110111
111112
```yaml
112113
Type: String

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Creates an eventhub consumer group.
1818
Creates an IotHub Key.
1919

2020
### [Get-AzureRmIotHub](Get-AzureRmIotHub.md)
21-
Gets information about the IotHubs in a subscription.
21+
Gets information about the IotHubs in a subscription.
2222

2323
### [Get-AzureRmIotHubConnectionString](Get-AzureRmIotHubConnectionString.md)
2424
Gets the IotHub connectionstrings.

src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,16 @@ Gets information about the IotHubs in a subscription.
1111

1212
## SYNTAX
1313

14-
### ListIotHubsBySubscription (Default)
14+
### ListIotHubsByResourceGroup (Default)
1515
```
16-
Get-AzureRmIotHub [<CommonParameters>]
16+
Get-AzureRmIotHub [[-ResourceGroupName] <String>] [<CommonParameters>]
1717
```
1818

1919
### GetIotHubByName
2020
```
2121
Get-AzureRmIotHub [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
2222
```
2323

24-
### ListIotHubsByResourceGroup
25-
```
26-
Get-AzureRmIotHub [-ResourceGroupName] <String> [<CommonParameters>]
27-
```
28-
2924
## DESCRIPTION
3025
Gets information about the IotHubs in a subscription. You can view all IotHub instances in a subscription, or filter your results by a resource group or a particular IotHub Name.
3126

@@ -35,24 +30,27 @@ Gets information about the IotHubs in a subscription. You can view all IotHub in
3530
```
3631
PS C:\> Get-AzureRmIotHub
3732
```
33+
3834
Gets all the IotHubs in the subscription.
3935

4036
### Example 2
4137
```
4238
PS C:\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup"
4339
```
40+
4441
Gets all the IotHubs in the subscription belonging to the resourcegroup named "myresourcegroup".
4542

4643
### Example 3
4744
```
4845
PS C:\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub"
4946
```
47+
5048
Gets information about the IotHub named "myiothub".
5149

5250
## PARAMETERS
5351

5452
### -Name
55-
Name
53+
Name of the IoT hub.
5654

5755
```yaml
5856
Type: String
@@ -67,11 +65,23 @@ Accept wildcard characters: False
6765
```
6866
6967
### -ResourceGroupName
70-
Resource Group Name
68+
Name of the resource group.
7169
7270
```yaml
7371
Type: String
74-
Parameter Sets: GetIotHubByName, ListIotHubsByResourceGroup
72+
Parameter Sets: ListIotHubsByResourceGroup
73+
Aliases:
74+
75+
Required: False
76+
Position: 0
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
82+
```yaml
83+
Type: String
84+
Parameter Sets: GetIotHubByName
7585
Aliases:
7686

7787
Required: True

src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,53 +11,49 @@ Gets the IotHub connectionstrings.
1111

1212
## SYNTAX
1313

14-
### GetIotHubConnectionString
1514
```
16-
Get-AzureRmIotHubConnectionString [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String>
15+
Get-AzureRmIotHubConnectionString [-ResourceGroupName] <String> [-Name] <String> [[-KeyName] <String>]
1716
[<CommonParameters>]
1817
```
1918

20-
### ListIotHubConnectionStrings
21-
```
22-
Get-AzureRmIotHubConnectionString [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
23-
```
24-
2519
## DESCRIPTION
2620
Gets the IotHub connectionstrings. You can either get connectionstrings for all the keys or filter them by a specific key name.
2721

2822
## EXAMPLES
2923

3024
### Example 1 Get All IotHub connectionstrings
3125
```
32-
PS C:\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub"
26+
PS C:\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub"
3327
```
28+
3429
Gets the connectionstrings for all keys for the iothub named "myiothub"
3530

3631
### Example 2 Get the IotHub connectionstrings for a specific key
3732
```
3833
PS C:\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "mykey"
3934
```
35+
4036
Gets the connectionstrings for the key named "mykey" for the iothub named "myiothub"
4137

4238
## PARAMETERS
4339

4440
### -KeyName
45-
KeyName
41+
Name of the key.
4642

4743
```yaml
4844
Type: String
49-
Parameter Sets: GetIotHubConnectionString
45+
Parameter Sets: (All)
5046
Aliases:
5147

52-
Required: True
48+
Required: False
5349
Position: 2
5450
Default value: None
5551
Accept pipeline input: False
5652
Accept wildcard characters: False
5753
```
5854
5955
### -Name
60-
Name
56+
Name of the IoT hub.
6157
6258
```yaml
6359
Type: String
@@ -72,7 +68,7 @@ Accept wildcard characters: False
7268
```
7369
7470
### -ResourceGroupName
75-
Resource Group Name
71+
Name of the resource group.
7672
7773
```yaml
7874
Type: String

src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ Gets all the eventhub consumergroups for the different EventHubs used by IotHub.
2525
```
2626
PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "events"
2727
```
28+
2829
Gets all the eventhub consumergroups for the telemetry eventhub for the iothub named myiothub
2930

3031
### Example 2 Gets all the eventhub consumergroups for the operationsmonitoring eventhub
3132
```
3233
PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents"
3334
```
34-
Gets all the eventhub consumergroups for the operationsMonitoringEvents eventhub for the iothub named myiothub
3535

36+
Gets all the eventhub consumergroups for the operationsMonitoringEvents eventhub for the iothub named myiothub
3637

3738
## PARAMETERS
3839

3940
### -EventHubEndpointName
40-
EventHubEndpointName.
41-
Possible values events, operationsMonitoringEvents
41+
Name of the Event Hub endpoint. The possible values are events, operationsMonitoringEvents.
4242

4343
```yaml
4444
Type: String
@@ -53,7 +53,7 @@ Accept wildcard characters: False
5353
```
5454
5555
### -Name
56-
Name
56+
Name of hte IoT hub.
5757
5858
```yaml
5959
Type: String
@@ -68,7 +68,7 @@ Accept wildcard characters: False
6868
```
6969
7070
### -ResourceGroupName
71-
Resource Group Name
71+
Name of the resource group.
7272
7373
```yaml
7474
Type: String

src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,10 @@ Gets the information about an IotHub job.
1111

1212
## SYNTAX
1313

14-
### GetIotHubJob
1514
```
1615
Get-AzureRmIotHubJob [-ResourceGroupName] <String> [-Name] <String> [[-JobId] <String>] [<CommonParameters>]
1716
```
1817

19-
### ListIotHubJob
20-
```
21-
Get-AzureRmIotHubJob [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
22-
```
23-
2418
## DESCRIPTION
2519
Gets the information about an IotHub Job. An IotHub Job gets created when an import or export operation is initialted using the New-AzureRmIotHubExportDevices or New-AzureRmIotHubImportDevices commands.
2620
You can either list all the jobs or filter the jobs by the Job Identifier.
@@ -31,22 +25,24 @@ You can either list all the jobs or filter the jobs by the Job Identifier.
3125
```
3226
PS C:\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub"
3327
```
28+
3429
Gets all the jobs for the IotHub named "myiothub"
3530

3631
### Example 2 Get a specific Job
3732
```
3833
PS C:\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -JobId 3630fc31-4caa-43e8-a232-ea0577221cb2
3934
```
35+
4036
Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea0577221cb2" for the IotHub named "myiothub"
4137

4238
## PARAMETERS
4339

4440
### -JobId
45-
JobId
41+
The Job Identifier.
4642

4743
```yaml
4844
Type: String
49-
Parameter Sets: GetIotHubJob
45+
Parameter Sets: (All)
5046
Aliases:
5147

5248
Required: False
@@ -57,7 +53,7 @@ Accept wildcard characters: False
5753
```
5854
5955
### -Name
60-
Name
56+
Name of the IoT hub.
6157
6258
```yaml
6359
Type: String
@@ -72,7 +68,7 @@ Accept wildcard characters: False
7268
```
7369
7470
### -ResourceGroupName
75-
Resource Group Name
71+
Name of the resource group.
7672
7773
```yaml
7874
Type: String

0 commit comments

Comments
 (0)