From 79bdc150052d5b9dcbcd5729fc683cd7a0b33afb Mon Sep 17 00:00:00 2001 From: Jonathan Reynes Date: Mon, 24 May 2021 15:47:16 -0400 Subject: [PATCH] Update-MarkdownHelpModule --- .../help/Test-AzManagementGroupDeployment.md | 118 +++++++++++------- .../Resources/help/Test-AzTenantDeployment.md | 102 +++++++++------ 2 files changed, 132 insertions(+), 88 deletions(-) diff --git a/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md b/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md index e8f05c32a49b..722329e36b6c 100644 --- a/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md +++ b/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md @@ -14,107 +14,114 @@ Validates a deployment at a management group. ### ByTemplateFileWithNoParameters (Default) ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterObject ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterObject -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterObject -TemplateObject + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterObject ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterObject -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterObject -TemplateFile + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterObject ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterObject -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterObject -TemplateUri + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterObject -TemplateSpecId + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterFile ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterFile -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterFile -TemplateObject + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterFile ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterFile -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterFile -TemplateFile [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterFile ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterFile -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterFile -TemplateUri [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceIdAndParams ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterFile -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterFile -TemplateSpecId + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterUri ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterUri -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterUri -TemplateObject + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterUri ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterUri -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterUri -TemplateFile [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterUri ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterUri -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterUri -TemplateUri [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceIdAndParamsUri ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateParameterUri -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] - [-DefaultProfile ] [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateParameterUri -TemplateSpecId [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateObjectWithNoParameters ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateUriWithNoParameters ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceId ``` -Test-AzManagementGroupDeployment -ManagementGroupId -Location [-QueryString ] - -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzManagementGroupDeployment [-Name ] -ManagementGroupId -Location + [-QueryString ] -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -185,6 +192,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name +The name of the deployment it's going to test. If not specified, defaults to the template file name when a template file is provided + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pre When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. @@ -282,7 +304,7 @@ A hash table which represents the parameters. ```yaml Type: System.Collections.Hashtable -Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject Aliases: Required: True @@ -312,7 +334,7 @@ Resource ID of the templateSpec to be deployed. ```yaml Type: System.String -Parameter Sets: ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId Aliases: Required: True @@ -352,4 +374,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -## RELATED LINKS +## RELATED LINKS \ No newline at end of file diff --git a/src/Resources/Resources/help/Test-AzTenantDeployment.md b/src/Resources/Resources/help/Test-AzTenantDeployment.md index e7f094de45f8..f2732cd10540 100644 --- a/src/Resources/Resources/help/Test-AzTenantDeployment.md +++ b/src/Resources/Resources/help/Test-AzTenantDeployment.md @@ -14,102 +14,109 @@ Validates a deployment at tenant scope. ### ByTemplateFileWithNoParameters (Default) ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateFile +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterObject ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterObject - -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterObject -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterObject ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterObject - -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterObject -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterObject ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterObject - -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterObject -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterObject -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterFile ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterFile - -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterFile -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterFile ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterFile - -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterFile -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterFile ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterFile - -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterFile -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceIdAndParams ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterFile - -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterFile -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateObjectAndParameterUri ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterUri - -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterUri -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateFileAndParameterUri ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterUri - -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterUri -TemplateFile [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateUriAndParameterUri ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterUri - -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterUri -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceIdAndParamsUri ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateParameterUri - -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] - [] +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] + -TemplateParameterUri -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile ] [] ``` ### ByTemplateObjectWithNoParameters ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateObject +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] -TemplateObject [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateUriWithNoParameters ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateUri +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] -TemplateUri [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` ### ByTemplateSpecResourceId ``` -Test-AzTenantDeployment -Location [-QueryString ] -TemplateSpecId +Test-AzTenantDeployment [-Name ] -Location [-QueryString ] -TemplateSpecId [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile ] [] ``` @@ -166,6 +173,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name +The name of the deployment it's going to test. If not specified, defaults to the template file name when a template file is provided + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pre When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. @@ -263,7 +285,7 @@ A hash table which represents the parameters. ```yaml Type: System.Collections.Hashtable -Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject Aliases: Required: True @@ -293,7 +315,7 @@ Resource ID of the templateSpec to be deployed. ```yaml Type: System.String -Parameter Sets: ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId Aliases: Required: True @@ -333,4 +355,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -## RELATED LINKS +## RELATED LINKS \ No newline at end of file