Skip to content

Commit

Permalink
Update-MarkdownHelpModule
Browse files Browse the repository at this point in the history
  • Loading branch information
jontreynes committed May 26, 2021
1 parent 65b05e9 commit 4ab2fa1
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 88 deletions.
118 changes: 70 additions & 48 deletions src/Resources/Resources/help/Test-AzManagementGroupDeployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,107 +14,114 @@ Validates a deployment at a management group.

### ByTemplateFileWithNoParameters (Default)
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateObjectAndParameterObject
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateFileAndParameterObject
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterObject <Hashtable> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateFile <String>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateUriAndParameterObject
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterObject <Hashtable> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateUri <String>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateSpecResourceIdAndParamsObject
```
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateSpecId <String>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateObjectAndParameterFile
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterFile <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterFile <String> -TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateFileAndParameterFile
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt]
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateUriAndParameterFile
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt]
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateSpecResourceIdAndParams
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterFile <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterFile <String> -TemplateSpecId <String>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateObjectAndParameterUri
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterUri <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterUri <String> -TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateFileAndParameterUri
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt]
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateUriAndParameterUri
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt]
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateSpecResourceIdAndParamsUri
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt]
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateObjectWithNoParameters
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateUriWithNoParameters
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByTemplateSpecResourceId
```
Test-AzManagementGroupDeployment -ManagementGroupId <String> -Location <String> [-QueryString <String>]
-TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String>
[-QueryString <String>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -352,4 +374,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
## RELATED LINKS
Loading

0 comments on commit 4ab2fa1

Please sign in to comment.