Skip to content

Commit d1bcdf8

Browse files
committed
Regenerate MachineLearning help files
1 parent 43e512c commit d1bcdf8

16 files changed

+303
-41
lines changed

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Creates regional web service properties.
1213
## SYNTAX
1314

1415
```
15-
Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName <String> -Name <String> -Region <String> [-Force] [-WhatIf] [-Confirm]
16+
Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName <String> -Name <String> -Region <String> [-Force]
17+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1618
```
1719

1820
## DESCRIPTION
@@ -21,7 +23,6 @@ Creates Azure Machine Learning regional properties for an existing web service.
2123
## EXAMPLES
2224

2325
### -------------------------- Example 1: Add new regional properties for West Central US --------------------------
24-
2526
@{paragraph=PS C:\\\>}
2627

2728
```
@@ -32,6 +33,21 @@ This example command creates regional property for a web service in the "West C
3233

3334
## PARAMETERS
3435

36+
### -DefaultProfile
37+
The credentials, account, tenant, and subscription used for communication with azure
38+
39+
```yaml
40+
Type: IAzureContextContainer
41+
Parameter Sets: (All)
42+
Aliases: AzureRmContext, AzureCredential
43+
44+
Required: False
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
3551
### -Force
3652
Do not ask for confirmation.
3753
@@ -58,7 +74,7 @@ Aliases:
5874
Required: True
5975
Position: Named
6076
Default value: None
61-
Accept pipeline input: False
77+
Accept pipeline input: True (ByPropertyName)
6278
Accept wildcard characters: False
6379
```
6480
@@ -88,7 +104,7 @@ Aliases:
88104
Required: True
89105
Position: Named
90106
Default value: None
91-
Accept pipeline input: False
107+
Accept pipeline input: True (ByPropertyName)
92108
Accept wildcard characters: False
93109
```
94110
@@ -123,6 +139,9 @@ Accept pipeline input: False
123139
Accept wildcard characters: False
124140
```
125141
142+
### CommonParameters
143+
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).
144+
126145
## INPUTS
127146
128147
## OUTPUTS

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Locale: en-US
1111
{{Manually Enter Description Here}}
1212

1313
## AzureRM.MachineLearning Cmdlets
14+
### [Add-AzureRmMlWebServiceRegionalProperty](Add-AzureRmMlWebServiceRegionalProperty.md)
15+
Creates regional web service properties.
16+
1417
### [Export-AzureRmMlWebService](Export-AzureRmMlWebService.md)
1518
Exports the web service definition object as a JSON formatted string.
1619

@@ -39,11 +42,7 @@ Moves a commitment association from one commitment plan to another.
3942
Creates a new commitment plan.
4043

4144
### [New-AzureRmMlWebService](New-AzureRmMlWebService.md)
42-
43-
Creates a new Azure Machine Learning web service.
44-
45-
### [Add-AzureRmMlWebServiceRegionalProperty](Add-AzureRmMlWebServiceRegionalProperty.md)
46-
Creates regional web service properties.
45+
Creates a new web service.
4746

4847
### [Remove-AzureRmMlCommitmentPlan](Remove-AzureRmMlCommitmentPlan.md)
4948
Deletes a commitment plan.

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -13,14 +14,14 @@ Exports the web service definition object as a JSON formatted string.
1314

1415
### Export to file.
1516
```
16-
Export-AzureRmMlWebService -WebService <WebService> -OutputFile <String> [-Force] [-WhatIf] [-Confirm]
17-
[<CommonParameters>]
17+
Export-AzureRmMlWebService -WebService <WebService> -OutputFile <String> [-Force]
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1819
```
1920

2021
### Export to JSON string.
2122
```
22-
Export-AzureRmMlWebService -WebService <WebService> [-ToJsonString] [-Force] [-WhatIf] [-Confirm]
23-
[<CommonParameters>]
23+
Export-AzureRmMlWebService -WebService <WebService> [-ToJsonString] [-Force]
24+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2425
```
2526

2627
## DESCRIPTION
@@ -49,6 +50,21 @@ Export-AzureRmMlWebService -WebService $svc -OutputFile "C:\mlservice.json"
4950

5051
## PARAMETERS
5152

53+
### -DefaultProfile
54+
The credentials, account, tenant, and subscription used for communication with azure
55+
56+
```yaml
57+
Type: IAzureContextContainer
58+
Parameter Sets: (All)
59+
Aliases: AzureRmContext, AzureCredential
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
5268
### -Force
5369
Do not ask for confirmation.
5470
@@ -146,7 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
146162
## INPUTS
147163
148164
### WebService
149-
150165
Parameter 'WebService' accepts value of type 'WebService' from the pipeline
151166
152167
## OUTPUTS

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -13,7 +14,7 @@ Retrieves the summary information for one or more commitment associations.
1314

1415
```
1516
Get-AzureRmMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> [-Name <String>]
16-
[<CommonParameters>]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -57,6 +58,21 @@ Accept pipeline input: False
5758
Accept wildcard characters: False
5859
```
5960
61+
### -DefaultProfile
62+
The credentials, account, tenant, and subscription used for communication with azure
63+
64+
```yaml
65+
Type: IAzureContextContainer
66+
Parameter Sets: (All)
67+
Aliases: AzureRmContext, AzureCredential
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
6076
### -Name
6177
The name of the Azure ML commitment association.
6278

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Retrieves the summary information for one or more commitment plans.
1213
## SYNTAX
1314

1415
```
15-
Get-AzureRmMlCommitmentPlan [-ResourceGroupName <String>] [-Name <String>] [<CommonParameters>]
16+
Get-AzureRmMlCommitmentPlan [-ResourceGroupName <String>] [-Name <String>]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1618
```
1719

1820
## DESCRIPTION
@@ -50,6 +52,21 @@ Get-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup"
5052

5153
## PARAMETERS
5254

55+
### -DefaultProfile
56+
The credentials, account, tenant, and subscription used for communication with azure
57+
58+
```yaml
59+
Type: IAzureContextContainer
60+
Parameter Sets: (All)
61+
Aliases: AzureRmContext, AzureCredential
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
5370
### -Name
5471
The name of the commitment plan.
5572

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Retrieves usage history information for a specified commitment plan.
1213
## SYNTAX
1314

1415
```
15-
Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName <String> -Name <String> [<CommonParameters>]
16+
Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName <String> -Name <String>
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1618
```
1719

1820
## DESCRIPTION
@@ -31,6 +33,21 @@ Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName "MyResourceGroup" -Na
3133

3234
## PARAMETERS
3335

36+
### -DefaultProfile
37+
The credentials, account, tenant, and subscription used for communication with azure
38+
39+
```yaml
40+
Type: IAzureContextContainer
41+
Parameter Sets: (All)
42+
Aliases: AzureRmContext, AzureCredential
43+
44+
Required: False
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
3451
### -Name
3552
The name of the Azure ML commitment plan.
3653

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -12,7 +13,8 @@ Retrieves the summary information for one or more web services.
1213
## SYNTAX
1314

1415
```
15-
Get-AzureRmMlWebService [-ResourceGroupName <String>] [-Name <String>] [<CommonParameters>]
16+
Get-AzureRmMlWebService [-ResourceGroupName <String>] [-Name <String>] [-Region <String>]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1618
```
1719

1820
## DESCRIPTION
@@ -50,6 +52,21 @@ Get-AzureRmMlWebService -ResourceGroupName "myresourcegroup"
5052

5153
## PARAMETERS
5254

55+
### -DefaultProfile
56+
The credentials, account, tenant, and subscription used for communication with azure
57+
58+
```yaml
59+
Type: IAzureContextContainer
60+
Parameter Sets: (All)
61+
Aliases: AzureRmContext, AzureCredential
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
5370
### -Name
5471
The name of the web service for which the details are retrieved.
5572
@@ -65,6 +82,21 @@ Accept pipeline input: False
6582
Accept wildcard characters: False
6683
```
6784
85+
### -Region
86+
The name of regio
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: False
97+
Accept wildcard characters: False
98+
```
99+
68100
### -ResourceGroupName
69101
The resource group from which the details for the web service are retrieved.
70102

src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
Module Name: AzureRM.MachineLearning
34
online version:
45
schema: 2.0.0
56
---
@@ -13,12 +14,14 @@ Retrieves the web service's keys.
1314

1415
### Get an Azure ML web service's access keys given its name and resource group.
1516
```
16-
Get-AzureRmMlWebServiceKeys -ResourceGroupName <String> -Name <String> [<CommonParameters>]
17+
Get-AzureRmMlWebServiceKeys -ResourceGroupName <String> -Name <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1719
```
1820

1921
### Get the access kesy for the given web service instance.
2022
```
21-
Get-AzureRmMlWebServiceKeys -MlWebService <WebService> [<CommonParameters>]
23+
Get-AzureRmMlWebServiceKeys -MlWebService <WebService> [-DefaultProfile <IAzureContextContainer>]
24+
[<CommonParameters>]
2225
```
2326

2427
## DESCRIPTION
@@ -48,6 +51,21 @@ $mlService is an object of type Microsoft.Azure.Management.MachineLearning.WebSe
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
### -MlWebService
5270
The name of the web service for which the access keys are retrieved.
5371
@@ -99,7 +117,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
99117
## INPUTS
100118
101119
### WebService
102-
103120
Parameter 'MlWebService' accepts value of type 'WebService' from the pipeline
104121
105122
## OUTPUTS

0 commit comments

Comments
 (0)