Skip to content

Commit 9ceb55e

Browse files
author
Maddie Clayton
committed
Regenerate MachineLearningCompute help files
1 parent 6a3fe69 commit 9ceb55e

File tree

7 files changed

+228
-83
lines changed

7 files changed

+228
-83
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
Module Name: AzureRM.MachineLearningCompute
3+
Module Guid: {{ Update Module Guid }}
4+
Download Help Link: {{ Update Download Link }}
5+
Help Version: {{ Update Help Version }}
6+
Locale: {{ Update Locale }}
7+
---
8+
9+
# AzureRM.MachineLearningCompute Module
10+
## Description
11+
{{Manually Enter Description Here}}
12+
13+
## AzureRM.MachineLearningCompute Cmdlets
14+
### [Get-AzureRmMlOpCluster](Get-AzureRmMlOpCluster.md)
15+
Gets an operationalization cluster object.
16+
17+
### [Get-AzureRmMlOpClusterKey](Get-AzureRmMlOpClusterKey.md)
18+
Gets the access keys associated with an operationalization cluster.
19+
20+
### [New-AzureRmMlOpCluster](New-AzureRmMlOpCluster.md)
21+
Creates a new operationalization cluster.
22+
23+
### [Remove-AzureRmMlOpCluster](Remove-AzureRmMlOpCluster.md)
24+
Removes an operationalization cluster.
25+
26+
### [Test-AzureRmMlOpClusterSystemServicesUpdateAvailability](Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md)
27+
Checks if there are updates available for the system services associated with an operationalization cluster.
28+
29+
### [Update-AzureRmMlOpClusterSystemService](Update-AzureRmMlOpClusterSystemService.md)
30+
Starts an update on the operationalization cluster's system services.
31+

src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpCluster.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,16 @@ Gets an operationalization cluster object.
1212

1313
## SYNTAX
1414

15+
### Get an operationalization cluster by its name.
1516
```
16-
Get-AzureRmMlOpCluster [-ResourceGroupName <String>] [-Name <String>]
17-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
17+
Get-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>]
18+
[<CommonParameters>]
19+
```
20+
21+
### Get operationalization clusters by resource group or subscription.
22+
```
23+
Get-AzureRmMlOpCluster [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>]
24+
[<CommonParameters>]
1825
```
1926

2027
## DESCRIPTION
@@ -68,7 +75,7 @@ Type: String
6875
Parameter Sets: Get an operationalization cluster by its name.
6976
Aliases:
7077

71-
Required: False
78+
Required: True
7279
Position: Named
7380
Default value: None
7481
Accept pipeline input: False
@@ -80,7 +87,19 @@ The name of the resource group for the operationalization cluster.
8087
8188
```yaml
8289
Type: String
83-
Parameter Sets: (All)
90+
Parameter Sets: Get an operationalization cluster by its name.
91+
Aliases:
92+
93+
Required: True
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
```yaml
101+
Type: String
102+
Parameter Sets: Get operationalization clusters by resource group or subscription.
84103
Aliases:
85104

86105
Required: False

src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpClusterKey.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,19 @@ Gets the access keys associated with an operationalization cluster.
1414

1515
### Get operationalization cluster's keys from cmdlet input parameters.
1616
```
17-
Get-AzureRmMlOpClusterKey -ResourceGroupName <String> -Name <String>
17+
Get-AzureRmMlOpClusterKey -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>]
18+
[<CommonParameters>]
1819
```
1920

2021
### Get operationalization cluster's keys from an OperationalizationCluster instance definition.
2122
```
22-
Get-AzureRmMlOpClusterKey -Cluster <PSOperationalizationCluster>
23+
Get-AzureRmMlOpClusterKey -InputObject <PSOperationalizationCluster> [-DefaultProfile <IAzureContextContainer>]
24+
[<CommonParameters>]
2325
```
2426

2527
### Get operationalization cluster's keys from an Azure resource id.
2628
```
27-
Get-AzureRmMlOpClusterKey -ResourceId <String>
29+
Get-AzureRmMlOpClusterKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
@@ -41,6 +43,21 @@ Returns the secret keys for the services associated with the operationalization
4143

4244
## PARAMETERS
4345

46+
### -DefaultProfile
47+
The credentials, account, tenant, and subscription used for communication with azure.
48+
49+
```yaml
50+
Type: IAzureContextContainer
51+
Parameter Sets: (All)
52+
Aliases: AzureRmContext, AzureCredential
53+
54+
Required: False
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
4461
### -InputObject
4562
The operationalization cluster object.
4663
@@ -91,7 +108,7 @@ The Azure resource id for the operationalization cluster.
91108
92109
```yaml
93110
Type: String
94-
Parameter Sets: Get operationalization cluster's keys from an Azure resouce id.
111+
Parameter Sets: Get operationalization cluster's keys from an Azure resource id.
95112
Aliases:
96113

97114
Required: True
@@ -101,17 +118,18 @@ Accept pipeline input: True (ByPropertyName)
101118
Accept wildcard characters: False
102119
```
103120
121+
### CommonParameters
122+
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).
123+
104124
## INPUTS
105125
106126
### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster
107127
System.String
108128
109-
110129
## OUTPUTS
111130
112131
### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationClusterCredentials
113132
114-
115133
## NOTES
116134
117135
## RELATED LINKS

src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/New-AzureRmMlOpCluster.md

Lines changed: 49 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,18 @@ Creates a new operationalization cluster.
1515
### Create a new operationalization cluster from an OperationalizationCluster instance definition.
1616
```
1717
New-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> -InputObject <PSOperationalizationCluster>
18-
[-WhatIf] [-Confirm]
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

2121
### Create a new operationalization cluster from cmdlet input parameters.
2222
```
2323
New-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> -Location <String> -ClusterType <String>
24-
[-OrchestratorType <String>] [-ServicePrincipalName <String>] [-ServicePrincipalSecret <String>]
25-
[-Description <String>] [-MasterCount <Int32>] [-AgentCount <Int32>] [-AgentVmSize <String>]
24+
[-OrchestratorType <String>] [-ClientId <String>] [-Secret <String>] [-Description <String>]
25+
[-MasterCount <Int32>] [-AgentCount <Int32>] [-AgentVmSize <String>]
2626
[-GlobalServiceConfigurationETag <String>] [-SslStatus <String>] [-SslCertificate <String>] [-SslKey <String>]
2727
[-SslCName <String>] [-StorageAccount <String>] [-AzureContainerRegistry <String>]
28-
[-GlobalServiceConfigurationAdditionalProperties <Hashtable>] [-WhatIf] [-Confirm]
28+
[-DefaultProfile <IAzureContextContainer>] [-GlobalServiceConfigurationAdditionalProperties <Hashtable>]
29+
[-WhatIf] [-Confirm] [<CommonParameters>]
2930
```
3031

3132
## DESCRIPTION
@@ -94,15 +95,15 @@ Accept pipeline input: False
9495
Accept wildcard characters: False
9596
```
9697
97-
### -InputObject
98-
The operationalization cluster properties.
98+
### -ClientId
99+
The ACS cluster's orchestrator service principal id.
99100
100101
```yaml
101-
Type: PSOperationalizationCluster
102-
Parameter Sets: Create a new operationalization cluster from an OperationalizationCluster instance definition.
103-
Aliases: Cluster
102+
Type: String
103+
Parameter Sets: Create a new operationalization cluster from cmdlet input parameters.
104+
Aliases:
104105

105-
Required: True
106+
Required: False
106107
Position: Named
107108
Default value: None
108109
Accept pipeline input: False
@@ -124,13 +125,13 @@ Accept pipeline input: False
124125
Accept wildcard characters: False
125126
```
126127
127-
### -Confirm
128-
Prompts you for confirmation before running the cmdlet.
128+
### -DefaultProfile
129+
The credentials, account, tenant, and subscription used for communication with azure.
129130
130131
```yaml
131-
Type: SwitchParameter
132+
Type: IAzureContextContainer
132133
Parameter Sets: (All)
133-
Aliases: cf
134+
Aliases: AzureRmContext, AzureCredential
134135

135136
Required: False
136137
Position: Named
@@ -184,6 +185,21 @@ Accept pipeline input: False
184185
Accept wildcard characters: False
185186
```
186187
188+
### -InputObject
189+
The operationalization cluster properties.
190+
191+
```yaml
192+
Type: PSOperationalizationCluster
193+
Parameter Sets: Create a new operationalization cluster from an OperationalizationCluster instance definition.
194+
Aliases: Cluster
195+
196+
Required: True
197+
Position: Named
198+
Default value: None
199+
Accept pipeline input: False
200+
Accept wildcard characters: False
201+
```
202+
187203
### -Location
188204
The operationalization cluster's location.
189205
@@ -259,8 +275,8 @@ Accept pipeline input: False
259275
Accept wildcard characters: False
260276
```
261277
262-
### -ClientId
263-
The ACS cluster's orchestrator service principal id.
278+
### -Secret
279+
The ACS cluster's orchestrator service principal secret.
264280
265281
```yaml
266282
Type: String
@@ -274,8 +290,8 @@ Accept pipeline input: False
274290
Accept wildcard characters: False
275291
```
276292
277-
### -Secret
278-
The ACS cluster's orchestrator service principal secret.
293+
### -SslCertificate
294+
The SSL certificate data in PEM format encoded as base64 string.
279295
280296
```yaml
281297
Type: String
@@ -304,8 +320,8 @@ Accept pipeline input: False
304320
Accept wildcard characters: False
305321
```
306322
307-
### -SslCertificate
308-
The SSL certificate data in PEM format encoded as base64 string.
323+
### -SslKey
324+
The SSL key data in PEM format encoded as base64 string.
309325
310326
```yaml
311327
Type: String
@@ -319,8 +335,9 @@ Accept pipeline input: False
319335
Accept wildcard characters: False
320336
```
321337
322-
### -SslKey
323-
The SSL key data in PEM format encoded as base64 string.
338+
### -SslStatus
339+
SSL status.
340+
Possible values are 'Enabled' and 'Disabled'.
324341
325342
```yaml
326343
Type: String
@@ -334,9 +351,8 @@ Accept pipeline input: False
334351
Accept wildcard characters: False
335352
```
336353
337-
### -SslStatus
338-
SSL status.
339-
Possible values are 'Enabled' and 'Disabled'.
354+
### -StorageAccount
355+
The URI to the storage account to use instead of creating one.
340356
341357
```yaml
342358
Type: String
@@ -350,13 +366,13 @@ Accept pipeline input: False
350366
Accept wildcard characters: False
351367
```
352368
353-
### -StorageAccount
354-
The URI to the storage account to use instead of creating one.
369+
### -Confirm
370+
Prompts you for confirmation before running the cmdlet.
355371
356372
```yaml
357-
Type: String
358-
Parameter Sets: Create a new operationalization cluster from cmdlet input parameters.
359-
Aliases:
373+
Type: SwitchParameter
374+
Parameter Sets: (All)
375+
Aliases: cf
360376

361377
Required: False
362378
Position: Named
@@ -381,16 +397,17 @@ Accept pipeline input: False
381397
Accept wildcard characters: False
382398
```
383399
400+
### CommonParameters
401+
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).
402+
384403
## INPUTS
385404
386405
### None
387406
388-
389407
## OUTPUTS
390408
391409
### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster
392410
393-
394411
## NOTES
395412
396413
## RELATED LINKS

0 commit comments

Comments
 (0)