Skip to content

Commit 75708aa

Browse files
author
Maddie Clayton
authored
Merge pull request #5831 from maddieclayton/indexscript
Creating index.json for Docs
2 parents 37c0241 + 8920d04 commit 75708aa

File tree

44 files changed

+346
-132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+346
-132
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ FakesAssemblies/
215215
*.GhostDoc.xml
216216
pingme.txt
217217
groupMapping*.json
218+
/tools/index.json
219+
/Package/index.json
218220

219221
*.msi
220222
*.wixpdb

build.proj

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,6 @@
201201
<Message Importance="high" Text="Building Cmdlets..." />
202202

203203
<MakeDir Directories="$(PackageDirectory)" />
204-
<Exec ContinueOnError="false"
205-
Command="&quot;$(PowerShellCommand)&quot; -NonInteractive -NoLogo -NoProfile -Command &quot; . $(LibraryToolsFolder)\CreateMappings.ps1 -RootPath $(LibrarySourceFolder) -OutputFile $(PackageDirectory)\groupMapping.json -WarningFile $(PackageDirectory)\groupMappingWarnings.json -RulesFile $(LibraryToolsFolder)\CreateMappings_rules.json &quot;" Condition="'$(Latest)' == 'true'"/>
206204

207205
<MSBuild
208206
Projects="@(CmdletSolutionsToBuild)"
@@ -218,6 +216,10 @@
218216

219217
<Exec Command="&quot;$(PowerShellCommand)&quot; -NonInteractive -NoLogo -NoProfile -Command &quot;. $(LibraryToolsFolder)\UpdateModules.ps1 $(Configuration) $(Scope) -Profile Latest &quot; " Condition="'$(Latest)' == 'true' and '$(CodeSign)' == 'false'"/>
220218
<Exec Command="&quot;$(PowerShellCommand)&quot; -NonInteractive -NoLogo -NoProfile -Command &quot;. $(LibraryToolsFolder)\UpdateModules.ps1 $(Configuration) $(Scope) -Profile Stack &quot; " Condition="'$(Stack)' == 'true' and '$(CodeSign)' == 'false'"/>
219+
220+
<Exec ContinueOnError="false"
221+
Command="&quot;$(PowerShellCommand)&quot; -NonInteractive -NoLogo -NoProfile -Command &quot; . $(LibraryToolsFolder)\NewHelpIndex.ps1 -OutputFile $(PackageDirectory)\index.json -BuildConfig $(Configuration) &quot;" Condition="'$(Latest)' == 'true'"/>
222+
221223
<!-- Copying shortcut to be signed -->
222224
<Copy SourceFiles="$(LibraryRoot)tools\AzureRM\AzureRM.psd1"
223225
DestinationFolder="$(LibrarySourceFolder)\Package\$(Configuration)" Condition= " '$(NetCore)' == 'false' and '$(Latest)' == 'true'"/>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
Module Name: AzureRM.ApplicationInsights
3+
Module Guid: da67eaa7-4cb1-4bfa-a194-8bf3faae8ac6
4+
Download Help Link: None
5+
Help Version: 0.1.2
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.ApplicationInsights Module
10+
## Description
11+
Creates and manages application insights in Azure Resource Manager.
12+
13+
## AzureRM.ApplicationInsights Cmdlets
14+
### [Get-AzureRmApplicationInsights](Get-AzureRmApplicationInsights.md)
15+
Get application insights resources
16+
17+
### [Get-AzureRmApplicationInsightsApiKey](Get-AzureRmApplicationInsightsApiKey.md)
18+
Get application insights api keys for an application insights resource
19+
20+
### [Get-AzureRmApplicationInsightsContinuousExport](Get-AzureRmApplicationInsightsContinuousExport.md)
21+
Get application insights continuous export configuration for an application insights resource
22+
23+
### [New-AzureRmApplicationInsights](New-AzureRmApplicationInsights.md)
24+
Create a new application insights resource
25+
26+
### [New-AzureRmApplicationInsightsApiKey](New-AzureRmApplicationInsightsApiKey.md)
27+
Create an application insights api key for an application insights resource
28+
29+
### [New-AzureRmApplicationInsightsContinuousExport](New-AzureRmApplicationInsightsContinuousExport.md)
30+
Create a new application insights continuous export configuration for an application insights resource
31+
32+
### [Remove-AzureRmApplicationInsights](Remove-AzureRmApplicationInsights.md)
33+
Remove an application insights resource
34+
35+
### [Remove-AzureRmApplicationInsightsApiKey](Remove-AzureRmApplicationInsightsApiKey.md)
36+
Remove an application insights api key for an application insights resource
37+
38+
### [Remove-AzureRmApplicationInsightsContinuousExport](Remove-AzureRmApplicationInsightsContinuousExport.md)
39+
Remove a cotinuous export configuration in an application insights resource
40+
41+
### [Set-AzureRmApplicationInsightsContinuousExport](Set-AzureRmApplicationInsightsContinuousExport.md)
42+
Update a continuous export configuration in an applciation insights resource
43+
44+
### [Set-AzureRmApplicationInsightsDailyCap](Set-AzureRmApplicationInsightsDailyCap.md)
45+
Set daily data volume cap for an application insights resource
46+
47+
### [Set-AzureRmApplicationInsightsPricingPlan](Set-AzureRmApplicationInsightsPricingPlan.md)
48+
Set pricing plan and daily data volume information for an applicaiton insights resource
49+

src/ResourceManager/AzureBackup/Commands.AzureBackup/help/AzureRM.Backup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Backup
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 0b1d76f5-a928-4b8f-9c83-df26947568d4
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Batch
3-
Module Guid: Batch_Cmdlets_D48CF693-4125-4D2D-879
3+
Module Guid: a8f00f40-1c1a-49b5-9db3-24076b75c3cf
44
Download Help Link: http://go.microsoft.com/fwlink/?linkid=390762
55
Help Version: 4.0.0.0
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Cdn
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 52594002-db89-46df-928d-2755dad840e8
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/AzureRM.CognitiveServices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.CognitiveServices
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 66c566b4-950c-4a2b-9f3b-199d92f0df1a
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/help/AzureRM.Compute.ManagedService.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Compute.ManagedService
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 5c5f634f-b323-4822-b8e4-695dd0110af9
44
Download Help Link:
55
Help Version: 3.5.0.0
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Compute
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 0a83c907-1ffb-4d87-a492-c65ac7d7ed37
44
Download Help Link:
55
Help Version: 3.5.0.0
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.ContainerInstance
3-
Module Guid:
3+
Module Guid: 99d2fc1f-ff3c-4bf3-ac22-8f81f0e5c279
44
Download Help Link:
55
Help Version:
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.DataFactories
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: e3c0f6bc-fe96-41a0-88f4-5e490a91f05d
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.DevTestLabs
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: be2ca175-bfb9-4601-b01c-4de13eb2105c
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

src/ResourceManager/Dns/Commands.Dns/help/AzureRM.DNS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Dns
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 5e5ed8bc-27bf-4380-9de1-4b22ba0920b2
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.HDInsight
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 3fd1475f-cb23-4ffb-bf08-33d94b7d1acb
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.Insights
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 698c387c-bd6b-41c6-82ce-721f1ef39548
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

src/ResourceManager/LocationBasedServices/AzureRM.LocationBasedServices.psd1

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ FunctionsToExport = @()
7575
CmdletsToExport = 'Get-AzureRmLocationBasedServicesAccount',
7676
'New-AzureRmLocationBasedServicesAccount',
7777
'Remove-AzureRmLocationBasedServicesAccount',
78-
'Set-AzureRmLocationBasedServicesAccount',
7978
'Get-AzureRmLocationBasedServicesAccountKey',
8079
'New-AzureRmLocationBasedServicesAccountKey'
8180

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.LogicApp
3-
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
3+
Module Guid: 8a7d44bb-e747-4265-8f22-b3937961d709
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: AzureRM.MachineLearningCompute
3-
Module Guid:
3+
Module Guid: bb030259-49f9-46ef-806f-2a3f5a2e018f
44
Download Help Link:
55
Help Version:
66
Locale: en-US
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
Module Name: AzureRM.ManagementPartner
3+
Module Guid: bf60f35d-6c0b-42f2-be30-eb333a31279d
4+
Download Help Link: None
5+
Help Version: 0.1.0
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.ManagementPartner Module
10+
## Description
11+
Management Partner cmdlets for Azure Resource Manager.
12+
13+
## AzureRM.ManagementPartner Cmdlets
14+
### [Get-AzureRmManagementPartner](Get-AzureRmManagementPartner.md)
15+
Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal.
16+
17+
### [New-AzureRmManagementPartner](New-AzureRmManagementPartner.md)
18+
Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal.
19+
20+
### [Remove-AzureRmManagementPartner](Remove-AzureRmManagementPartner.md)
21+
Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal.
22+
23+
### [Update-AzureRmManagementPartner](Update-AzureRmManagementPartner.md)
24+
Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal.
25+

src/ResourceManager/ManagementPartner/Commands.Partner/help/Get-AzureRmManagementPartner.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml
3-
Module Name: AzureRM.Resources
2+
external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml
3+
Module Name: AzureRM.ManagementPartner
44
online version: https://docs.microsoft.com/en-us/powershell/module/get-azurermmanagementpartner
55
schema: 2.0.0
66
---
@@ -79,22 +79,20 @@ Accept wildcard characters: False
7979
```
8080
8181
### CommonParameters
82-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
83-
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
82+
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).
8483
8584
## INPUTS
8685
8786
### None
8887
89-
9088
## OUTPUTS
9189
9290
### Microsoft.Azure.Commands.Resources.PSManagementPartner
9391
94-
9592
## NOTES
9693
9794
## RELATED LINKS
95+
9896
[Remove-AzureRmManagementPartner](./Remove-AzureRmManagementPartner.md)
9997
10098
[New-AzureRmManagementPartner](./New-AzureRmManagementPartner.md)

src/ResourceManager/ManagementPartner/Commands.Partner/help/New-AzureRmManagementPartner.md

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml
3-
Module Name: AzureRM.Resources
2+
external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml
3+
Module Name: AzureRM.ManagementPartner
44
online version: http://go.microsoft.com/fwlink/?LinkID=393044
55
schema: 2.0.0
66
---
@@ -13,8 +13,8 @@ Associates a Microsoft Partner Network(MPN) ID to the current authenticated user
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>]
17-
[-WhatIf] [-Confirm] [<CommonParameters>]
16+
New-AzureRmManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
17+
[-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -36,21 +36,6 @@ Add a management partner
3636

3737
## PARAMETERS
3838

39-
### -Confirm
40-
Prompts you for confirmation before running the cmdlet.
41-
42-
```yaml
43-
Type: SwitchParameter
44-
Parameter Sets: (All)
45-
Aliases: cf
46-
47-
Required: False
48-
Position: Named
49-
Default value: None
50-
Accept pipeline input: False
51-
Accept wildcard characters: False
52-
```
53-
5439
### -DefaultProfile
5540
The credentials, account, tenant, and subscription used for communication with Azure.
5641

@@ -66,28 +51,31 @@ Accept pipeline input: False
6651
Accept wildcard characters: False
6752
```
6853
54+
### -PartnerId
55+
The management partner id, it is a 6 digits number
56+
6957
```yaml
70-
Type: SwitchParameter
58+
Type: String
7159
Parameter Sets: (All)
7260
Aliases:
7361

74-
Required: False
75-
Position: Named
62+
Required: True
63+
Position: 0
7664
Default value: None
7765
Accept pipeline input: False
7866
Accept wildcard characters: False
7967
```
8068
81-
### -PartnerId
82-
The management partner id, it is a 6 digits number
69+
### -Confirm
70+
Prompts you for confirmation before running the cmdlet.
8371
8472
```yaml
85-
Type: String
73+
Type: SwitchParameter
8674
Parameter Sets: (All)
87-
Aliases:
75+
Aliases: cf
8876

89-
Required: True
90-
Position: 0
77+
Required: False
78+
Position: Named
9179
Default value: None
9280
Accept pipeline input: False
9381
Accept wildcard characters: False
@@ -110,22 +98,20 @@ Accept wildcard characters: False
11098
```
11199
112100
### CommonParameters
113-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
114-
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
101+
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).
115102
116103
## INPUTS
117104
118105
### None
119106
120-
121107
## OUTPUTS
122108
123109
### Microsoft.Azure.Commands.Resources.PSManagementPartner
124110
125-
126111
## NOTES
127112
128113
## RELATED LINKS
114+
129115
[Remove-AzureRmManagementPartner](./Remove-AzureRmManagementPartner.md)
130116
131117
[Get-AzureRmManagementPartner](./Get-AzureRmManagementPartner.md)

0 commit comments

Comments
 (0)