Skip to content

Commit 486f275

Browse files
committed
initial generated docs part 2
1 parent 6e7578d commit 486f275

12 files changed

+406
-84
lines changed

src/DeviceRegistry/DeviceRegistry.Autorest/docs/New-AzDeviceRegistryNamespaceAsset.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ New-AzDeviceRegistryNamespaceAsset -AssetName <String> -NamespaceName <String> -
2222
[-DefaultManagementGroupsConfiguration <String>] [-DefaultStreamsConfiguration <String>]
2323
[-DefaultStreamsDestination <IStreamDestination[]>] [-Description <String>] [-DeviceRefDeviceName <String>]
2424
[-DeviceRefEndpointName <String>] [-DiscoveredAssetRef <String[]>] [-DisplayName <String>]
25-
[-DocumentationUri <String>] [-Enabled] [-Event <INamespaceEvent[]>] [-ExternalAssetId <String>]
25+
[-DocumentationUri <String>] [-Enabled] [-EventGroup <INamespaceEventGroup[]>] [-ExternalAssetId <String>]
2626
[-HardwareRevision <String>] [-ManagementGroup <IManagementGroup[]>] [-Manufacturer <String>]
2727
[-ManufacturerUri <String>] [-Model <String>] [-ProductCode <String>] [-SerialNumber <String>]
2828
[-SoftwareRevision <String>] [-Stream <INamespaceStream[]>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>]
@@ -566,12 +566,12 @@ Accept pipeline input: False
566566
Accept wildcard characters: False
567567
```
568568
569-
### -Event
570-
Array of events that are part of the asset.
571-
Each event can have per-event configuration.
569+
### -EventGroup
570+
Array of event groups that are part of the asset.
571+
Each event group can have per-event group configuration.
572572
573573
```yaml
574-
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceEvent[]
574+
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceEventGroup[]
575575
Parameter Sets: CreateExpanded
576576
Aliases:
577577

src/DeviceRegistry/DeviceRegistry.Autorest/docs/New-AzDeviceRegistryNamespaceDiscoveredAsset.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ New-AzDeviceRegistryNamespaceDiscoveredAsset -DiscoveredAssetName <String> -Name
2121
[-DefaultDatasetsDestination <IDatasetDestination[]>] [-DefaultEventsConfiguration <String>]
2222
[-DefaultEventsDestination <IEventDestination[]>] [-DefaultManagementGroupsConfiguration <String>]
2323
[-DefaultStreamsConfiguration <String>] [-DefaultStreamsDestination <IStreamDestination[]>]
24-
[-DeviceRefDeviceName <String>] [-DeviceRefEndpointName <String>] [-DiscoveryId <String>]
25-
[-DocumentationUri <String>] [-Event <INamespaceDiscoveredEvent[]>] [-HardwareRevision <String>]
24+
[-Description <String>] [-DeviceRefDeviceName <String>] [-DeviceRefEndpointName <String>]
25+
[-DiscoveryId <String>] [-DisplayName <String>] [-DocumentationUri <String>]
26+
[-EventGroup <INamespaceDiscoveredEventGroup[]>] [-ExternalAssetId <String>] [-HardwareRevision <String>]
2627
[-ManagementGroup <INamespaceDiscoveredManagementGroup[]>] [-Manufacturer <String>]
2728
[-ManufacturerUri <String>] [-Model <String>] [-ProductCode <String>] [-SerialNumber <String>]
2829
[-SoftwareRevision <String>] [-Stream <INamespaceDiscoveredStream[]>] [-Tag <Hashtable>] [-Version <Int64>]
@@ -888,6 +889,21 @@ Accept pipeline input: False
888889
Accept wildcard characters: False
889890
```
890891
892+
### -Description
893+
Human-readable description of the asset.
894+
895+
```yaml
896+
Type: System.String
897+
Parameter Sets: CreateExpanded
898+
Aliases:
899+
900+
Required: False
901+
Position: Named
902+
Default value: None
903+
Accept pipeline input: False
904+
Accept wildcard characters: False
905+
```
906+
891907
### -DeviceRefDeviceName
892908
Name of the device resource
893909
@@ -948,6 +964,21 @@ Accept pipeline input: False
948964
Accept wildcard characters: False
949965
```
950966
967+
### -DisplayName
968+
Human-readable display name.
969+
970+
```yaml
971+
Type: System.String
972+
Parameter Sets: CreateExpanded
973+
Aliases:
974+
975+
Required: False
976+
Position: Named
977+
Default value: None
978+
Accept pipeline input: False
979+
Accept wildcard characters: False
980+
```
981+
951982
### -DocumentationUri
952983
Asset documentation reference.
953984
@@ -963,12 +994,12 @@ Accept pipeline input: False
963994
Accept wildcard characters: False
964995
```
965996
966-
### -Event
967-
Array of events that are part of the asset.
968-
Each event can have per-event configuration.
997+
### -EventGroup
998+
Array of event groups that are part of the asset.
999+
Each event group can have per-event group configuration.
9691000
9701001
```yaml
971-
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceDiscoveredEvent[]
1002+
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceDiscoveredEventGroup[]
9721003
Parameter Sets: CreateExpanded
9731004
Aliases:
9741005

@@ -1009,6 +1040,21 @@ Accept pipeline input: False
10091040
Accept wildcard characters: False
10101041
```
10111042
1043+
### -ExternalAssetId
1044+
Asset ID provided by the customer.
1045+
1046+
```yaml
1047+
Type: System.String
1048+
Parameter Sets: CreateExpanded
1049+
Aliases:
1050+
1051+
Required: False
1052+
Position: Named
1053+
Default value: None
1054+
Accept pipeline input: False
1055+
Accept wildcard characters: False
1056+
```
1057+
10121058
### -HardwareRevision
10131059
Asset hardware revision number.
10141060

src/DeviceRegistry/DeviceRegistry.Autorest/docs/Remove-AzDeviceRegistrySchema.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,20 @@ Delete a Schema
1515
### Delete (Default)
1616
```
1717
Remove-AzDeviceRegistrySchema -Name <String> -RegistryName <String> -ResourceGroupName <String>
18-
[-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
18+
[-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf]
19+
[<CommonParameters>]
1920
```
2021

2122
### DeleteViaIdentity
2223
```
23-
Remove-AzDeviceRegistrySchema -InputObject <IDeviceRegistryIdentity> [-DefaultProfile <PSObject>] [-PassThru]
24-
[-Confirm] [-WhatIf] [<CommonParameters>]
24+
Remove-AzDeviceRegistrySchema -InputObject <IDeviceRegistryIdentity> [-DefaultProfile <PSObject>] [-AsJob]
25+
[-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
2526
```
2627

2728
### DeleteViaIdentitySchemaRegistry
2829
```
2930
Remove-AzDeviceRegistrySchema -Name <String> -SchemaRegistryInputObject <IDeviceRegistryIdentity>
30-
[-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
31+
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
3132
```
3233

3334
## DESCRIPTION
@@ -67,6 +68,21 @@ Removing a schema also removes all nested schema version resources.
6768

6869
## PARAMETERS
6970

71+
### -AsJob
72+
Run the command as a job
73+
74+
```yaml
75+
Type: System.Management.Automation.SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
7086
### -DefaultProfile
7187
The DefaultProfile parameter is not functional.
7288
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
@@ -113,6 +129,21 @@ Accept pipeline input: False
113129
Accept wildcard characters: False
114130
```
115131
132+
### -NoWait
133+
Run the command asynchronously
134+
135+
```yaml
136+
Type: System.Management.Automation.SwitchParameter
137+
Parameter Sets: (All)
138+
Aliases:
139+
140+
Required: False
141+
Position: Named
142+
Default value: None
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
116147
### -PassThru
117148
Returns true when the command succeeds
118149

src/DeviceRegistry/DeviceRegistry.Autorest/docs/Remove-AzDeviceRegistrySchemaVersion.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,27 @@ Delete a SchemaVersion
1515
### Delete (Default)
1616
```
1717
Remove-AzDeviceRegistrySchemaVersion -Name <String> -ResourceGroupName <String> -SchemaName <String>
18-
-SchemaRegistryName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm]
19-
[-WhatIf] [<CommonParameters>]
18+
-SchemaRegistryName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait]
19+
[-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
2020
```
2121

2222
### DeleteViaIdentity
2323
```
2424
Remove-AzDeviceRegistrySchemaVersion -InputObject <IDeviceRegistryIdentity> [-DefaultProfile <PSObject>]
25-
[-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
25+
[-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
2626
```
2727

2828
### DeleteViaIdentitySchema
2929
```
3030
Remove-AzDeviceRegistrySchemaVersion -Name <String> -SchemaInputObject <IDeviceRegistryIdentity>
31-
[-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
31+
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
3232
```
3333

3434
### DeleteViaIdentitySchemaRegistry
3535
```
3636
Remove-AzDeviceRegistrySchemaVersion -Name <String> -SchemaName <String>
37-
-SchemaRegistryInputObject <IDeviceRegistryIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm]
38-
[-WhatIf] [<CommonParameters>]
37+
-SchemaRegistryInputObject <IDeviceRegistryIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait]
38+
[-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
3939
```
4040

4141
## DESCRIPTION
@@ -76,6 +76,21 @@ Removes a schema version by using the schema version's InputObject parameter.
7676

7777
## PARAMETERS
7878

79+
### -AsJob
80+
Run the command as a job
81+
82+
```yaml
83+
Type: System.Management.Automation.SwitchParameter
84+
Parameter Sets: (All)
85+
Aliases:
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
7994
### -DefaultProfile
8095
The DefaultProfile parameter is not functional.
8196
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
@@ -122,6 +137,21 @@ Accept pipeline input: False
122137
Accept wildcard characters: False
123138
```
124139
140+
### -NoWait
141+
Run the command asynchronously
142+
143+
```yaml
144+
Type: System.Management.Automation.SwitchParameter
145+
Parameter Sets: (All)
146+
Aliases:
147+
148+
Required: False
149+
Position: Named
150+
Default value: None
151+
Accept pipeline input: False
152+
Accept wildcard characters: False
153+
```
154+
125155
### -PassThru
126156
Returns true when the command succeeds
127157

src/DeviceRegistry/DeviceRegistry.Autorest/docs/Update-AzDeviceRegistryNamespaceAsset.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Update-AzDeviceRegistryNamespaceAsset -AssetName <String> -NamespaceName <String
2121
[-DefaultEventsDestination <IEventDestination[]>] [-DefaultManagementGroupsConfiguration <String>]
2222
[-DefaultStreamsConfiguration <String>] [-DefaultStreamsDestination <IStreamDestination[]>]
2323
[-Description <String>] [-DisplayName <String>] [-DocumentationUri <String>] [-Enabled]
24-
[-Event <INamespaceEvent[]>] [-HardwareRevision <String>] [-ManagementGroup <IManagementGroup[]>]
24+
[-EventGroup <INamespaceEventGroup[]>] [-HardwareRevision <String>] [-ManagementGroup <IManagementGroup[]>]
2525
[-Manufacturer <String>] [-ManufacturerUri <String>] [-Model <String>] [-ProductCode <String>]
2626
[-SerialNumber <String>] [-SoftwareRevision <String>] [-Stream <INamespaceStream[]>] [-Tag <Hashtable>]
2727
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
@@ -35,7 +35,7 @@ Update-AzDeviceRegistryNamespaceAsset -InputObject <IDeviceRegistryIdentity> [-A
3535
[-DefaultEventsDestination <IEventDestination[]>] [-DefaultManagementGroupsConfiguration <String>]
3636
[-DefaultStreamsConfiguration <String>] [-DefaultStreamsDestination <IStreamDestination[]>]
3737
[-Description <String>] [-DisplayName <String>] [-DocumentationUri <String>] [-Enabled]
38-
[-Event <INamespaceEvent[]>] [-HardwareRevision <String>] [-ManagementGroup <IManagementGroup[]>]
38+
[-EventGroup <INamespaceEventGroup[]>] [-HardwareRevision <String>] [-ManagementGroup <IManagementGroup[]>]
3939
[-Manufacturer <String>] [-ManufacturerUri <String>] [-Model <String>] [-ProductCode <String>]
4040
[-SerialNumber <String>] [-SoftwareRevision <String>] [-Stream <INamespaceStream[]>] [-Tag <Hashtable>]
4141
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
@@ -49,7 +49,7 @@ Update-AzDeviceRegistryNamespaceAsset -AssetName <String> -NamespaceInputObject
4949
[-DefaultEventsConfiguration <String>] [-DefaultEventsDestination <IEventDestination[]>]
5050
[-DefaultManagementGroupsConfiguration <String>] [-DefaultStreamsConfiguration <String>]
5151
[-DefaultStreamsDestination <IStreamDestination[]>] [-Description <String>] [-DisplayName <String>]
52-
[-DocumentationUri <String>] [-Enabled] [-Event <INamespaceEvent[]>] [-HardwareRevision <String>]
52+
[-DocumentationUri <String>] [-Enabled] [-EventGroup <INamespaceEventGroup[]>] [-HardwareRevision <String>]
5353
[-ManagementGroup <IManagementGroup[]>] [-Manufacturer <String>] [-ManufacturerUri <String>]
5454
[-Model <String>] [-ProductCode <String>] [-SerialNumber <String>] [-SoftwareRevision <String>]
5555
[-Stream <INamespaceStream[]>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm]
@@ -404,12 +404,12 @@ Accept pipeline input: False
404404
Accept wildcard characters: False
405405
```
406406
407-
### -Event
408-
Array of events that are part of the asset.
409-
Each event can have per-event configuration.
407+
### -EventGroup
408+
Array of event groups that are part of the asset.
409+
Each event group can have per-event group configuration.
410410
411411
```yaml
412-
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceEvent[]
412+
Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.INamespaceEventGroup[]
413413
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityNamespaceExpanded
414414
Aliases:
415415

0 commit comments

Comments
 (0)