Get-MtSetting

Synopsis

Returns a setting from GlobalSettings in the Maester config.

Syntax

Get-MtSetting [-Name] <String> [-Default <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Tests read their tenant-wide settings (for example EmergencyAccessAccounts) through this command. The value comes from GlobalSettings in the run config; when the config does not set it, the default from the settings registry is returned, else the -Default value.

Examples

Example 1

Get-MtSetting -Name EmergencyAccessAccounts

Returns the emergency access accounts configured for the run.

Parameters

-Name

The name of the setting, for example EmergencyAccessAccounts. Test packs can use Namespace.Key names.

Type: String
Parameter Sets: (All)
Aliases: SettingName

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Default

The value to return when neither the config nor the settings registry has one.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Outputs

System.Object

System.Object[]

Notes

Related links

https://maester.dev/docs/commands/Get-MtSetting