From ea9dbc9b8242f187f249114f84d53cc2f0277d32 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 28 Jun 2023 13:28:34 -0500 Subject: [PATCH 1/3] Update freshness --- .../docs-conceptual/Crescendo/advanced/handling-errors.md | 4 ++-- .../Crescendo/advanced/transforming-arguments.md | 4 ++-- .../Crescendo/advanced/using-crescendo-cmdlets.md | 2 +- .../Crescendo/get-started/choose-command-line-tool.md | 2 +- .../Crescendo/get-started/create-new-cmdlet.md | 2 +- .../docs-conceptual/Crescendo/get-started/generate-module.md | 2 +- .../Crescendo/get-started/install-crescendo.md | 2 +- .../docs-conceptual/Crescendo/get-started/research-tool.md | 2 +- reference/docs-conceptual/Crescendo/overview.md | 2 +- .../Crescendo/whats-new/whats-new-in-crescendo-11.md | 4 ++-- .../PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | 2 +- .../Rules/AvoidAssignmentToAutomaticVariable.md | 2 +- .../Rules/AvoidDefaultValueForMandatoryParameter.md | 2 +- .../Rules/AvoidDefaultValueSwitchParameter.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidGlobalAliases.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md | 2 +- .../Rules/AvoidNullOrEmptyHelpMessageAttribute.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md | 2 +- .../Rules/AvoidSemicolonsAsLineTerminators.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md | 2 +- .../Rules/AvoidUsingConvertToSecureStringWithPlainText.md | 2 +- .../Rules/AvoidUsingDeprecatedManifestFields.md | 2 +- .../Rules/AvoidUsingDoubleQuotesForConstantString.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md | 2 +- .../Rules/AvoidUsingUsernameAndPasswordParams.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md | 2 +- .../PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md | 2 +- .../PSScriptAnalyzer/Rules/DSCDscTestsPresent.md | 2 +- .../Rules/DSCReturnCorrectTypesForDSCFunctions.md | 2 +- .../Rules/DSCStandardDSCFunctionsInResource.md | 2 +- .../Rules/DSCUseIdenticalMandatoryParametersForDSC.md | 2 +- .../PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md | 2 +- .../Rules/DSCUseVerboseMessageInDSCResource.md | 2 +- .../PSScriptAnalyzer/Rules/MisleadingBacktick.md | 2 +- .../PSScriptAnalyzer/Rules/MissingModuleManifestField.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md | 2 +- .../Rules/PossibleIncorrectComparisonWithNull.md | 2 +- .../Rules/PossibleIncorrectUsageOfAssignmentOperator.md | 2 +- .../Rules/PossibleIncorrectUsageOfRedirectionOperator.md | 2 +- .../PSScriptAnalyzer/Rules/ProvideCommentHelp.md | 2 +- reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | 2 +- .../PSScriptAnalyzer/Rules/ReservedCmdletChar.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md | 2 +- .../PSScriptAnalyzer/Rules/ReviewUnusedParameter.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md | 2 +- .../PSScriptAnalyzer/Rules/UseApprovedVerbs.md | 2 +- .../PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md | 2 +- .../PSScriptAnalyzer/Rules/UseCmdletCorrectly.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleCommands.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleSyntax.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleTypes.md | 2 +- .../PSScriptAnalyzer/Rules/UseConsistentIndentation.md | 2 +- .../PSScriptAnalyzer/Rules/UseConsistentWhitespace.md | 2 +- .../PSScriptAnalyzer/Rules/UseCorrectCasing.md | 2 +- .../Rules/UseDeclaredVarsMoreThanAssignments.md | 2 +- .../Rules/UseLiteralInitializerForHashtable.md | 2 +- .../PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md | 2 +- .../PSScriptAnalyzer/Rules/UsePSCredentialType.md | 2 +- .../Rules/UseProcessBlockForPipelineCommand.md | 2 +- .../Rules/UseShouldProcessForStateChangingFunctions.md | 2 +- .../PSScriptAnalyzer/Rules/UseSingularNouns.md | 2 +- .../PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md | 2 +- .../PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md | 2 +- .../PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md | 2 +- .../Rules/UseUsingScopeModifierInNewRunspaces.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/create-custom-rule.md | 2 +- reference/docs-conceptual/PSScriptAnalyzer/overview.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/rules-recommendations.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md | 2 +- .../docs-conceptual/PlatyPS/create-help-using-platyps.md | 2 +- reference/docs-conceptual/PlatyPS/overview.md | 2 +- .../get-started/understanding-secretmanagement.md | 2 +- .../SecretManagement/get-started/using-secretstore.md | 2 +- .../SecretManagement/how-to/manage-secretstore.md | 2 +- .../SecretManagement/how-to/using-azure-keyvault.md | 4 ++-- .../SecretManagement/how-to/using-secrets-in-automation.md | 2 +- reference/docs-conceptual/SecretManagement/overview.md | 2 +- .../docs-conceptual/SecretManagement/security-concepts.md | 2 +- reference/docs-conceptual/overview.md | 4 ++-- 93 files changed, 98 insertions(+), 98 deletions(-) diff --git a/reference/docs-conceptual/Crescendo/advanced/handling-errors.md b/reference/docs-conceptual/Crescendo/advanced/handling-errors.md index a079f89..34f2bac 100644 --- a/reference/docs-conceptual/Crescendo/advanced/handling-errors.md +++ b/reference/docs-conceptual/Crescendo/advanced/handling-errors.md @@ -1,7 +1,7 @@ --- -title: Handling errors in Crescendo description: This article describes how to handle native command errors in your Crescendo output handler. -ms.date: 04/06/2023 +ms.date: 06/28/2023 +title: Handling errors in Crescendo --- # Handling errors in Crescendo diff --git a/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md b/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md index 9a40cad..c9a9e65 100644 --- a/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md +++ b/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md @@ -1,7 +1,7 @@ --- -title: Transforming arguments in Crescendo description: This article describes how to transform arguments from the input format to the format needed by the native command. -ms.date: 04/06/2023 +ms.date: 06/28/2023 +title: Transforming arguments in Crescendo --- # Transforming arguments in Crescendo diff --git a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md index 9f3fb91..69476f0 100644 --- a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md +++ b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md @@ -1,6 +1,6 @@ --- description: This article provides examples for using the Crescendo cmdlets to create a configuration. This can be used as an alternate for manually created the JSON configuration file. -ms.date: 12/14/2022 +ms.date: 06/28/2023 title: Create a Crescendo configuration using the Crescendo cmdlets --- # Create a Crescendo configuration using the Crescendo cmdlets diff --git a/reference/docs-conceptual/Crescendo/get-started/choose-command-line-tool.md b/reference/docs-conceptual/Crescendo/get-started/choose-command-line-tool.md index 4a0eb1b..e4db4ec 100644 --- a/reference/docs-conceptual/Crescendo/get-started/choose-command-line-tool.md +++ b/reference/docs-conceptual/Crescendo/get-started/choose-command-line-tool.md @@ -1,6 +1,6 @@ --- description: How to select a command-line tool to amplify using Crescendo. -ms.date: 03/08/2022 +ms.date: 06/28/2023 title: Choosing a command-line tool to amplify --- # Choosing the command-line tool for Crescendo diff --git a/reference/docs-conceptual/Crescendo/get-started/create-new-cmdlet.md b/reference/docs-conceptual/Crescendo/get-started/create-new-cmdlet.md index bf08a11..a018b77 100644 --- a/reference/docs-conceptual/Crescendo/get-started/create-new-cmdlet.md +++ b/reference/docs-conceptual/Crescendo/get-started/create-new-cmdlet.md @@ -1,6 +1,6 @@ --- description: How to create a Crescendo cmdlet. -ms.date: 12/14/2022 +ms.date: 06/28/2023 title: Create a Crescendo cmdlet --- # Create a Crescendo cmdlet diff --git a/reference/docs-conceptual/Crescendo/get-started/generate-module.md b/reference/docs-conceptual/Crescendo/get-started/generate-module.md index a5b29e3..1ca0033 100644 --- a/reference/docs-conceptual/Crescendo/get-started/generate-module.md +++ b/reference/docs-conceptual/Crescendo/get-started/generate-module.md @@ -1,6 +1,6 @@ --- description: How to generate a Crescendo module from a configuration. -ms.date: 03/09/2022 +ms.date: 06/28/2023 title: Generate and test a Crescendo module --- # Generate and test a Crescendo module diff --git a/reference/docs-conceptual/Crescendo/get-started/install-crescendo.md b/reference/docs-conceptual/Crescendo/get-started/install-crescendo.md index afb2e4d..b2e93ae 100644 --- a/reference/docs-conceptual/Crescendo/get-started/install-crescendo.md +++ b/reference/docs-conceptual/Crescendo/get-started/install-crescendo.md @@ -1,6 +1,6 @@ --- description: How to install the Crescendo module. -ms.date: 03/12/2022 +ms.date: 06/28/2023 title: Installing Crescendo --- # Install the Crescendo module diff --git a/reference/docs-conceptual/Crescendo/get-started/research-tool.md b/reference/docs-conceptual/Crescendo/get-started/research-tool.md index 35403f5..b88ee99 100644 --- a/reference/docs-conceptual/Crescendo/get-started/research-tool.md +++ b/reference/docs-conceptual/Crescendo/get-started/research-tool.md @@ -1,6 +1,6 @@ --- description: How to collect information about the command-line tool to decide which features to implement in your cmdlets. -ms.date: 03/07/2022 +ms.date: 06/28/2023 title: Research the command-line tool's syntax and output --- # Research the command-line tool's syntax and output diff --git a/reference/docs-conceptual/Crescendo/overview.md b/reference/docs-conceptual/Crescendo/overview.md index a5c9725..3a19374 100644 --- a/reference/docs-conceptual/Crescendo/overview.md +++ b/reference/docs-conceptual/Crescendo/overview.md @@ -1,6 +1,6 @@ --- description: Overview of the Crescendo module -ms.date: 03/07/2022 +ms.date: 06/28/2023 title: Crescendo overview --- # Microsoft.PowerShell.Crescendo overview diff --git a/reference/docs-conceptual/Crescendo/whats-new/whats-new-in-crescendo-11.md b/reference/docs-conceptual/Crescendo/whats-new/whats-new-in-crescendo-11.md index 3e996b2..52cbfee 100644 --- a/reference/docs-conceptual/Crescendo/whats-new/whats-new-in-crescendo-11.md +++ b/reference/docs-conceptual/Crescendo/whats-new/whats-new-in-crescendo-11.md @@ -1,7 +1,7 @@ --- -title: What's new in Crescendo 1.1 description: New features and changes released in Crescendo 1.1 -ms.date: 04/05/2023 +ms.date: 06/28/2023 +title: What's new in Crescendo 1.1 --- # What's new in Crescendo 1.1 diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md index 1a3b742..21d5cfb 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md @@ -1,7 +1,7 @@ --- description: Align assignment statement ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AlignAssignmentStatement --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md index 6e51795..7a978e3 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md @@ -1,7 +1,7 @@ --- description: Changing automatic variables might have undesired side effects ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidAssignmentToAutomaticVariable --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md index 8ad74a1..71a8260 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md @@ -1,7 +1,7 @@ --- description: Avoid Default Value For Mandatory Parameter ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidDefaultValueForMandatoryParameter --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md index 8a79762..f08ac77 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md @@ -1,7 +1,7 @@ --- description: Switch Parameters Should Not Default To True ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidDefaultValueSwitchParameter --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md index 8ceeeaf..9b94631 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md @@ -1,7 +1,7 @@ --- description: Avoid global aliases. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidGlobalAliases --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md index 86870b3..cf4ee8f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md @@ -1,7 +1,7 @@ --- description: Avoid global functions and aliases ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidGlobalFunctions --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md index 0927c2b..54da524 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md @@ -1,7 +1,7 @@ --- description: No Global Variables ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidGlobalVars --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md index 1d5324c..88665f1 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md @@ -1,7 +1,7 @@ --- description: Avoid Invoking Empty Members ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidInvokingEmptyMembers --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md index edc5e30..eab82ad 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md @@ -1,7 +1,7 @@ --- description: Avoid long lines ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidLongLines --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md index 03b6af8..5e5dbea 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md @@ -1,7 +1,7 @@ --- description: Avoid multiple type specifiers on parameters. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidMultipleTypeAttributes --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md index fa94592..4ba4d8e 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md @@ -1,7 +1,7 @@ --- description: Avoid using null or empty HelpMessage parameter attribute. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidNullOrEmptyHelpMessageAttribute --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md index e579694..7ac9345 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md @@ -1,7 +1,7 @@ --- description: Avoid overwriting built in cmdlets ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidOverwritingBuiltInCmdlets --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md index 65fa0d9..0a49667 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md @@ -1,7 +1,7 @@ --- description: Avoid semicolons as line terminators ms.custom: PSSA v1.21.0 -ms.date: 06/15/2022 +ms.date: 06/28/2023 ms.topic: reference title: AvoidSemicolonsAsLineTerminators --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md index 36f5d60..1ffd4ed 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md @@ -1,7 +1,7 @@ --- description: Avoid Using ShouldContinue Without Boolean Force Parameter ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidShouldContinueWithoutForce --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md index 1decf9a..2067cee 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md @@ -1,7 +1,7 @@ --- description: Avoid trailing whitespace ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidTrailingWhitespace --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md index 83b7592..52510a5 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md @@ -1,7 +1,7 @@ --- description: Avoid using broken hash algorithms ms.custom: PSSA v1.21.0 -ms.date: 05/31/2022 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingBrokenHashAlgorithms --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md index a2c2b01..87c13b3 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md @@ -1,7 +1,7 @@ --- description: Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingCmdletAliases --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md index f6374a3..6ff30b5 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md @@ -1,7 +1,7 @@ --- description: Avoid Using ComputerName Hardcoded ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingComputerNameHardcoded --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md index 7e40882..3c651a4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md @@ -1,7 +1,7 @@ --- description: Avoid Using SecureString With Plain Text ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingConvertToSecureStringWithPlainText --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md index 9c64d6a..bac27c0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md @@ -1,7 +1,7 @@ --- description: Avoid Using Deprecated Manifest Fields ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingDeprecatedManifestFields --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md index 464f1c0..ab732fc 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md @@ -1,7 +1,7 @@ --- description: Avoid using double quotes if the string is constant. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingDoubleQuotesForConstantString --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md index 16e5ea5..0d0749f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md @@ -1,7 +1,7 @@ --- description: Avoid Using Empty Catch Block ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingEmptyCatchBlock --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md index eb51e2e..de35d16 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md @@ -1,7 +1,7 @@ --- description: Avoid Using Invoke-Expression ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingInvokeExpression --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md index 6f6ba04..2d53fbb 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md @@ -1,7 +1,7 @@ --- description: Avoid Using Plain Text For Password Parameter ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingPlainTextForPassword --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md index 4cecb29..6373e11 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md @@ -1,7 +1,7 @@ --- description: Avoid Using Positional Parameters ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingPositionalParameters --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md index cb8a6cf..f7c634f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md @@ -1,7 +1,7 @@ --- description: Avoid Using Username and Password Parameters ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingUsernameAndPasswordParams --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md index 3e81b64..ffb46b9 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md @@ -1,7 +1,7 @@ --- description: Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod, Register-WmiEvent, Set-WmiInstance ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingWMICmdlet --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md index e04d4f9..31396af 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md @@ -1,7 +1,7 @@ --- description: Avoid Using Write-Host ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: AvoidUsingWriteHost --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md index 084eb55..a4ab2c7 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md @@ -1,7 +1,7 @@ --- description: DSC examples are present ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCDscExamplesPresent --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md index 583a805..f96ecbc 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md @@ -1,7 +1,7 @@ --- description: Dsc tests are present ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCDscTestsPresent --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md index 2b92d98..2b0a4e0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md @@ -1,7 +1,7 @@ --- description: Return Correct Types For DSC Functions ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCReturnCorrectTypesForDSCFunctions --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md index 843f2d6..9fbc2c6 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md @@ -1,7 +1,7 @@ --- description: Use Standard Get/Set/Test TargetResource functions in DSC Resource ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCStandardDSCFunctionsInResource --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md index 5f6f021..65a6127 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md @@ -1,7 +1,7 @@ --- description: Use identical mandatory parameters for DSC Get/Test/Set TargetResource functions ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCUseIdenticalMandatoryParametersForDSC --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md index 35d3bb4..ea72db0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md @@ -1,7 +1,7 @@ --- description: Use Identical Parameters For DSC Test and Set Functions ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCUseIdenticalParametersForDSC --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md index e8e4c72..0af52de 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md @@ -1,7 +1,7 @@ --- description: Use verbose message in DSC resource ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: DSCUseVerboseMessageInDSCResource --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md index 3f89503..02ec622 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md @@ -1,7 +1,7 @@ --- description: Misleading Backtick ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: MisleadingBacktick --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md index d72f09e..a508e71 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md @@ -1,7 +1,7 @@ --- description: Module Manifest Fields ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: MissingModuleManifestField --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md index 8c3ef3f..11eefc9 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md @@ -1,7 +1,7 @@ --- description: Place close braces ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: PlaceCloseBrace --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md index 876c251..b3e48e0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md @@ -1,7 +1,7 @@ --- description: Place open braces consistently ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: PlaceOpenBrace --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md index fbeed73..1c9ea8d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md @@ -1,7 +1,7 @@ --- description: Null Comparison ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: PossibleIncorrectComparisonWithNull --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md index 5737b53..7981512 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md @@ -1,7 +1,7 @@ --- description: Equal sign is not an assignment operator. Did you mean the equality operator \'-eq\'? ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: PossibleIncorrectUsageOfAssignmentOperator --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md index 9956b92..759252c 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md @@ -1,7 +1,7 @@ --- description: \'>\' is not a comparison operator. Use \'-gt\' (greater than) or \'-ge\' (greater or equal). ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: PossibleIncorrectUsageOfRedirectionOperator --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md index 205142e..1fc23c1 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md @@ -1,7 +1,7 @@ --- description: Basic Comment Help ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: ProvideCommentHelp --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md index 44062d7..4f8a0b4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md @@ -1,7 +1,7 @@ --- description: List of PSScriptAnalyzer rules ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: List of PSScriptAnalyzer rules --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md index fc9dc64..2fc57ca 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md @@ -1,7 +1,7 @@ --- description: Reserved Cmdlet Chars ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: ReservedCmdletChar --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md index 768b660..965881d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md @@ -1,7 +1,7 @@ --- description: Reserved Parameters ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: ReservedParams --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md index 309bcd4..2408c55 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md @@ -1,7 +1,7 @@ --- description: ReviewUnusedParameter ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: ReviewUnusedParameter --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md index 84709d2..26ac188 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md @@ -1,7 +1,7 @@ --- description: Should Process ms.custom: PSSA v1.21.0 -ms.date: 03/24/2022 +ms.date: 06/28/2023 ms.topic: reference title: ShouldProcess --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md index 05afabd..9519656 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md @@ -1,7 +1,7 @@ --- description: Cmdlet Verbs ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseApprovedVerbs --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md index 1c4c0f4..1181587 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md @@ -1,7 +1,7 @@ --- description: Use BOM encoding for non-ASCII files ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseBOMForUnicodeEncodedFile --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md index 158dade..205c6a9 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md @@ -1,7 +1,7 @@ --- description: Use Cmdlet Correctly ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCmdletCorrectly --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md index 0dcfb22..93be36a 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md @@ -1,7 +1,7 @@ --- description: Use compatible cmdlets ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCompatibleCmdlets --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md index 7799563..1fb47ea 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md @@ -1,7 +1,7 @@ --- description: Use compatible commands ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCompatibleCommands --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md index ce93d26..71974b6 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md @@ -1,7 +1,7 @@ --- description: Use compatible syntax ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCompatibleSyntax --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md index 8366079..8917ef5 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md @@ -1,7 +1,7 @@ --- description: Use compatible types ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCompatibleTypes --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md index de5979f..f9b5d2d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md @@ -1,7 +1,7 @@ --- description: Use consistent indentation ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseConsistentIndentation --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md index 3438c60..7611929 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md @@ -1,7 +1,7 @@ --- description: Use whitespaces ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseConsistentWhitespace --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md index 8d8dd28..7fa3cc5 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md @@ -1,7 +1,7 @@ --- description: Use exact casing of cmdlet/function/parameter name. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseCorrectCasing --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseDeclaredVarsMoreThanAssignments.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseDeclaredVarsMoreThanAssignments.md index 2c37e4e..080fbb6 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseDeclaredVarsMoreThanAssignments.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseDeclaredVarsMoreThanAssignments.md @@ -1,7 +1,7 @@ --- description: Extra Variables ms.custom: PSSA v1.21.0 -ms.date: 06/30/2022 +ms.date: 06/28/2023 ms.topic: reference title: UseDeclaredVarsMoreThanAssignments --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md index d7ff68f..31462c7 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md @@ -1,7 +1,7 @@ --- description: Create hashtables with literal initializers ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseLiteralInitializerForHashtable --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md index ee531d1..b4fdc23 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md @@ -1,7 +1,7 @@ --- description: Use OutputType Correctly ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseOutputTypeCorrectly --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md index 85e7ed2..79e1a19 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md @@ -1,7 +1,7 @@ --- description: Use PSCredential type. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UsePSCredentialType --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md index 3bb5d2f..bcf11a8 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md @@ -1,7 +1,7 @@ --- description: Use process block for command that accepts input from pipeline. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseProcessBlockForPipelineCommand --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md index 84f79bb..45017db 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md @@ -1,7 +1,7 @@ --- description: Use ShouldProcess For State Changing Functions ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseShouldProcessForStateChangingFunctions --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md index 9dc24a0..4e7576b 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md @@ -1,7 +1,7 @@ --- description: Cmdlet Singular Noun ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseSingularNouns --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md index 1c34263..9d894b8 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md @@ -1,7 +1,7 @@ --- description: Use SupportsShouldProcess ms.custom: PSSA v1.21.0 -ms.date: 12/06/2022 +ms.date: 06/28/2023 ms.topic: reference title: UseSupportsShouldProcess --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md index 9b3bbaa..dcbf890 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md @@ -1,7 +1,7 @@ --- description: Use the *ToExport module manifest fields. ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseToExportFieldsInManifest --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md index 9452d2b..56b6f00 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md @@ -1,7 +1,7 @@ --- description: Use UTF8 Encoding For Help File ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseUTF8EncodingForHelpFile --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md index b17a471..8772531 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md @@ -1,7 +1,7 @@ --- description: Use 'Using:' scope modifier in RunSpace ScriptBlocks ms.custom: PSSA v1.21.0 -ms.date: 10/18/2021 +ms.date: 06/28/2023 ms.topic: reference title: UseUsingScopeModifierInNewRunspaces --- diff --git a/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md b/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md index bd64b0f..4e0867b 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md @@ -1,6 +1,6 @@ --- description: This article provides a basic guide for creating your own customized rules. -ms.date: 03/22/2022 +ms.date: 06/28/2023 title: Creating custom rules --- # Creating custom rules diff --git a/reference/docs-conceptual/PSScriptAnalyzer/overview.md b/reference/docs-conceptual/PSScriptAnalyzer/overview.md index f0affa4..af30317 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/overview.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/overview.md @@ -1,6 +1,6 @@ --- description: This article explains the purpose of the PSScriptAnalyzer module. -ms.date: 10/18/2021 +ms.date: 06/28/2023 title: PSScriptAnalyzer module --- # PSScriptAnalyzer module diff --git a/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md b/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md index b7e2ed4..2e581df 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md @@ -1,6 +1,6 @@ --- description: This article lists best-practice recommendations and the rules associated with them. -ms.date: 03/22/2022 +ms.date: 06/28/2023 title: PSScriptAnalyzer rules and recommendations --- # PSScriptAnalyzer rules and recommendations diff --git a/reference/docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md b/reference/docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md index 40995f5..12d1850 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md @@ -1,6 +1,6 @@ --- description: This article describes various features of PSScriptAnalyzer and how to use them. -ms.date: 03/22/2022 +ms.date: 06/28/2023 title: Using PSScriptAnalyzer --- # Using PSScriptAnalyzer diff --git a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md index ba74c97..4988251 100644 --- a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md +++ b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md @@ -1,6 +1,6 @@ --- description: Using PlatyPS is the fast and efficient way to create XML-based help. -ms.date: 03/22/2022 +ms.date: 06/28/2023 title: Create XML-based help using PlatyPS --- # Create XML-based help using PlatyPS diff --git a/reference/docs-conceptual/PlatyPS/overview.md b/reference/docs-conceptual/PlatyPS/overview.md index 8156aa0..1f9fbc9 100644 --- a/reference/docs-conceptual/PlatyPS/overview.md +++ b/reference/docs-conceptual/PlatyPS/overview.md @@ -1,6 +1,6 @@ --- description: Overview of the PlatyPS module -ms.date: 01/21/2022 +ms.date: 06/28/2023 title: PlatyPS overview --- # PlatyPS overview diff --git a/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md b/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md index 7f9bf66..e57c634 100644 --- a/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md +++ b/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md @@ -1,6 +1,6 @@ --- description: Explains concepts and usage of the SecretManagement module -ms.date: 05/24/2022 +ms.date: 06/28/2023 title: Understanding the SecretManagement module --- # Understanding the SecretManagement module diff --git a/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md b/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md index 4563ca4..0321527 100644 --- a/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md +++ b/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md @@ -1,6 +1,6 @@ --- description: How to install and use the SecretManagement and SecretStore modules -ms.date: 05/24/2022 +ms.date: 06/28/2023 title: Get started with the SecretStore module --- # Get started with the SecretStore module diff --git a/reference/docs-conceptual/SecretManagement/how-to/manage-secretstore.md b/reference/docs-conceptual/SecretManagement/how-to/manage-secretstore.md index 79bf8cd..5ee5318 100644 --- a/reference/docs-conceptual/SecretManagement/how-to/manage-secretstore.md +++ b/reference/docs-conceptual/SecretManagement/how-to/manage-secretstore.md @@ -1,6 +1,6 @@ --- description: Explains how to manage a local SecretStore vault -ms.date: 05/24/2022 +ms.date: 06/28/2023 title: Managing a SecretStore vault --- # Managing a SecretStore vault diff --git a/reference/docs-conceptual/SecretManagement/how-to/using-azure-keyvault.md b/reference/docs-conceptual/SecretManagement/how-to/using-azure-keyvault.md index 91b3bf3..5f30c1f 100644 --- a/reference/docs-conceptual/SecretManagement/how-to/using-azure-keyvault.md +++ b/reference/docs-conceptual/SecretManagement/how-to/using-azure-keyvault.md @@ -1,6 +1,6 @@ --- description: This article explains how to use an Azure Key Vault module, as a SecretManagement extension vault, in an automation scenario to securely retrieve and use passwords or other secret material. -ms.date: 06/24/2022 +ms.date: 06/28/2023 title: Using Azure Key Vault in automation --- # Using Azure Key Vault in automation @@ -46,4 +46,4 @@ and remove secrets with `Remove-Secret`. [azkv-quick]: /azure/key-vault/keys/quick-create-powershell -[Az.KeyVault]: https://www.powershellgallery.com/packages/Az.KeyVault \ No newline at end of file +[Az.KeyVault]: https://www.powershellgallery.com/packages/Az.KeyVault diff --git a/reference/docs-conceptual/SecretManagement/how-to/using-secrets-in-automation.md b/reference/docs-conceptual/SecretManagement/how-to/using-secrets-in-automation.md index a9a41e7..b07614e 100644 --- a/reference/docs-conceptual/SecretManagement/how-to/using-secrets-in-automation.md +++ b/reference/docs-conceptual/SecretManagement/how-to/using-secrets-in-automation.md @@ -1,6 +1,6 @@ --- description: This article explains how to use a SecretStore vault in an automation scenario to securely retrieve an use passwords or other secret material. -ms.date: 06/24/2022 +ms.date: 06/28/2023 title: Using the SecretStore in automation --- # Using the SecretStore in automation diff --git a/reference/docs-conceptual/SecretManagement/overview.md b/reference/docs-conceptual/SecretManagement/overview.md index 3d58318..3e3321e 100644 --- a/reference/docs-conceptual/SecretManagement/overview.md +++ b/reference/docs-conceptual/SecretManagement/overview.md @@ -1,6 +1,6 @@ --- description: Overview of the SecretManagement and SecretStore modules -ms.date: 05/24/2022 +ms.date: 06/28/2023 title: Overview of the SecretManagement and SecretStore modules --- # Overview of the SecretManagement and SecretStore modules diff --git a/reference/docs-conceptual/SecretManagement/security-concepts.md b/reference/docs-conceptual/SecretManagement/security-concepts.md index 61a5413..b2f4c98 100644 --- a/reference/docs-conceptual/SecretManagement/security-concepts.md +++ b/reference/docs-conceptual/SecretManagement/security-concepts.md @@ -1,6 +1,6 @@ --- description: This article explains the security of the features of the SecretManagement and SecretStore modules. -ms.date: 06/24/2022 +ms.date: 06/28/2023 title: Understanding the security features of SecretManagement and SecretStore --- # Understanding the security features of SecretManagement and SecretStore diff --git a/reference/docs-conceptual/overview.md b/reference/docs-conceptual/overview.md index cc67202..cd13c39 100644 --- a/reference/docs-conceptual/overview.md +++ b/reference/docs-conceptual/overview.md @@ -1,7 +1,7 @@ --- description: This documentation set contains reference for modules published and maintained by the PowerShell team, but are not part of the PowerShell package. -ms.date: 01/21/2022 -title: PowerShell utility modules +ms.date: 06/28/2023 +title: PowerShell utility modules --- # PowerShell utility modules From f0b69d551e9cf243e971c0ae08beaaec6b1f7268 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 28 Jun 2023 13:51:29 -0500 Subject: [PATCH 2/3] Update freshness --- .../docs-conceptual/Crescendo/overview.md | 17 +- .../PSScriptAnalyzer/create-custom-rule.md | 12 +- .../PSScriptAnalyzer/rules-recommendations.md | 146 ++++++++++-------- .../PlatyPS/create-help-using-platyps.md | 114 +++++++------- .../understanding-secretmanagement.md | 29 ++-- .../get-started/using-secretstore.md | 14 +- .../SecretManagement/overview.md | 42 +++-- reference/docs-conceptual/overview.md | 25 +-- 8 files changed, 222 insertions(+), 177 deletions(-) diff --git a/reference/docs-conceptual/Crescendo/overview.md b/reference/docs-conceptual/Crescendo/overview.md index 3a19374..35dc7a0 100644 --- a/reference/docs-conceptual/Crescendo/overview.md +++ b/reference/docs-conceptual/Crescendo/overview.md @@ -40,14 +40,13 @@ The documentation for Crescendo includes some new terminology. ### The Crescendo configuration file schema When you author a Crescendo configuration file, you're writing JSON. For convenience,validation, and -an improved developer experience, a -[schema file is available][crescendo-schema]. +an improved developer experience, a [schema file is available][01]. -You can review the schema to see the required and optional configuration -settings, their descriptions, and the value types they accept. When you -[author your configuration file in Visual Studio Code][vscode-json], -you get numerous helpful features, including IntelliSense, validation while you -edit, and more. +You can review the schema to see the required and optional configuration settings, their +descriptions, and the value types they accept. When you author your configuration file in +[Visual Studio Code][02], you get numerous helpful features, including IntelliSense, validation +while you edit, and more. -[crescendo-schema]: https://aka.ms/PowerShell/Crescendo/Schemas/2021-11 -[vscode-json]: https://code.visualstudio.com/Docs/languages/json + +[01]: https://aka.ms/PowerShell/Crescendo/Schemas/2021-11 +[02]: https://code.visualstudio.com/Docs/languages/json diff --git a/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md b/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md index 4e0867b..7a83a53 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/create-custom-rule.md @@ -5,8 +5,8 @@ title: Creating custom rules --- # Creating custom rules -PSScriptAnalyzer uses the [Managed Extensibility Framework (MEF)](/dotnet/framework/mef/) to import -all rules defined in the assembly. It can also consume rules written in PowerShell scripts. +PSScriptAnalyzer uses the [Managed Extensibility Framework (MEF)][01] to import all rules defined in +the assembly. It can also consume rules written in PowerShell scripts. When calling `Invoke-ScriptAnalyzer`, users can specify custom rules using the **CustomizedRulePath** parameter. @@ -236,6 +236,8 @@ function Measure-RequiresRunAsAdministrator } ``` -More examples can be found in the -[CommunityAnalyzerRules](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules) -folder on GitHub. +More examples can be found in the [CommunityAnalyzerRules][02] folder on GitHub. + + +[01]: /dotnet/framework/mef/ +[02]: https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules diff --git a/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md b/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md index 2e581df..7d1dd20 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md @@ -9,7 +9,7 @@ The following guidelines come from a combined effort from both the PowerShell te community. The guidelines are organized by type. Within each type there is a list of rules. The rules are grouped by the **Severity** defined in the implementation of the **PSScriptAnalyzer** rule. The severity level labeled as 'TBD' means "To be determined". These are recommendations that -do not currently have rules defined. +don't currently have rules defined. ## Cmdlet Design Rules @@ -19,27 +19,20 @@ No rules defined. ### Severity: Warning -- Use only Approved Verbs [UseApprovedVerbs](Rules/UseApprovedVerbs.md) -- Cmdlets names with unusable characters - [AvoidReservedCharInCmdlet](Rules/ReservedCmdletChar.md) -- Parameter names that cannot be used - [AvoidReservedParams](Rules/ReservedParams.md) -- Support confirmation requests - [UseShouldProcessForStateChangingFunctions](Rules/UseShouldProcessForStateChangingFunctions.md) - and - [UseShouldProcessForStateChangingFunctions](Rules/UseShouldProcessForStateChangingFunctions.md) -- Must call **ShouldProcess** when the **ShouldProcess** attribute is present and vice - versa [UseShouldProcess](Rules/ShouldProcess.md) -- Nouns should be singular - [UseSingularNouns](Rules/UseSingularNouns.md) -- Missing module manifest fields - [MissingModuleManifestField](Rules/MissingModuleManifestField.md) +- Use only Approved Verbs [UseApprovedVerbs][33] +- Cmdlets names with unusable characters [AvoidReservedCharInCmdlet][30] +- Parameter names that can't be used [AvoidReservedParams][31] +- Support confirmation requests [UseShouldProcessForStateChangingFunctions][37] and + [UseShouldProcessForStateChangingFunctions][37] +- Must call **ShouldProcess** when the **ShouldProcess** attribute is present and vice versa + [UseShouldProcess][32] +- Nouns should be singular [UseSingularNouns][38] +- Missing module manifest fields [MissingModuleManifestField][28] - **Version** - **Author** - **Description** - **LicenseUri** (for PowerShell Gallery) -- Switch parameters should not default to true - [AvoidDefaultValueSwitchParameter](Rules/AvoidDefaultValueSwitchParameter.md) +- Switch parameters shouldn't default to true [AvoidDefaultValueSwitchParameter][10] ### Severity: Information @@ -70,24 +63,17 @@ No rules defined. ### Severity: Warning -- Avoid using aliases - [AvoidUsingCmdletAliases](Rules/AvoidUsingCmdletAliases.md) -- Avoid using deprecated WMI cmdlets - [AvoidUsingWMICmdlet](Rules/AvoidUsingWMICmdlet.md) -- Avoid using empty **catch** blocks [AvoidUsingEmptyCatchBlock](Rules/AvoidUsingEmptyCatchBlock.md) -- Invoke existing cmdlets with correct parameters - [UseCmdletCorrectly](Rules/UseCmdletCorrectly.md) +- Avoid using aliases [AvoidUsingCmdletAliases][12] +- Avoid using deprecated WMI cmdlets [AvoidUsingWMICmdlet][20] +- Avoid using empty **catch** blocks [AvoidUsingEmptyCatchBlock][15] +- Invoke existing cmdlets with correct parameters [UseCmdletCorrectly][34] - Cmdlets should have **ShouldProcess**/**ShouldContinue** and **Force** parameter if using certain system-modifying verbs (Update, Set, Remove, New): - [UseShouldProcessForStateChangingFunctions](Rules/UseShouldProcessForStateChangingFunctions.md) -- Avoid using positional parameters - [AvoidUsingPositionalParameters](Rules/AvoidUsingPositionalParameters.md) -- Avoid using global variables - [AvoidGlobalVars](Rules/AvoidGlobalVars.md) -- Declared variables should be used after their assignment - [UseDeclaredVarsMoreThanAssignments](Rules/UseDeclaredVarsMoreThanAssignments.md) -- Avoid using `Invoke-Expression` - [AvoidUsingInvokeExpression](Rules/AvoidUsingInvokeExpression.md) + [UseShouldProcessForStateChangingFunctions][37] +- Avoid using positional parameters [AvoidUsingPositionalParameters][18] +- Avoid using global variables [AvoidGlobalVars][11] +- Declared variables should be used after their assignment [UseDeclaredVarsMoreThanAssignments][35] +- Avoid using `Invoke-Expression` [AvoidUsingInvokeExpression][16] ### Severity: Information @@ -117,12 +103,12 @@ No rules defined. ### Severity: Warning - Avoid using `Write-Host` unless writing to the host is all you want to do - [AvoidUsingWriteHost](Rules/AvoidUsingWriteHost.md) + [AvoidUsingWriteHost][21] ### Severity: Information - Write comment-based help - [ProvideCommentHelp](Rules/ProvideCommentHelp.md) + [ProvideCommentHelp][29] ### Severity: TBD @@ -137,19 +123,18 @@ No rules defined. ### Severity: Error -- Avoid using plain text passwords - [AvoidUsingPlainTextForPassword](Rules/AvoidUsingPlainTextForPassword.md) +- Avoid using plain text passwords [AvoidUsingPlainTextForPassword][17] - Avoid `-Username` and `-Password` parameters (use **PSCredential** instead): - [UsePSCredentialType](Rules/UsePSCredentialType.md) + [UsePSCredentialType][36] - Avoid hardcoding a `-ComputerName` parameter argument (information disclosure): - [AvoidUsingComputerNameHardcoded](Rules/AvoidUsingComputerNameHardcoded.md) + [AvoidUsingComputerNameHardcoded][13] - Avoid using `ConvertTo-SecureString` with plaintext (information disclosure): - [AvoidUsingConvertToSecureStringWithPlainText](Rules/AvoidUsingConvertToSecureStringWithPlainText.md) + [AvoidUsingConvertToSecureStringWithPlainText][14] ### Severity: Warning - Avoid using `$Password = 'string'` (information disclosure). - [AvoidUsingUsernameAndPasswordParams](Rules/AvoidUsingUsernameAndPasswordParams.md) + [AvoidUsingUsernameAndPasswordParams][19] ### Severity: Information @@ -163,12 +148,9 @@ No rules defined. ### Severity: Error -- Use standard DSC methods - [StandardDSCFunctionsInResource](Rules/DSCStandardDSCFunctionsInResource.md) -- Use identical mandatory parameters for all DSC methods - [UseIdenticalMandatoryParametersForDSC](Rules/DSCUseIdenticalMandatoryParametersForDSC.md) -- Use identical parameters for Set and Test DSC methods - [UseIdenticalParametersForDSC](Rules/DSCUseIdenticalParametersForDSC.md) +- Use standard DSC methods [StandardDSCFunctionsInResource][25] +- Use identical mandatory parameters for all DSC methods [UseIdenticalMandatoryParametersForDSC][26] +- Use identical parameters for Set and Test DSC methods [UseIdenticalParametersForDSC][27] ### Severity: Warning @@ -176,32 +158,70 @@ No rules defined. ### Severity: Information -- The following three recommendations are covered by the - [ReturnCorrectTypesForDSCFunctions](Rules/DSCReturnCorrectTypesForDSCFunctions.md) rule +- The following three recommendations are covered by the [ReturnCorrectTypesForDSCFunctions][24] + rule - Avoid returning any object from a `Set-TargetResource` or Set (Class Based) function - Return a Boolean value from a `Test-TargetResource` or Test (Class Based) function - Return an object from a `Get-TargetResource` or Get (Class Based) function -- DSC resources should have DSC tests [DSCTestsPresent](Rules/DSCDscTestsPresent.md) -- DSC resources should have DSC examples [DSCExamplesPresent](Rules/DSCDscExamplesPresent.md) +- DSC resources should have DSC tests [DSCTestsPresent][23] +- DSC resources should have DSC examples [DSCExamplesPresent][22] ### Severity: TBD - For Windows PowerShell v4, resource modules should have a `.psd1` file and `schema.mof` for every resource -- MOFs should have a description for each element - see - [Issue #131](https://github.com/PowerShell/PSScriptAnalyzer/issues/131) +- MOFs should have a description for each element - see [Issue #131][131] - Resource modules should have a `.psd1` file (always) and `schema.mof` (for non-class resource) see - [Issue #116](https://github.com/PowerShell/PSScriptAnalyzer/issues/116) + [Issue #116][116] - Use **ShouldProcess** for a **Set** DSC method -- Resource module contains DscResources folder which contains the resources - see - [Issue #130](https://github.com/PowerShell/PSScriptAnalyzer/issues/130) +- Resource module contains DscResources folder which contains the resources - see [Issue #130][130] ### References -- [Cmdlet Development Guidelines](/powershell/scripting/developer/cmdlet/cmdlet-development-guidelines) -- [PowerShell DSC Resource Design and Testing Checklist](https://devblogs.microsoft.com/powershell/powershell-dsc-resource-design-and-testing-checklist/) +- [Cmdlet Development Guidelines][01] +- [PowerShell DSC Resource Design and Testing Checklist][02] - DSC Guidelines can also be found in the DSC Resources Repository - - [DSC Resource Style Guidelines & Best Practices](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) - - [DSC Resource Naming](https://github.com/PowerShell/DscResources/blob/master/Naming.md) - - [Creating a High Quality DSC Resource Module](https://github.com/PowerShell/DscResources/blob/master/HighQualityModuleGuidelines.md) -- [The Unofficial PowerShell Best Practices and Style Guide](https://github.com/PoshCode/PowerShellPracticeAndStyle) + - [DSC Resource Style Guidelines & Best Practices][06] + - [DSC Resource Naming][05] + - [Creating a High Quality DSC Resource Module][04] +- [The Unofficial PowerShell Best Practices and Style Guide][03] + + +[01]: /powershell/scripting/developer/cmdlet/cmdlet-development-guidelines +[02]: https://devblogs.microsoft.com/powershell/powershell-dsc-resource-design-and-testing-checklist/ +[03]: https://github.com/PoshCode/PowerShellPracticeAndStyle +[04]: https://github.com/PowerShell/DscResources/blob/master/HighQualityModuleGuidelines.md +[05]: https://github.com/PowerShell/DscResources/blob/master/Naming.md +[06]: https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md +[10]: Rules/AvoidDefaultValueSwitchParameter.md +[11]: Rules/AvoidGlobalVars.md +[12]: Rules/AvoidUsingCmdletAliases.md +[13]: Rules/AvoidUsingComputerNameHardcoded.md +[14]: Rules/AvoidUsingConvertToSecureStringWithPlainText.md +[15]: Rules/AvoidUsingEmptyCatchBlock.md +[16]: Rules/AvoidUsingInvokeExpression.md +[17]: Rules/AvoidUsingPlainTextForPassword.md +[18]: Rules/AvoidUsingPositionalParameters.md +[19]: Rules/AvoidUsingUsernameAndPasswordParams.md +[20]: Rules/AvoidUsingWMICmdlet.md +[21]: Rules/AvoidUsingWriteHost.md +[22]: Rules/DSCDscExamplesPresent.md +[23]: Rules/DSCDscTestsPresent.md +[24]: Rules/DSCReturnCorrectTypesForDSCFunctions.md +[25]: Rules/DSCStandardDSCFunctionsInResource.md +[26]: Rules/DSCUseIdenticalMandatoryParametersForDSC.md +[27]: Rules/DSCUseIdenticalParametersForDSC.md +[28]: Rules/MissingModuleManifestField.md +[29]: Rules/ProvideCommentHelp.md +[30]: Rules/ReservedCmdletChar.md +[31]: Rules/ReservedParams.md +[32]: Rules/ShouldProcess.md +[33]: Rules/UseApprovedVerbs.md +[34]: Rules/UseCmdletCorrectly.md +[35]: Rules/UseDeclaredVarsMoreThanAssignments.md +[36]: Rules/UsePSCredentialType.md +[37]: Rules/UseShouldProcessForStateChangingFunctions.md +[38]: Rules/UseSingularNouns.md +[116]: https://github.com/PowerShell/PSScriptAnalyzer/issues/116 +[130]: https://github.com/PowerShell/PSScriptAnalyzer/issues/130 +[131]: https://github.com/PowerShell/PSScriptAnalyzer/issues/131 diff --git a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md index 4988251..da38018 100644 --- a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md +++ b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md @@ -5,23 +5,23 @@ title: Create XML-based help using PlatyPS --- # Create XML-based help using PlatyPS -When creating a PowerShell module, it is always recommended that you include detailed help for the +When creating a PowerShell module, it's always recommended that you include detailed help for the cmdlets you create. If your cmdlets are implemented in compiled code, you must use the XML-based help. This XML format is known as the Microsoft Assistance Markup Language (MAML). -The legacy PowerShell SDK documentation covers the details of creating help for PowerShell -cmdlets packaged into modules. However, PowerShell does not provide any tools for creating the -XML-based help. The SDK documentation explains the structure of MAML help, but leaves you the -task of creating the complex, and deeply nested, MAML content by hand. +The legacy PowerShell SDK documentation covers the details of creating help for PowerShell cmdlets +packaged into modules. However, PowerShell doesn't provide any tools for creating the XML-based +help. The SDK documentation explains the structure of MAML help, but leaves you the task of creating +the complex, and deeply nested, MAML content by hand. -This is where the [PlatyPS][platyps] module can help. +This is where the [PlatyPS][19] module can help. -## What is PlatyPS? +## what's PlatyPS? -PlatyPS is an [open-source][platyps-repo] tool that started as a _hackathon_ project to make the -creation and maintenance of MAML easier. PlatyPS documents the syntax of parameter sets and the -individual parameters for each cmdlet in your module. PlatyPS creates structured [Markdown][MD] -files that contain the syntax information. It can't create descriptions or provide examples. +PlatyPS is an [open-source][16] tool that started as a _hackathon_ project to make the creation and +maintenance of MAML easier. PlatyPS documents the syntax of parameter sets and the individual +parameters for each cmdlet in your module. PlatyPS creates structured [Markdown][15] files that +contain the syntax information. It can't create descriptions or provide examples. PlatyPS creates placeholders for you to fill in descriptions and examples. After adding the required information, PlatyPS compiles the Markdown files into MAML files. PowerShell's help system also @@ -73,17 +73,17 @@ The following flowchart outlines the process for creating or updating PowerShell New-MarkdownAboutHelp -OutputFolder $OutputFolder -AboutName "topic_name" ``` - If the output folder does not exist, `New-MarkdownHelp` creates it. In this example, + If the output folder doesn't exist, `New-MarkdownHelp` creates it. In this example, `New-MarkdownHelp` creates a Markdown file for each cmdlet in the module. It also creates the _module page_ in a file named `.md`. This module page contains a list of the cmdlets contained in the module and placeholders for the **Synopsis** description. The metadata in the module page comes from the module manifest and is used by PlatyPS to create the HelpInfo XML file - (as explained [below](#creating-an-updateable-help-package)). + (as explained [below][14]). `New-MarkdownAboutHelp` creates a new _about_ file named `about_topic_name.md`. - For more information, see [New-MarkdownHelp][New-MarkdownHelp] and - [New-MarkdownAboutHelp][New-MarkdownAboutHelp]. + For more information, see [New-MarkdownHelp][08] and + [New-MarkdownAboutHelp][07]. ### Update existing Markdown content when the module changes @@ -115,7 +115,7 @@ modules that have new cmdlets, new parameters, or parameters that have changed. ``` `Update-MarkdownHelpModule` updates the cmdlet and module Markdown files in the specified folder. - It does not update the `about_*.md` files. The module file (`ModuleName.md`) receives any new + It doesn't update the `about_*.md` files. The module file (`ModuleName.md`) receives any new **Synopsis** text that has been added to the cmdlet files. Updates to cmdlet files include the following change: @@ -124,7 +124,7 @@ modules that have new cmdlets, new parameters, or parameters that have changed. - Updated parameter metadata - Updated input and output type information - For more information, see [Update-MarkdownHelpModule][Update-MarkdownHelpModule]. + For more information, see [Update-MarkdownHelpModule][09]. ## Edit the new or updated Markdown files @@ -139,15 +139,14 @@ at least one example. For detailed information about writing PowerShell content, see the following articles: -- [PowerShell style guide](/powershell/scripting/community/contributing/powershell-style-guide) -- [Editing reference articles](/powershell/scripting/community/contributing/editing-cmdlet-ref) +- [PowerShell style guide][11] +- [Editing reference articles][10] > [!NOTE] -> PlatyPS has a specific schema that is uses for cmdlet reference. That schema only allows certain +> PlatyPS has a specific schema that's uses for cmdlet reference. That schema only allows certain > Markdown blocks in specific sections of the document. If you put content in the wrong location, -> the PlatyPS build step fails. For more information, see the [schema][schema] documentation in the -> PlatyPS repository. For a complete example of well-formed cmdlet reference, see -> [Get-Item][Get-Item]. +> the PlatyPS build step fails. For more information, see the [schema][17] documentation in the +> PlatyPS repository. For a complete example of well-formed cmdlet reference, see [Get-Item][01]. After providing the required content for each of your cmdlets, you need to make sure that you update the module landing page. Verify your module has the correct `Module Guid` and `Download Help Link` @@ -177,7 +176,7 @@ New-ExternalHelp -Path -OutputPath `New-ExternalHelp` converts all cmdlet Markdown files into one (or more) MAML files. About files are converted to plain-text files with the following name format: `about_topic_name.help.txt`. The Markdown content must meet the requirement of the PlatyPS schema. `New-ExternalHelp` exits with -errors when the content does not follow the schema. You must edit the files to fix the schema +errors when the content doesn't follow the schema. You must edit the files to fix the schema violations. > [!CAUTION] @@ -188,11 +187,11 @@ violations. Once this step is complete, you will see `*-help.xml` and `about_*.help.txt` files in the target output folder. -For more information, see [New-ExternalHelp][New-ExternalHelp] +For more information, see [New-ExternalHelp][05] ### Test the compiled help files -You can verify the content with the [Get-HelpPreview][Get-HelpPreview] cmdlet: +You can verify the content with the [Get-HelpPreview][04] cmdlet: ```powershell Get-HelpPreview -Path "-Help.xml" @@ -215,7 +214,7 @@ files available to users. There are two options for providing help in the PowerS ### Packaging help with the module -The help files can be packaged with your module. See [Writing Help for Modules][writing] for details +The help files can be packaged with your module. See [Writing Help for Modules][13] for details of the folder structure. You should include the list of Help files in the value of the **FileList** key in the module manifest. @@ -229,7 +228,7 @@ At a high level, the steps to create updateable help include: 1. Create CAB files 1. Upload your files -For more information, see [Supporting Updateable Help: Step-by-step][step-by-step]. +For more information, see [Supporting Updateable Help: Step-by-step][12]. PlatyPS assists you with some of these steps. @@ -241,8 +240,8 @@ other information from the module manifest and the HelpInfo XML file. > [!IMPORTANT] > The **HelpInfoURI** must end with a forward-slash character (`/`). Without that character, -> `Update-Help` cannot construct the correct file paths to download the content. Also, most -> HTTP-based file services are case-sensitive. It is important that the module metadata in the +> `Update-Help` can't construct the correct file paths to download the content. Also, most +> HTTP-based file services are case-sensitive. It's important that the module metadata in the > HelpInfo XML file contains the proper letter case. The `New-ExternalHelp` cmdlet creates the HelpInfo XML file in the output folder. The HelpInfo XML @@ -264,41 +263,40 @@ New-ExternalHelpCab @helpCabParameters After creating the ZIP and CAB files, upload the ZIP, CAB, and HelpInfo XML files to your HTTP file server. Put the files in the location indicated by the **HelpInfoURI**. -For more information, see [New-ExternalHelpCab][New-ExternalHelpCab]. +For more information, see [New-ExternalHelpCab][06]. ### Other publishing options -Markdown is a versatile format that is easy to transform to other formats for publishing. Using a -tool like [Pandoc][Pandoc], you can convert your Markdown help files to many different document +Markdown is a versatile format that's easy to transform to other formats for publishing. Using a +tool like [Pandoc][18], you can convert your Markdown help files to many different document formats, including plain text, HTML, PDF, and Office document formats. -Also, the cmdlets [ConvertFrom-Markdown]ConvertFrom-Markdown] and [Show-Markdown][Show-Markdown] in -PowerShell 6 and higher can be used to convert Markdown to HTML or create a colorful display in the -PowerShell console. +Also, the cmdlets [ConvertFrom-Markdown][02] and [Show-Markdown][03] in PowerShell 6 and higher can +be used to convert Markdown to HTML or create a colorful display in the PowerShell console. ## Known issues -PlatyPS is very sensitive to the [schema][schema] for the structure of the Markdown files it creates -and compiles. It is very easy write valid Markdown that violates this schema. For more information, -see the [PowerShell style guide][style] and [Editing reference articles][edit]. +PlatyPS is very sensitive to the [schema][17] for the structure of the Markdown files it creates and +compiles. It's very easy write valid Markdown that violates this schema. For more information, see +the [PowerShell style guide][11] and [Editing reference articles][10]. -[platyps-repo]: https://github.com/PowerShell/platyps -[PlatyPS]: https://www.powershellgallery.com/packages/platyPS/ -[MD]: https://commonmark.org -[schema]: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md -[style]: /powershell/scripting/community/contributing/powershell-style-guide -[edit]: /powershell/scripting/community/contributing/editing-cmdlet-ref -[writing]: /powershell/scripting/developer/help/writing-help-for-windows-powershell-modules -[step-by-step]: /powershell/scripting/developer/help/updatable-help-authoring-step-by-step -[Pandoc]: https://pandoc.org - -[Get-Item]: /powershell/module/microsoft.powershell.management/get-item -[New-MarkdownHelp]: /powershell/module/platyps/new-markdownhelp -[Update-MarkdownHelpModule]: /powershell/module/platyps/update-markdownhelpmodule -[New-MarkdownAboutHelp]: /powershell/module/platyps/new-markdownabouthelp -[New-ExternalHelp]: /powershell/module/platyps/new-externalhelp -[Get-HelpPreview]: /powershell/module/platyps/Get-HelpPreview -[New-ExternalHelpCab]: /powershell/module/platyps/new-externalhelpcab -[ConvertFrom-Markdown]: /powershell/module/microsoft.powershell.utility/convertfrom-markdown -[Show-Markdown]: /powershell/module/microsoft.powershell.utility/show-markdown +[01]: /powershell/module/microsoft.powershell.management/get-item +[02]: /powershell/module/microsoft.powershell.utility/convertfrom-markdown +[03]: /powershell/module/microsoft.powershell.utility/show-markdown +[04]: /powershell/module/platyps/Get-HelpPreview +[05]: /powershell/module/platyps/new-externalhelp +[06]: /powershell/module/platyps/new-externalhelpcab +[07]: /powershell/module/platyps/new-markdownabouthelp +[08]: /powershell/module/platyps/new-markdownhelp +[09]: /powershell/module/platyps/update-markdownhelpmodule +[10]: /powershell/scripting/community/contributing/editing-cmdlet-ref +[11]: /powershell/scripting/community/contributing/powershell-style-guide +[12]: /powershell/scripting/developer/help/updatable-help-authoring-step-by-step +[13]: /powershell/scripting/developer/help/writing-help-for-windows-powershell-modules +[14]: #creating-an-updateable-help-package +[15]: https://commonmark.org +[16]: https://github.com/PowerShell/platyps +[17]: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md +[18]: https://pandoc.org +[19]: https://www.powershellgallery.com/packages/platyPS/ diff --git a/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md b/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md index e57c634..933d3b9 100644 --- a/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md +++ b/reference/docs-conceptual/SecretManagement/get-started/understanding-secretmanagement.md @@ -29,27 +29,30 @@ Once you have **SecretManagement** installed you can run `Get-SecretVault` to se you have registered. If this is your first time using the module, this command returns nothing. Once you have a vault registered you can use the **SecretManagement** cmdlets to view, get, set, and remove secrets. To see an example of registering a vault, see -[Get started with the SecretStore module](using-secretstore.md). +[Get started with the SecretStore module][04]. The **SecretManagement** module helps users manage secrets by providing a common set of cmdlets to interface with secrets across vaults. For a full list of cmdlets, see the -[Microsoft.PowerShell.SecretManagement](/powershell/module/microsoft.powershell.secretmanagement) -module page in the documentation. +[Microsoft.PowerShell.SecretManagement][01] module page in the documentation. ## Building an extension vault The value of the **SecretManagement** interface comes from the underlying vault and becomes more useful with each extension vault module. For more information on the design of SecretManagement and -how to build extension vaults, see the -[design document](https://github.com/PowerShell/SecretManagement/blob/master/Docs/ARCHITECTURE.md) -in the **SecretManagement** repository. This document describes a reference implementation -**TestVault** module. Also, reviewing the source code of the -[SecretStore](https://github.com/PowerShell/SecretStore) module may serve as an example for -extension vault authors looking to build off of existing vaults. +how to build extension vaults, see the [design document][02] in the **SecretManagement** repository. +This document describes a reference implementation **TestVault** module. Also, reviewing the source +code of the [SecretStore][03] module may serve as an example for extension vault authors looking to +build off of existing vaults. ## Windows Managed Accounts -**SecretManagement** does not currently work for Windows managed accounts. The module depends on -both `$env:LOCALAPPDATA` folders to store registry information and Windows Data Protection APIs -(DPAPI) for safely handling secrets with the .NET **SecureString** type. Windows managed accounts do -not have profiles or `$env:LOCALAPPDATA` folders and DPAPI doesn't support managed accounts. +**SecretManagement** doesn't currently work for Windows managed accounts. The module depends on both +`$env:LOCALAPPDATA` folders to store registry information and Windows Data Protection APIs (DPAPI) +for safely handling secrets with the .NET **SecureString** type. Windows managed accounts do not +have profiles or `$env:LOCALAPPDATA` folders and DPAPI doesn't support managed accounts. + + +[01]: /powershell/module/microsoft.powershell.secretmanagement +[02]: https://github.com/PowerShell/SecretManagement/blob/master/Docs/ARCHITECTURE.md +[03]: https://github.com/PowerShell/SecretStore +[04]: using-secretstore.md diff --git a/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md b/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md index 0321527..4cf41cd 100644 --- a/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md +++ b/reference/docs-conceptual/SecretManagement/get-started/using-secretstore.md @@ -13,7 +13,8 @@ Install-Module Microsoft.PowerShell.SecretManagement Install-Module Microsoft.PowerShell.SecretStore ``` -Once you have installed the modules you can load the modules and begin using or creating new secrets. +Once you have installed the modules you can load the modules and begin using or creating new +secrets. ```powershell Import-Module Microsoft.PowerShell.SecretManagement @@ -77,6 +78,11 @@ TestSecret String SecretStore ## Related links -- [Register-SecretVault](xref:Microsoft.PowerShell.SecretManagement.Register-SecretVault) -- [Get-Secret](xref:Microsoft.PowerShell.SecretManagement.Get-Secret) -- [Set-Secret](xref:Microsoft.PowerShell.SecretManagement.Set-Secret) +- [Register-SecretVault][02] +- [Get-Secret][01] +- [Set-Secret][03] + + +[01]: xref:Microsoft.PowerShell.SecretManagement.Get-Secret +[02]: xref:Microsoft.PowerShell.SecretManagement.Register-SecretVault +[03]: xref:Microsoft.PowerShell.SecretManagement.Set-Secret diff --git a/reference/docs-conceptual/SecretManagement/overview.md b/reference/docs-conceptual/SecretManagement/overview.md index 3e3321e..53d4e98 100644 --- a/reference/docs-conceptual/SecretManagement/overview.md +++ b/reference/docs-conceptual/SecretManagement/overview.md @@ -6,17 +6,17 @@ title: Overview of the SecretManagement and SecretStore modules # Overview of the SecretManagement and SecretStore modules The **SecretManagement** module helps users manage secrets by providing a common set of cmdlets that -interface with secrets vaults. **SecretManagement** provides an extensible model where local and remote -vaults can be registered for use. This allows you to separate the specific details for accessing and -managing the vault from your scripts that need secrets. +interface with secrets vaults. **SecretManagement** provides an extensible model where local and +remote vaults can be registered for use. This allows you to separate the specific details for +accessing and managing the vault from your scripts that need secrets. Since **SecretManagement** is a module abstraction layer in PowerShell, it becomes useful once extension vaults are registered. There are trade-offs between security, usability, and specificity -for any vault so it is up to the user to configure **SecretManagement** to integrate with the vaults +for any vault so it's up to the user to configure **SecretManagement** to integrate with the vaults that best match their requirements, as well as to assess the extent to which they trust any vault extensions not developed by Microsoft. -**SecretManagement** does not impose authentication requirements for extension vaults. This allows +**SecretManagement** doesn't impose authentication requirements for extension vaults. This allows each individual vault to provide its own mechanism. Some may require a password or token, while others may leverage current account credentials. @@ -26,7 +26,7 @@ others may leverage current account credentials. - Running your deployment script in local, test, and production environments with the change of only a single parameter, **Vault** - Changing the backend of the authentication method to meet specific security or organizational - needs without needing to update all my scripts + needs without needing to update all your scripts ## Extension Vault Ecosystem @@ -42,21 +42,31 @@ support PowerShell 7. ### Discovering and Installing Vault Extensions To find extension vault modules, search the PowerShell Gallery for the -[SecretManagement tag](https://www.powershellgallery.com/packages?q=Tags%3A%22SecretManagement%22). +[SecretManagement tag][03]. Some community vault extensions that are available: -- [Azure KeyVault](https://www.powershellgallery.com/packages/Az.KeyVault) (Microsoft Owned) -- [KeePass](https://www.powershellgallery.com/packages/SecretManagement.KeePass) -- [LastPass](https://www.powershellgallery.com/packages/SecretManagement.LastPass) -- [Hashicorp Vault](https://www.powershellgallery.com/packages/SecretManagement.Hashicorp.Vault.KV) -- [KeyChain](https://www.powershellgallery.com/packages/SecretManagement.KeyChain) -- [CredMan](https://www.powershellgallery.com/packages/SecretManagement.JustinGrote.CredMan) +- [Azure KeyVault][04] (Microsoft Owned) +- [KeePass][07] +- [LastPass][09] +- [Hashicorp Vault][05] +- [KeyChain][08] +- [CredMan][06] ## Community feedback and support Community feedback has been essential to the iterative development of these modules. To file issues or get support for the SecretManagement interface or vault development experience please use the -[SecretManagement](https://github.com/PowerShell/SecretManagement/issues) repository. For issues -with the SecretStore module please use the -[SecretStore](https://github.com/PowerShell/SecretStore/issues) repository. +[SecretManagement][01] repository. For issues with the SecretStore module please use the +[SecretStore][02] repository. + + +[01]: https://github.com/PowerShell/SecretManagement/issues +[02]: https://github.com/PowerShell/SecretStore/issues +[03]: https://www.powershellgallery.com/packages?q=Tags%3A%22SecretManagement%22 +[04]: https://www.powershellgallery.com/packages/Az.KeyVault +[05]: https://www.powershellgallery.com/packages/SecretManagement.Hashicorp.Vault.KV +[06]: https://www.powershellgallery.com/packages/SecretManagement.JustinGrote.CredMan +[07]: https://www.powershellgallery.com/packages/SecretManagement.KeePass +[08]: https://www.powershellgallery.com/packages/SecretManagement.KeyChain +[09]: https://www.powershellgallery.com/packages/SecretManagement.LastPass diff --git a/reference/docs-conceptual/overview.md b/reference/docs-conceptual/overview.md index cd13c39..975d57d 100644 --- a/reference/docs-conceptual/overview.md +++ b/reference/docs-conceptual/overview.md @@ -1,19 +1,26 @@ --- -description: This documentation set contains reference for modules published and maintained by the PowerShell team, but are not part of the PowerShell package. +description: This documentation set contains reference for modules published and maintained by the PowerShell team, but aren't part of the PowerShell package. ms.date: 06/28/2023 title: PowerShell utility modules --- # PowerShell utility modules The PowerShell team has created a set of utility modules that extend the capabilities of PowerShell. -These modules can be installed from the PowerShell Gallery and loaded on demand. The modules are not -officially part of the PowerShell product but they are maintained by the PowerShell product team. -The level of support for each module varies. For more details, see the landing page for each module. +These modules can be installed from the PowerShell Gallery and loaded on demand. The modules aren't +officially part of the PowerShell product but they're maintained by the PowerShell product team. The +level of support for each module varies. For more details, see the landing page for each module. This documentation set contains cmdlet reference for the following modules. -- [Microsoft.PowerShell.Crescendo](/powershell/module/microsoft.powershell.crescendo/) -- [Microsoft.PowerShell.SecretManagement](/powershell/module/microsoft.powershell.secretmanagement/) -- [Microsoft.PowerShell.SecretStore](/powershell/module/microsoft.powershell.secretstore/) -- [PlatyPS](/powershell/module/platyps/) -- [PSScriptAnalyzer](/powershell/module/psscriptanalyzer/) +- [Microsoft.PowerShell.Crescendo][01] +- [Microsoft.PowerShell.SecretManagement][02] +- [Microsoft.PowerShell.SecretStore][03] +- [PlatyPS][04] +- [PSScriptAnalyzer][05] + + +[01]: /powershell/module/microsoft.powershell.crescendo/ +[02]: /powershell/module/microsoft.powershell.secretmanagement/ +[03]: /powershell/module/microsoft.powershell.secretstore/ +[04]: /powershell/module/platyps/ +[05]: /powershell/module/psscriptanalyzer/ From 8e76c7194e091cae5a990b907cf401e99e308b36 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 28 Jun 2023 14:08:34 -0500 Subject: [PATCH 3/3] Apply suggestions from review --- reference/docs-conceptual/Crescendo/overview.md | 2 +- reference/docs-conceptual/PlatyPS/create-help-using-platyps.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/docs-conceptual/Crescendo/overview.md b/reference/docs-conceptual/Crescendo/overview.md index 35dc7a0..b41f94b 100644 --- a/reference/docs-conceptual/Crescendo/overview.md +++ b/reference/docs-conceptual/Crescendo/overview.md @@ -39,7 +39,7 @@ The documentation for Crescendo includes some new terminology. ### The Crescendo configuration file schema -When you author a Crescendo configuration file, you're writing JSON. For convenience,validation, and +When you author a Crescendo configuration file, you're writing JSON. For convenience, validation, and an improved developer experience, a [schema file is available][01]. You can review the schema to see the required and optional configuration settings, their diff --git a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md index da38018..2d05bcd 100644 --- a/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md +++ b/reference/docs-conceptual/PlatyPS/create-help-using-platyps.md @@ -16,7 +16,7 @@ the complex, and deeply nested, MAML content by hand. This is where the [PlatyPS][19] module can help. -## what's PlatyPS? +## What is PlatyPS? PlatyPS is an [open-source][16] tool that started as a _hackathon_ project to make the creation and maintenance of MAML easier. PlatyPS documents the syntax of parameter sets and the individual