Set-BT_RunbookEnvironment

NAME Set-BT_RunbookEnvironment



SYNOPSIS

This function sets up the BitTitan Runbook environment.





SYNTAX

Set-BT_RunbookEnvironment [-environment <String>] [-isRunningOnLocalMachine <Boolean>] [-isTestEnvironment

<Boolean>] [<CommonParameters>]





DESCRIPTION

This function sets up the BitTitan Runbook environment.

It does so by setting default values for the Environment and IsRunningOnLocalMachine parameters

when invoking *-BT_* cmdlets/functions.





PARAMETERS

-environment <String>

The BitTitan environment.



Required? false

Position? named

Default value Beta

Accept pipeline input? false

Accept wildcard characters? false



-isRunningOnLocalMachine <Boolean>

Select whether the current environment is on a local machine or on MSPComplete.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-isTestEnvironment <Boolean>

Select whether the current environment is a test environment.

A test environment is one where unit or integration tests may be run.

This environment variable may be queried by functions which may behave differently when

running in test and non-test environments, such as filtering objects returned using a

test run ID.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS