[create-pull-request] automated change

maester365 · Jul 21, 2024 · 0fb9a6f · 0fb9a6f
1 parent 1e6dfeb
commit 0fb9a6f
Show file tree

Hide file tree

Showing 101 changed files with 300 additions and 62 deletions.
diff --git a/website/docs/commands/Add-MtTestResultDetail.mdx b/website/docs/commands/Add-MtTestResultDetail.mdx
@@ -145,7 +145,7 @@ Accept wildcard characters: False
 
 ### -SkippedBecause
 
-\{\{ Fill SkippedBecause Description \}\}
+Common reasons for why the test was skipped.
 
 ```yaml
 Type: String
@@ -161,7 +161,8 @@ Accept wildcard characters: False
 
 ### -SkippedCustomReason
 
-\{\{ Fill SkippedCustomReason Description \}\}
+A custom reason for why the test was skipped.
+Requires `-SkippedBecause Custom`.
 
 ```yaml
 Type: String
@@ -202,3 +203,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Add-MtTestResultDetail](https://maester.dev/docs/commands/Add-MtTestResultDetail)
diff --git a/website/docs/commands/Clear-MtDnsCache.mdx b/website/docs/commands/Clear-MtDnsCache.mdx
@@ -64,3 +64,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Clear-MtDnsCache](https://maester.dev/docs/commands/Clear-MtDnsCache)
diff --git a/website/docs/commands/Clear-MtGraphCache.mdx b/website/docs/commands/Clear-MtGraphCache.mdx
@@ -64,3 +64,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Clear-MtGraphCache](https://maester.dev/docs/commands/Clear-MtGraphCache)
diff --git a/website/docs/commands/Compare-MtTestResult.mdx b/website/docs/commands/Compare-MtTestResult.mdx
@@ -54,7 +54,8 @@ Compare-MtTestResult @tests
 
 ### -BaseDir
 
-\{\{ Fill BaseDir Description \}\}
+Path to folder where test results are located.
+The two newest results will be compared.
 
 ```yaml
 Type: Object
@@ -70,7 +71,7 @@ Accept wildcard characters: False
 
 ### -PriorTest
 
-\{\{ Fill PriorTest Description \}\}
+Path to the previous test result JSON-file to be used as a reference.
 
 ```yaml
 Type: Object
@@ -86,7 +87,7 @@ Accept wildcard characters: False
 
 ### -NewTest
 
-\{\{ Fill NewTest Description \}\}
+Path to the newer test result JSON-file to be used as the current result.
 
 ```yaml
 Type: Object
@@ -127,3 +128,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Compare-MtTestResult](https://maester.dev/docs/commands/Compare-MtTestResult)
diff --git a/website/docs/commands/Connect-Maester.mdx b/website/docs/commands/Connect-Maester.mdx
@@ -252,3 +252,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Connect-Maester](https://maester.dev/docs/commands/Connect-Maester)
diff --git a/website/docs/commands/ConvertFrom-MailAuthenticationRecordDkim.mdx b/website/docs/commands/ConvertFrom-MailAuthenticationRecordDkim.mdx
@@ -27,17 +27,19 @@ Adapted from:
 - https://github.com/cisagov/ScubaGear/blob/main/PowerShell/ScubaGear/Modules/Providers/ExportEXOProvider.psm1
 - https://xkln.net/blog/getting-mx-spf-dmarc-dkim-and-smtp-banners-with-powershell/
 - DKIM https://datatracker.ietf.org/doc/html/rfc6376
+```
 record      : v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCPkb8bu8RGWeJGk3hJrouZXIdZ+HTp/azRp8IUOHp5wKvPUAi/54PwuLscUjRk4Rh3hjIkMpKRfJJXPxWbrT7eMLric
-          7f/S0h+qF4aqIiQqHFCDAYfMnN6V3Wbke2U5EGm0H/cAUYkaf2AtuHJ/rdY/EXaldAm00PgT9QQMez66QIDAQAB;
+            7f/S0h+qF4aqIiQqHFCDAYfMnN6V3Wbke2U5EGm0H/cAUYkaf2AtuHJ/rdY/EXaldAm00PgT9QQMez66QIDAQAB;
 keyType     : rsa
-hash        : \{sha1, sha256\}
+hash        : {sha1, sha256}
 notes       :
 publicKey   : MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCPkb8bu8RGWeJGk3hJrouZXIdZ+HTp/azRp8IUOHp5wKvPUAi/54PwuLscUjRk4Rh3hjIkMpKRfJJXPxWbrT7eMLric7f/S0h+qF4aqIiQqHF
-          CDAYfMnN6V3Wbke2U5EGm0H/cAUYkaf2AtuHJ/rdY/EXaldAm00PgT9QQMez66QIDAQAB
+            CDAYfMnN6V3Wbke2U5EGm0H/cAUYkaf2AtuHJ/rdY/EXaldAm00PgT9QQMez66QIDAQAB
 validBase64 : True
-services    : \{*\}
+services    : {*}
 flags       :
 warnings    :
+```
 
 ## EXAMPLES
 
@@ -53,7 +55,7 @@ Returns [DKIMRecord] or "Failure to obtain record"
 
 ### -DomainName
 
-\{\{ Fill DomainName Description \}\}
+Domain name to check.
 
 ```yaml
 Type: String
@@ -69,7 +71,7 @@ Accept wildcard characters: False
 
 ### -DnsServerIpAddress
 
-\{\{ Fill DnsServerIpAddress Description \}\}
+DNS-server to use for lookup.
 
 ```yaml
 Type: IPAddress
@@ -85,7 +87,7 @@ Accept wildcard characters: False
 
 ### -DkimSelector
 
-\{\{ Fill DkimSelector Description \}\}
+Selector-name for the DKIM record to retrieve.
 
 ```yaml
 Type: String
@@ -101,7 +103,7 @@ Accept wildcard characters: False
 
 ### -QuickTimeout
 
-\{\{ Fill QuickTimeout Description \}\}
+Use a shorter timeout value for the DNS lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -117,7 +119,7 @@ Accept wildcard characters: False
 
 ### -NoHostsFile
 
-\{\{ Fill NoHostsFile Description \}\}
+Ignore hosts file for domain lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -161,3 +163,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordDkim](https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordDkim)
diff --git a/website/docs/commands/ConvertFrom-MailAuthenticationRecordDmarc.mdx b/website/docs/commands/ConvertFrom-MailAuthenticationRecordDmarc.mdx
@@ -27,21 +27,23 @@ Adapted from:
 - https://xkln.net/blog/getting-mx-spf-dmarc-dkim-and-smtp-banners-with-powershell/
 - DMARC https://datatracker.ietf.org/doc/html/rfc7489
 
+```
 record               : v=DMARC1; p=reject; pct=100; rua=mailto:itex-rua@microsoft.com; ruf=mailto:itex-ruf@microsoft.com; fo=1
 valid                : True
 policy               : reject
 policySubdomain      :
 percentage           : 100
-reportAggregate      : \{DMARCRecordUri\}
-reportForensic       : \{DMARCRecordUri\}
-reportFailure        : \{1\}
-reportFailureFormats : \{afrf\}
+reportAggregate      : {DMARCRecordUri}
+reportForensic       : {DMARCRecordUri}
+reportFailure        : {1}
+reportFailureFormats : {afrf}
 reportFrequency      : 86400
 alignmentDkim        : r
 alignmentSpf         : r
 version              : DMARC1
-warnings             : \{sp: No subdomain policy set, adkim: No DKIM alignment set, defaults to relaxed, aspf: No SPF alignment set, defaults to relaxed, ri: No
-                   report interval set, defaults to 86400 seconds…\}
+warnings             : {sp: No subdomain policy set, adkim: No DKIM alignment set, defaults to relaxed, aspf: No SPF alignment set, defaults to relaxed, ri: No
+                    report interval set, defaults to 86400 seconds…}
+```
 
 ## EXAMPLES
 
@@ -57,7 +59,7 @@ Returns [DMARCRecord] or "Failure to obtain record"
 
 ### -DomainName
 
-\{\{ Fill DomainName Description \}\}
+Domain name to check.
 
 ```yaml
 Type: String
@@ -73,7 +75,7 @@ Accept wildcard characters: False
 
 ### -DnsServerIpAddress
 
-\{\{ Fill DnsServerIpAddress Description \}\}
+DNS-server to use for lookup.
 
 ```yaml
 Type: IPAddress
@@ -89,7 +91,7 @@ Accept wildcard characters: False
 
 ### -QuickTimeout
 
-\{\{ Fill QuickTimeout Description \}\}
+Use a shorter timeout value for the DNS lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -105,7 +107,7 @@ Accept wildcard characters: False
 
 ### -NoHostsFile
 
-\{\{ Fill NoHostsFile Description \}\}
+Ignore hosts file for domain lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -149,3 +151,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordDmarc](https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordDmarc)
diff --git a/website/docs/commands/ConvertFrom-MailAuthenticationRecordMx.mdx b/website/docs/commands/ConvertFrom-MailAuthenticationRecordMx.mdx
@@ -21,9 +21,11 @@ ConvertFrom-MailAuthenticationRecordMx [-DomainName] <String> [[-DnsServerIpAddr
 
 ## DESCRIPTION
 
+```
 Name                                     Type   TTL   Section    NameExchange                              Preference
 ----                                     ----   ---   -------    ------------                              ----------
 microsoft.com                            MX     1731  Answer     microsoft-com.mail.protection.outlook.com 10
+```
 
 ## EXAMPLES
 
@@ -39,7 +41,7 @@ Returns MX records or "Failure to obtain record"
 
 ### -DomainName
 
-\{\{ Fill DomainName Description \}\}
+Domain name to check.
 
 ```yaml
 Type: String
@@ -55,7 +57,7 @@ Accept wildcard characters: False
 
 ### -DnsServerIpAddress
 
-\{\{ Fill DnsServerIpAddress Description \}\}
+DNS-server to use for lookup.
 
 ```yaml
 Type: IPAddress
@@ -71,7 +73,7 @@ Accept wildcard characters: False
 
 ### -QuickTimeout
 
-\{\{ Fill QuickTimeout Description \}\}
+Use a shorter timeout value for the DNS lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -87,7 +89,7 @@ Accept wildcard characters: False
 
 ### -NoHostsFile
 
-\{\{ Fill NoHostsFile Description \}\}
+Ignore hosts file for domain lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -131,3 +133,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordMx](https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordMx)
diff --git a/website/docs/commands/ConvertFrom-MailAuthenticationRecordSpf.mdx b/website/docs/commands/ConvertFrom-MailAuthenticationRecordSpf.mdx
@@ -27,10 +27,12 @@ Adapted from:
 - https://xkln.net/blog/getting-mx-spf-dmarc-dkim-and-smtp-banners-with-powershell/
 - SPF https://datatracker.ietf.org/doc/html/rfc7208
 
+```
 record   : v=spf1 include:_spf-a.microsoft.com include:_spf-b.microsoft.com include:_spf-c.microsoft.com include:_spf-ssg-a.msft.net include:spf-a.hotmail.com
-       include:_spf1-meo.microsoft.com -all
-terms    : \{SPFRecordTerm, SPFRecordTerm, SPFRecordTerm, SPFRecordTerm…\}
+        include:_spf1-meo.microsoft.com -all
+terms    : {SPFRecordTerm, SPFRecordTerm, SPFRecordTerm, SPFRecordTerm…}
 warnings :
+```
 
 ## EXAMPLES
 
@@ -46,7 +48,7 @@ Returns [SPFRecord] object or "Failure to obtain record"
 
 ### -DomainName
 
-\{\{ Fill DomainName Description \}\}
+Domain name to check.
 
 ```yaml
 Type: String
@@ -62,7 +64,7 @@ Accept wildcard characters: False
 
 ### -DnsServerIpAddress
 
-\{\{ Fill DnsServerIpAddress Description \}\}
+DNS-server to use for lookup.
 
 ```yaml
 Type: IPAddress
@@ -78,7 +80,7 @@ Accept wildcard characters: False
 
 ### -QuickTimeout
 
-\{\{ Fill QuickTimeout Description \}\}
+Use a shorter timeout value for the DNS lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -94,7 +96,7 @@ Accept wildcard characters: False
 
 ### -NoHostsFile
 
-\{\{ Fill NoHostsFile Description \}\}
+Ignore hosts file for domain lookup.
 
 ```yaml
 Type: SwitchParameter
@@ -138,3 +140,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordSpf](https://maester.dev/docs/commands/ConvertFrom-MailAuthenticationRecordSpf)
diff --git a/website/docs/commands/Disconnect-Maester.mdx b/website/docs/commands/Disconnect-Maester.mdx
@@ -77,3 +77,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[https://maester.dev/docs/commands/Disconnect-Maester](https://maester.dev/docs/commands/Disconnect-Maester)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -64,3 +64,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
		## NOTES

		## RELATED LINKS

		[https://maester.dev/docs/commands/Clear-MtDnsCache](https://maester.dev/docs/commands/Clear-MtDnsCache)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -252,3 +252,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
		## NOTES

		## RELATED LINKS

		[https://maester.dev/docs/commands/Connect-Maester](https://maester.dev/docs/commands/Connect-Maester)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,3 +77,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
		## NOTES

		## RELATED LINKS

		[https://maester.dev/docs/commands/Disconnect-Maester](https://maester.dev/docs/commands/Disconnect-Maester)