Skip to content

Commit bdd7e3a

Browse files
boringuserboringuser
committed
Adding help, refactoring to use platyPS/markdown
1 parent 8481242 commit bdd7e3a

17 files changed

+4187
-1486
lines changed

‎src/ResourceManager/MachineLearning/Commands.MachineLearning/Commands.MachineLearning.csproj

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,21 @@
139139
<Link>AzureRM.MachineLearning.psd1</Link>
140140
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
141141
</None>
142+
<None Include="help\AzureRM.MachineLearning.md" />
143+
<None Include="help\Export-AzureRmMlWebService.md" />
144+
<None Include="help\Get-AzureRmMlCommitmentAssociation.md" />
145+
<None Include="help\Get-AzureRmMlCommitmentPlan.md" />
146+
<None Include="help\Get-AzureRmMlCommitmentPlanUsageHistory.md" />
147+
<None Include="help\Get-AzureRmMlWebService.md" />
148+
<None Include="help\Get-AzureRmMlWebServiceKeys.md" />
149+
<None Include="help\Import-AzureRmMlWebService.md" />
150+
<None Include="help\Move-AzureRmMlCommitmentAssociation.md" />
151+
<None Include="help\New-AzureRmMlCommitmentPlan.md" />
152+
<None Include="help\New-AzureRmMlWebService.md" />
153+
<None Include="help\Remove-AzureRmMlCommitmentPlan.md" />
154+
<None Include="help\Remove-AzureRmMlWebService.md" />
155+
<None Include="help\Update-AzureRmMlCommitmentPlan.md" />
156+
<None Include="help\Update-AzureRmMlWebService.md" />
142157
<None Include="MSSharedLibKey.snk" />
143158
<None Include="packages.config">
144159
<SubType>Designer</SubType>

‎src/ResourceManager/MachineLearning/Commands.MachineLearning/Microsoft.Azure.Commands.MachineLearning.dll-help.xml

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

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
Module Name: AzureRM.MachineLearning
3+
Module Guid: bb030259-49f9-46ef-806f-2a3f5a2e018e
4+
Download Help Link: {{Please enter FwLink manually}}
5+
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.MachineLearning Module
10+
## Description
11+
{{Manually Enter Description Here}}
12+
13+
## AzureRM.MachineLearning Cmdlets
14+
### [Export-AzureRmMlWebService](Export-AzureRmMlWebService.md)
15+
{{Manually Enter Export-AzureRmMlWebService Description Here}}
16+
17+
### [Get-AzureRmMlCommitmentAssociation](Get-AzureRmMlCommitmentAssociation.md)
18+
{{Manually Enter Get-AzureRmMlCommitmentAssociation Description Here}}
19+
20+
### [Get-AzureRmMlCommitmentPlan](Get-AzureRmMlCommitmentPlan.md)
21+
{{Manually Enter Get-AzureRmMlCommitmentPlan Description Here}}
22+
23+
### [Get-AzureRmMlCommitmentPlanUsageHistory](Get-AzureRmMlCommitmentPlanUsageHistory.md)
24+
{{Manually Enter Get-AzureRmMlCommitmentPlanUsageHistory Description Here}}
25+
26+
### [Get-AzureRmMlWebService](Get-AzureRmMlWebService.md)
27+
{{Manually Enter Get-AzureRmMlWebService Description Here}}
28+
29+
### [Get-AzureRmMlWebServiceKeys](Get-AzureRmMlWebServiceKeys.md)
30+
{{Manually Enter Get-AzureRmMlWebServiceKeys Description Here}}
31+
32+
### [Import-AzureRmMlWebService](Import-AzureRmMlWebService.md)
33+
{{Manually Enter Import-AzureRmMlWebService Description Here}}
34+
35+
### [Move-AzureRmMlCommitmentAssociation](Move-AzureRmMlCommitmentAssociation.md)
36+
{{Manually Enter Move-AzureRmMlCommitmentAssociation Description Here}}
37+
38+
### [New-AzureRmMlCommitmentPlan](New-AzureRmMlCommitmentPlan.md)
39+
{{Manually Enter New-AzureRmMlCommitmentPlan Description Here}}
40+
41+
### [New-AzureRmMlWebService](New-AzureRmMlWebService.md)
42+
{{Manually Enter New-AzureRmMlWebService Description Here}}
43+
44+
### [Remove-AzureRmMlCommitmentPlan](Remove-AzureRmMlCommitmentPlan.md)
45+
{{Manually Enter Remove-AzureRmMlCommitmentPlan Description Here}}
46+
47+
### [Remove-AzureRmMlWebService](Remove-AzureRmMlWebService.md)
48+
{{Manually Enter Remove-AzureRmMlWebService Description Here}}
49+
50+
### [Update-AzureRmMlCommitmentPlan](Update-AzureRmMlCommitmentPlan.md)
51+
{{Manually Enter Update-AzureRmMlCommitmentPlan Description Here}}
52+
53+
### [Update-AzureRmMlWebService](Update-AzureRmMlWebService.md)
54+
{{Manually Enter Update-AzureRmMlWebService Description Here}}
55+

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

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.MachineLearning.dll-help.xml
3+
online version:
4+
schema: 2.0.0
5+
---
6+
7+
# Export-AzureRmMlWebService
8+
9+
## SYNOPSIS
10+
Exports the web service definition object as a JSON formatted string.
11+
12+
## SYNTAX
13+
14+
### Export to file.
15+
```
16+
Export-AzureRmMlWebService -WebService <WebService> -OutputFile <String> [-Force] [-WhatIf] [-Confirm]
17+
```
18+
19+
### Export to JSON string.
20+
```
21+
Export-AzureRmMlWebService -WebService <WebService> [-ToJsonString] [-Force] [-WhatIf] [-Confirm]
22+
```
23+
24+
## DESCRIPTION
25+
Exports the definition object for the specified web servive as a JSON formatted string.
26+
You can return the string immediately or save it to a file.
27+
28+
## EXAMPLES
29+
30+
### -------------------------- Example 1: Export as string --------------------------
31+
@{paragraph=PS C:\\\>}
32+
33+
```
34+
Export-AzureRmMlWebService -WebService $svc -ToJsonString
35+
```
36+
37+
### -------------------------- Example 2: Export to file --------------------------
38+
@{paragraph=PS C:\\\>}
39+
40+
```
41+
Export-AzureRmMlWebService -WebService $svc -OutputFile "C:\mlservice.json"
42+
```
43+
44+
## PARAMETERS
45+
46+
### -Force
47+
Do not ask for confirmation.
48+
49+
```yaml
50+
Type: SwitchParameter
51+
Parameter Sets: (All)
52+
Aliases:
53+
54+
Required: False
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -OutputFile
62+
The file path for exported definition.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: Export to file.
67+
Aliases:
68+
69+
Required: True
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -ToJsonString
77+
Specifies that the definition will be exported as a JSON string.
78+
79+
```yaml
80+
Type: SwitchParameter
81+
Parameter Sets: Export to JSON string.
82+
Aliases:
83+
84+
Required: True
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### -WebService
92+
The web service definition object to be exported.
93+
94+
```yaml
95+
Type: WebService
96+
Parameter Sets: (All)
97+
Aliases:
98+
99+
Required: True
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: True (ByValue)
103+
Accept wildcard characters: False
104+
```
105+
106+
### -Confirm
107+
Prompts you for confirmation before running the cmdlet.
108+
109+
```yaml
110+
Type: SwitchParameter
111+
Parameter Sets: (All)
112+
Aliases: cf
113+
114+
Required: False
115+
Position: Named
116+
Default value: None
117+
Accept pipeline input: False
118+
Accept wildcard characters: False
119+
```
120+
121+
### -WhatIf
122+
Shows what would happen if the cmdlet runs.
123+
The cmdlet is not run.
124+
125+
```yaml
126+
Type: SwitchParameter
127+
Parameter Sets: (All)
128+
Aliases: wi
129+
130+
Required: False
131+
Position: Named
132+
Default value: None
133+
Accept pipeline input: False
134+
Accept wildcard characters: False
135+
```
136+
137+
## INPUTS
138+
139+
## OUTPUTS
140+
141+
### None
142+
143+
## NOTES
144+
Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml
145+
146+
## RELATED LINKS
147+

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

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
---
6+
7+
# Get-AzureRmMlCommitmentAssociation
8+
9+
## SYNOPSIS
10+
Retrieves the summary information for one or more commitment associations.
11+
12+
## SYNTAX
13+
14+
```
15+
Get-AzureRmMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> [-Name <String>]
16+
```
17+
18+
## DESCRIPTION
19+
Retrieves commitment association information.
20+
Depending on the paramenters passed, the cmdlet returns a specific commitment association or a collection of commitment associations for the specified commitment plan.
21+
22+
## EXAMPLES
23+
24+
### -------------------------- Example 1: Get a specific commitment association --------------------------
25+
@{paragraph=PS C:\\\>}
26+
27+
```
28+
Get-AzureRmMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName" -Name "MyCommitmentAssociationName"
29+
```
30+
31+
### -------------------------- Example 2: Get all commitment associations for the specified commitment plan --------------------------
32+
@{paragraph=PS C:\\\>}
33+
34+
```
35+
Get-AzureRmMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName"
36+
```
37+
38+
## PARAMETERS
39+
40+
### -CommitmentPlanName
41+
The name of the Azure ML commitment plan which has one or more commitment associations.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: Named
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -Name
56+
The name of the Azure ML commitment association.
57+
58+
```yaml
59+
Type: String
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -ResourceGroupName
71+
The name of the resource group for the Azure ML commitment association.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: True
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
## INPUTS
86+
87+
## OUTPUTS
88+
89+
### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan
90+
Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan[]
91+
92+
## NOTES
93+
Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml
94+
95+
## RELATED LINKS
96+

0 commit comments

Comments
 (0)