Skip to content

Commit c6c8f80

Browse files
author
Arjan Meskers
committed
Administration psm1 + Build Docs
1 parent c4d0456 commit c6c8f80

56 files changed

Lines changed: 1886 additions & 3736 deletions

File tree

Some content is hidden

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

‎builddocs.ps1‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,29 @@ Install-Module -Name 'platyPS' -Scope CurrentUser -Force
33
Import-Module '.\src\AMSoftware.Dataverse.PowerShell\bin\debug\AMSoftware.Dataverse.PowerShell.psd1'
44

55
if (-not (Test-Path -Path '.\docs\')) {
6-
New-MarkdownHelp -Module 'AMSoftware.Dataverse.PowerShell' -WithModulePage -OutputFolder '.\docs\'
6+
New-MarkdownHelp -Module 'AMSoftware.Dataverse.PowerShell' -WithModulePage -AlphabeticParamsOrder -UseFullTypeName -Force -OutputFolder '.\docs\'
77
}
88

99
Update-MarkdownHelpModule '.\docs\' -RefreshModulePage -AlphabeticParamsOrder -UseFullTypeName -UpdateInputOutput -Force
1010

1111
Copy-Item -Path '.\docs\AMSoftware.Dataverse.PowerShell.md' -Destination '.\docs\index.md' -Force
1212

13-
New-ExternalHelp -Path '.\docs\' -OutputPath '.\src\AMSoftware.Dataverse.PowerShell\bin\debug\en-US\' -Force
13+
$requestParametersText = @'
14+
This cmdlet supports the request parameters: -Solution, -SharedTag, -Partition, -FailOnDuplicateDetection, -BypassSynchronousLogic, and -BypassPowerAutomateFlows. For more information, see about_DataverseRequestParameters.
15+
'@
16+
17+
# Remove shared Request Parameters
18+
# Remove common PowerShell Parameters
19+
# Add request parameters section if needed
20+
Get-ChildItem -Path '.\docs\*.md' -Exclude 'about_*.md' | Foreach-Object {
21+
$content = Get-Content -Path $_ -Raw
22+
$content = $content -replace '(### -(Solution|SharedTag|Partition|FailOnDuplicateDetection|BypassSynchronousLogic|BypassPowerAutomateFlows|ProgressAction|WhatIf|Confirm)(?:.|\n)*?)(?=##)',''
23+
$content = $content -replace '(\[-(WhatIf|Confirm|ProgressAction).*?\])',''
24+
25+
if ($content -match '(\[-(Solution|SharedTag|Partition|FailOnDuplicateDetection|BypassSynchronousLogic|BypassPowerAutomateFlows).*?\])') {
26+
$content = $content -replace '(\[-(Solution|SharedTag|Partition|FailOnDuplicateDetection|BypassSynchronousLogic|BypassPowerAutomateFlows).*?\])',''
27+
$content = $content.Replace('[<CommonParameters>]','[<RequestParameters>] [<CommonParameters>]')
28+
$content = $content.Replace('### CommonParameters', "### RequestParameters`n$($requestParametersText)`n`n### CommonParameters")
29+
}
30+
Set-Content -Path $_ -Value $content
31+
}

‎docs/AMSoftware.Dataverse.PowerShell.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Locale: en-US
1717
### [Add-DataverseColumn](Add-DataverseColumn.md)
1818
{{ Fill in the Synopsis }}
1919

20+
### [Add-DataverseLanguage](Add-DataverseLanguage.md)
21+
{{ Fill in the Synopsis }}
22+
2023
### [Add-DataverseRelatedRow](Add-DataverseRelatedRow.md)
2124
{{ Fill in the Synopsis }}
2225

@@ -35,27 +38,54 @@ Locale: en-US
3538
### [Connect-DataverseEnvironment](Connect-DataverseEnvironment.md)
3639
{{ Fill in the Synopsis }}
3740

41+
### [Export-DataverseTranslation](Export-DataverseTranslation.md)
42+
{{ Fill in the Synopsis }}
43+
3844
### [Get-DataverseChoice](Get-DataverseChoice.md)
3945
{{ Fill in the Synopsis }}
4046

4147
### [Get-DataverseColumn](Get-DataverseColumn.md)
4248
{{ Fill in the Synopsis }}
4349

50+
### [Get-DataverseEnvironmentVariableValue](Get-DataverseEnvironmentVariableValue.md)
51+
{{ Fill in the Synopsis }}
52+
53+
### [Get-DataverseLanguage](Get-DataverseLanguage.md)
54+
{{ Fill in the Synopsis }}
55+
4456
### [Get-DataverseRelationship](Get-DataverseRelationship.md)
4557
{{ Fill in the Synopsis }}
4658

59+
### [Get-DataverseRole](Get-DataverseRole.md)
60+
{{ Fill in the Synopsis }}
61+
4762
### [Get-DataverseRow](Get-DataverseRow.md)
4863
{{ Fill in the Synopsis }}
4964

65+
### [Get-DataverseRowAccess](Get-DataverseRowAccess.md)
66+
{{ Fill in the Synopsis }}
67+
5068
### [Get-DataverseRows](Get-DataverseRows.md)
5169
{{ Fill in the Synopsis }}
5270

71+
### [Get-DataverseSPDocumentLocation](Get-DataverseSPDocumentLocation.md)
72+
{{ Fill in the Synopsis }}
73+
5374
### [Get-DataverseTable](Get-DataverseTable.md)
5475
{{ Fill in the Synopsis }}
5576

5677
### [Get-DataverseTableKey](Get-DataverseTableKey.md)
5778
{{ Fill in the Synopsis }}
5879

80+
### [Get-DataverseTeam](Get-DataverseTeam.md)
81+
{{ Fill in the Synopsis }}
82+
83+
### [Get-DataverseUser](Get-DataverseUser.md)
84+
{{ Fill in the Synopsis }}
85+
86+
### [Import-DataverseTranslation](Import-DataverseTranslation.md)
87+
{{ Fill in the Synopsis }}
88+
5989
### [Remove-DataverseChoice](Remove-DataverseChoice.md)
6090
{{ Fill in the Synopsis }}
6191

@@ -65,6 +95,9 @@ Locale: en-US
6595
### [Remove-DataverseColumn](Remove-DataverseColumn.md)
6696
{{ Fill in the Synopsis }}
6797

98+
### [Remove-DataverseLanguage](Remove-DataverseLanguage.md)
99+
{{ Fill in the Synopsis }}
100+
68101
### [Remove-DataverseRelatedRow](Remove-DataverseRelatedRow.md)
69102
{{ Fill in the Synopsis }}
70103

@@ -80,6 +113,9 @@ Locale: en-US
80113
### [Remove-DataverseTableKey](Remove-DataverseTableKey.md)
81114
{{ Fill in the Synopsis }}
82115

116+
### [Request-DataverseBatch](Request-DataverseBatch.md)
117+
{{ Fill in the Synopsis }}
118+
83119
### [Send-DataverseRequest](Send-DataverseRequest.md)
84120
{{ Fill in the Synopsis }}
85121

@@ -95,15 +131,25 @@ Locale: en-US
95131
### [Set-DataverseRow](Set-DataverseRow.md)
96132
{{ Fill in the Synopsis }}
97133

134+
### [Set-DataverseRowOwner](Set-DataverseRowOwner.md)
135+
{{ Fill in the Synopsis }}
136+
98137
### [Set-DataverseRows](Set-DataverseRows.md)
99138
{{ Fill in the Synopsis }}
100139

101140
### [Set-DataverseTable](Set-DataverseTable.md)
102141
{{ Fill in the Synopsis }}
103142

143+
### [Start-DataverseWorkflow](Start-DataverseWorkflow.md)
144+
{{ Fill in the Synopsis }}
145+
146+
### [Submit-DataverseBatch](Submit-DataverseBatch.md)
147+
{{ Fill in the Synopsis }}
148+
104149
### [Use-DataverseLanguage](Use-DataverseLanguage.md)
105150
{{ Fill in the Synopsis }}
106151

107152
### [Use-DataverseSolution](Use-DataverseSolution.md)
108153
{{ Fill in the Synopsis }}
109154

155+

‎docs/Add-DataverseChoice.md‎

Lines changed: 10 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ schema: 2.0.0
1414

1515
### AddChoiceObject (Default)
1616
```
17-
Add-DataverseChoice -InputObject <OptionSetMetadata> [-Solution <String>] [-SharedTag <String>]
18-
[-Partition <String>] [-FailOnDuplicateDetection] [-BypassSynchronousLogic] [-BypassPowerAutomateFlows]
19-
[-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
Add-DataverseChoice -InputObject <OptionSetMetadata>
18+
19+
[<RequestParameters>] [<CommonParameters>]
2020
```
2121

2222
### AddNewChoice
2323
```
2424
Add-DataverseChoice -Name <String> -DisplayName <String> [-Description <String>] [-ExternalName <String>]
25-
-Options <OptionMetadata[]> [-Solution <String>] [-SharedTag <String>] [-Partition <String>]
26-
[-FailOnDuplicateDetection] [-BypassSynchronousLogic] [-BypassPowerAutomateFlows]
27-
[-ProgressAction <ActionPreference>] [<CommonParameters>]
25+
-Options <OptionMetadata[]>
26+
27+
[<RequestParameters>] [<CommonParameters>]
2828
```
2929

3030
## DESCRIPTION
@@ -33,44 +33,14 @@ Add-DataverseChoice -Name <String> -DisplayName <String> [-Description <String>]
3333
## EXAMPLES
3434

3535
### Example 1
36-
```powershell
36+
```
3737
PS C:\> {{ Add example code here }}
3838
```
3939

4040
{{ Add example description here }}
4141

4242
## PARAMETERS
4343

44-
### -BypassPowerAutomateFlows
45-
{{ Fill BypassPowerAutomateFlows Description }}
46-
47-
```yaml
48-
Type: System.Management.Automation.SwitchParameter
49-
Parameter Sets: (All)
50-
Aliases:
51-
52-
Required: False
53-
Position: Named
54-
Default value: None
55-
Accept pipeline input: False
56-
Accept wildcard characters: False
57-
```
58-
59-
### -BypassSynchronousLogic
60-
{{ Fill BypassSynchronousLogic Description }}
61-
62-
```yaml
63-
Type: System.Management.Automation.SwitchParameter
64-
Parameter Sets: (All)
65-
Aliases:
66-
67-
Required: False
68-
Position: Named
69-
Default value: None
70-
Accept pipeline input: False
71-
Accept wildcard characters: False
72-
```
73-
7444
### -Description
7545
{{ Fill Description Description }}
7646

@@ -116,21 +86,6 @@ Accept pipeline input: False
11686
Accept wildcard characters: False
11787
```
11888
119-
### -FailOnDuplicateDetection
120-
{{ Fill FailOnDuplicateDetection Description }}
121-
122-
```yaml
123-
Type: System.Management.Automation.SwitchParameter
124-
Parameter Sets: (All)
125-
Aliases:
126-
127-
Required: False
128-
Position: Named
129-
Default value: None
130-
Accept pipeline input: False
131-
Accept wildcard characters: False
132-
```
133-
13489
### -InputObject
13590
{{ Fill InputObject Description }}
13691
@@ -176,77 +131,19 @@ Accept pipeline input: False
176131
Accept wildcard characters: False
177132
```
178133
179-
### -Partition
180-
{{ Fill Partition Description }}
181-
182-
```yaml
183-
Type: System.String
184-
Parameter Sets: (All)
185-
Aliases:
186-
187-
Required: False
188-
Position: Named
189-
Default value: None
190-
Accept pipeline input: False
191-
Accept wildcard characters: False
192-
```
193-
194-
### -ProgressAction
195-
{{ Fill ProgressAction Description }}
196-
197-
```yaml
198-
Type: System.Management.Automation.ActionPreference
199-
Parameter Sets: (All)
200-
Aliases: proga
201-
202-
Required: False
203-
Position: Named
204-
Default value: None
205-
Accept pipeline input: False
206-
Accept wildcard characters: False
207-
```
208-
209-
### -SharedTag
210-
{{ Fill SharedTag Description }}
211-
212-
```yaml
213-
Type: System.String
214-
Parameter Sets: (All)
215-
Aliases:
216-
217-
Required: False
218-
Position: Named
219-
Default value: None
220-
Accept pipeline input: False
221-
Accept wildcard characters: False
222-
```
223-
224-
### -Solution
225-
{{ Fill Solution Description }}
226-
227-
```yaml
228-
Type: System.String
229-
Parameter Sets: (All)
230-
Aliases:
231-
232-
Required: False
233-
Position: Named
234-
Default value: None
235-
Accept pipeline input: False
236-
Accept wildcard characters: False
237-
```
134+
### RequestParameters
135+
This cmdlet supports the request parameters: -Solution, -SharedTag, -Partition, -FailOnDuplicateDetection, -BypassSynchronousLogic, and -BypassPowerAutomateFlows. For more information, see about_DataverseRequestParameters.
238136
239137
### CommonParameters
240138
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).
241139
242140
## INPUTS
243141
244142
### Microsoft.Xrm.Sdk.Metadata.OptionMetadata[]
245-
246143
## OUTPUTS
247144
248145
### Microsoft.Xrm.Sdk.Metadata.OptionSetMetadataBase
249-
250146
## NOTES
251147
252148
## RELATED LINKS
149+

0 commit comments

Comments
 (0)