---
title: "Deploy Configuration File"
---
Deploys an instance of a configuration file to disk after applying an optional template.
Deploy-ConfigFile(
ConfigFileName: <text>,
[Instance: <text>],
[To: <text>],
[OutputFileName: <text>],
[DoNotRecoderDeployment: <true/false>],
[VersionNumber: <integer>]
);
This operation may be prefixed with ConfigFiles::
, although this is a built-in namespace and isn't really necessary.
Name | Format | Script Usage | Usage Notes |
---|---|---|---|
☆ Configuration file name | text | ConfigFileName | This argument is required. |
Instance | text | Instance | Default value is "$PipelineStageName". |
To directory | text | To | Value note: "$WorkingDirectory". |
To file name | text | OutputFileName | Value note: "do not rename file". |
Do Not Record Deployment | true/false | DoNotRecoderDeployment | |
Version Number | integer | VersionNumber | Value note: "Default". |