Skip to content

Commit 64b0872

Browse files
authored
Merge pull request #2 from MikeMarlowe/AdminDocUpdates
Admin doc updates
2 parents efdf64a + e6ecc36 commit 64b0872

12 files changed

+577
-36
lines changed

docs/install/TOC.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# [Install Visual Studio](install-visual-studio.md)
2-
## [Installing on low bandwidth or unreliable network environments](install-vs-inconsistent-quality-network.md)
2+
## [Install on low bandwidth or unreliable network environments](install-vs-inconsistent-quality-network.md)
33
## [Troubleshooting installation issues](troubleshooting-installation-issues.md)
44
## [Frequently asked questions about installing Visual Studio](install-faqs.md)
55
# [Update Visual Studio](update-visual-studio.md)
@@ -9,11 +9,11 @@
99
## [Use command-line parameters to install Visual Studio](use-command-line-parameters-to-install-visual-studio.md)
1010
## [Command-line parameter examples](command-line-parameter-examples.md)
1111
## [Create a network-based installation of Visual Studio](create-a-network-installation-of-visual-studio.md)
12-
## [Installing Visual Studio in an offline environment](install-visual-studio-in-offline-environment.md)
12+
## [Special considerations for installing Visual Studio in an offline environment](install-visual-studio-in-offline-environment.md)
1313
## [Automate Visual Studio installation with a response file](automated-installation-with-response-file.md)
1414
## [Automatically apply product keys when deploying Visual Studio](automatically-apply-product-keys-when-deploying-visual-studio.md)
1515
## [Set defaults for enterprise deployments of Visual Studio](set-defaults-for-enterprise-deployments.md)
1616
## [Disable or move the package cache](disable-or-move-the-package-cache.md)
1717
## [Update a network-based installation of Visual Studio](update-a-network-installation-of-visual-studio.md)
18-
## [Controlling updates to Visual Studio deployments](controlling-updates-to-visual-studio-deployments.md)
18+
## [Control updates to Visual Studio deployments](controlling-updates-to-visual-studio-deployments.md)
1919
## [Tools for detecting and managing Visual Studio instances](tools-for-managing-visual-studio-instances.md)

docs/install/automated-installation-with-response-file.md

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,252 @@ translation.priority.mt:
3131
- "pt-br"
3232
- "tr-tr"
3333
---
34+
# How to define settings in a response file
35+
Admins deploying VS can also specify a response file using the ```--in <response file>``` command.
36+
37+
Response files are JSON files whose contents mirror the command line arguments. In general, if a command line parameter takes no arguments (e.g. ```--quiet```, ```--passive```, etc.), the value in the response file should be true/false. If it takes an argument (e.g. ```--installPath <dir>```), the value in the response file should be a string. If it takes an argument and can appear on the command line more than once (e.g. ```--add <id>```), it should be an array of strings.
38+
39+
Command line parameters override settings from the response file, except in the case of multi-instance parameters (e.g. --add). Multi-instance parameters are merged with settings from the response file.
40+
41+
42+
### Offline layout repsonse files
43+
44+
If you created an offline layout, a response.json file was created in the layout.
45+
46+
Admins who create a layout can modify the response.json file in the layout to control the default settings that their users will see when installing VS from the layout. For example, if the admin wants some specific workloads and components selected to be installed by default, they can configure the response.json file to add those.
47+
48+
When VS setup is run from a layout folder, it will automatically use the response file in the layout folder. It is not required to use the ```--in``` option.
49+
50+
You can update the response.json file that is created in an offline layout folder to define default setting for users installing from this layout. However, be sure to leave the existing properties that were defined when the layout was created.
51+
52+
The base response.json file in a layout will look similar to this but with value for the product and channel you are installing:
53+
```
54+
{"installChannelUri":".\\ChannelManifest.json","channelUri":"https://aka.ms/vs/15/release/channel","installCatalogUri":".\\Catalog.json","channelId":"VisualStudio.15.Release","productId":"Microsoft.VisualStudio.Product.Enterprise",
55+
}
56+
```
57+
58+
#### Example layout response file content:
59+
This example will install Visual Studio Enterprise with all workloads and components for all localized languages. You can use this as a template. Just remove the workloads and components you don't want installed in your copy of the response file.<br>
60+
61+
```batch
62+
{"installChannelUri":".\\ChannelManifest.json","channelUri":"https://aka.ms/vs/15/release/channel","installCatalogUri":".\\Catalog.json","channelId":"VisualStudio.15.Release","productId":"Microsoft.VisualStudio.Product.Enterprise",
63+
"installPath": "C:\\desktopVS",
64+
"quiet": false,
65+
"passive": false,
66+
"wait": false,
67+
"norestart": false,
68+
"addProductLang": [
69+
"cs-CZ",
70+
"de-DE",
71+
"en-US",
72+
"es-ES",
73+
"fr-FR",
74+
"it-IT",
75+
"ja-JP",
76+
"ko-KR",
77+
"pl-PL",
78+
"pt-BR",
79+
"ru-RU",
80+
"tr-TR",
81+
"zh-CN",
82+
"zh-TW"
83+
]
84+
"add": [
85+
"Microsoft.VisualStudio.Workload.Azure",
86+
"Microsoft.VisualStudio.Workload.CoreEditor",
87+
"Microsoft.VisualStudio.Workload.Data",
88+
"Microsoft.VisualStudio.Workload.FeedbackClient",
89+
"Microsoft.VisualStudio.Workload.ManagedDesktop",
90+
"Microsoft.VisualStudio.Workload.ManagedGame",
91+
"Microsoft.VisualStudio.Workload.MSBuildTools",
92+
"Microsoft.VisualStudio.Workload.NativeCrossPlat",
93+
"Microsoft.VisualStudio.Workload.NativeDesktop",
94+
"Microsoft.VisualStudio.Workload.NativeGame",
95+
"Microsoft.VisualStudio.Workload.NativeMobile",
96+
"Microsoft.VisualStudio.Workload.NetCoreTools",
97+
"Microsoft.VisualStudio.Workload.NetCrossPlat",
98+
"Microsoft.VisualStudio.Workload.NetWeb",
99+
"Microsoft.VisualStudio.Workload.Node",
100+
"Microsoft.VisualStudio.Workload.Office",
101+
"Microsoft.VisualStudio.Workload.TestAgent",
102+
"Microsoft.VisualStudio.Workload.TestController",
103+
"Microsoft.VisualStudio.Workload.TestProfessional",
104+
"Microsoft.VisualStudio.Workload.Universal",
105+
"Microsoft.VisualStudio.Workload.VCTools",
106+
"Microsoft.VisualStudio.Workload.VisualStudioExtension",
107+
"Microsoft.VisualStudio.Workload.WebBuildTools",
108+
"Microsoft.VisualStudio.Workload.WebCrossPlat",
109+
"Component.Android.Emulator",
110+
"Component.Android.NDK.R11C",
111+
"Component.Android.NDK.R11C_3264",
112+
"Component.Android.NDK.R12B",
113+
"Component.Android.NDK.R12B_3264",
114+
"Component.Android.NDK.R13B",
115+
"Component.Android.NDK.R13B_3264",
116+
"Component.Android.SDK19",
117+
"Component.Android.SDK22",
118+
"Component.Android.SDK23",
119+
"Component.Ant",
120+
"Component.Cocos",
121+
"Component.CordovaToolset.6.3.1",
122+
"Component.Dotfuscator",
123+
"Component.GitHub.VisualStudio",
124+
"Component.Google.Android.Emulator.API23.V2",
125+
"Component.HAXM",
126+
"Component.Incredibuild",
127+
"Component.JavaJDK",
128+
"Component.MDD.Android",
129+
"Component.MDD.IOS",
130+
"Component.MDD.Linux",
131+
"Component.Redgate.ReadyRoll",
132+
"Component.Redgate.SQLPrompt.VsPackage",
133+
"Component.Redgate.SQLSearch.VSExtension",
134+
"Component.UnityEngine",
135+
"Component.Unreal",
136+
"Component.WebSocket",
137+
"Component.Xamarin",
138+
"Component.Xamarin.Inspector",
139+
"Component.Xamarin.Profiler",
140+
"Component.Xamarin.RemotedSimulator",
141+
"Microsoft.Component.Azure.DataLake.Tools",
142+
"Microsoft.Component.Blend.SDK.WPF",
143+
"Microsoft.Component.ClickOnce",
144+
"Microsoft.Component.HelpViewer",
145+
"Microsoft.Component.MSBuild",
146+
"Microsoft.Component.NetFX.Core.Runtime",
147+
"Microsoft.Component.NetFX.Native",
148+
"Microsoft.Component.VC.Runtime.OSSupport",
149+
"Microsoft.Component.VC.Runtime.UCRTSDK",
150+
"Microsoft.ComponentGroup.Blend",
151+
"Microsoft.Net.Component.3.5.DeveloperTools",
152+
"Microsoft.Net.Component.4.5.1.TargetingPack",
153+
"Microsoft.Net.Component.4.5.2.TargetingPack",
154+
"Microsoft.Net.Component.4.5.TargetingPack",
155+
"Microsoft.Net.Component.4.6.1.SDK",
156+
"Microsoft.Net.Component.4.6.1.TargetingPack",
157+
"Microsoft.Net.Component.4.6.2.SDK",
158+
"Microsoft.Net.Component.4.6.2.TargetingPack",
159+
"Microsoft.Net.Component.4.6.TargetingPack",
160+
"Microsoft.Net.Component.4.7.SDK",
161+
"Microsoft.Net.Component.4.7.TargetingPack",
162+
"Microsoft.Net.Component.4.TargetingPack",
163+
"Microsoft.Net.ComponentGroup.4.6.2.DeveloperTools",
164+
"Microsoft.Net.ComponentGroup.4.7.DeveloperTools",
165+
"Microsoft.Net.ComponentGroup.DevelopmentPrerequisites",
166+
"Microsoft.Net.ComponentGroup.TargetingPacks.Common",
167+
"Microsoft.Net.Core.Component.SDK",
168+
"Microsoft.NetCore.ComponentGroup.DevelopmentTools",
169+
"Microsoft.NetCore.ComponentGroup.Web",
170+
"Microsoft.VisualStudio.Component.AppInsights.Tools",
171+
"Microsoft.VisualStudio.Component.Azure.AuthoringTools",
172+
"Microsoft.VisualStudio.Component.Azure.ClientLibs",
173+
"Microsoft.VisualStudio.Component.Azure.Compute.Emulator",
174+
"Microsoft.VisualStudio.Component.Azure.MobileAppsSdk",
175+
"Microsoft.VisualStudio.Component.Azure.ResourceManager.Tools",
176+
"Microsoft.VisualStudio.Component.Azure.ServiceFabric.Tools",
177+
"Microsoft.VisualStudio.Component.Azure.Storage.AzCopy",
178+
"Microsoft.VisualStudio.Component.Azure.Storage.Emulator",
179+
"Microsoft.VisualStudio.Component.Azure.Waverton",
180+
"Microsoft.VisualStudio.Component.ClassDesigner",
181+
"Microsoft.VisualStudio.Component.CloudExplorer",
182+
"Microsoft.VisualStudio.Component.CodeClone",
183+
"Microsoft.VisualStudio.Component.CodeMap",
184+
"Microsoft.VisualStudio.Component.Common.Azure.Tools",
185+
"Microsoft.VisualStudio.Component.Cordova",
186+
"Microsoft.VisualStudio.Component.CoreBuildTools",
187+
"Microsoft.VisualStudio.Component.CoreEditor",
188+
"Microsoft.VisualStudio.Component.Debugger.JustInTime",
189+
"Microsoft.VisualStudio.Component.DependencyValidation.Community",
190+
"Microsoft.VisualStudio.Component.DependencyValidation.Enterprise",
191+
"Microsoft.VisualStudio.Component.DiagnosticTools",
192+
"Microsoft.VisualStudio.Component.DockerTools",
193+
"Microsoft.VisualStudio.Component.DslTools",
194+
"Microsoft.VisualStudio.Component.EntityFramework",
195+
"Microsoft.VisualStudio.Component.FSharp",
196+
"Microsoft.VisualStudio.Component.Git",
197+
"Microsoft.VisualStudio.Component.GraphDocument",
198+
"Microsoft.VisualStudio.Component.Graphics",
199+
"Microsoft.VisualStudio.Component.Graphics.Tools",
200+
"Microsoft.VisualStudio.Component.Graphics.Win81",
201+
"Microsoft.VisualStudio.Component.IISExpress",
202+
"Microsoft.VisualStudio.Component.IntelliTrace.FrontEnd",
203+
"Microsoft.VisualStudio.Component.JavaScript.Diagnostics",
204+
"Microsoft.VisualStudio.Component.JavaScript.TypeScript",
205+
"Microsoft.VisualStudio.Component.LinqToSql",
206+
"Microsoft.VisualStudio.Component.LiveUnitTesting",
207+
"Microsoft.VisualStudio.Component.ManagedDesktop.Core",
208+
"Microsoft.VisualStudio.Component.ManagedDesktop.Prerequisites",
209+
"Microsoft.VisualStudio.Component.Node.Tools",
210+
"Microsoft.VisualStudio.Component.NuGet",
211+
"Microsoft.VisualStudio.Component.Phone.Emulator",
212+
"Microsoft.VisualStudio.Component.Phone.Emulator.15063",
213+
"Microsoft.VisualStudio.Component.PortableLibrary",
214+
"Microsoft.VisualStudio.Component.PowerShell.Tools",
215+
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
216+
"Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
217+
"Microsoft.VisualStudio.Component.Sharepoint.Tools",
218+
"Microsoft.VisualStudio.Component.SQL.ADAL",
219+
"Microsoft.VisualStudio.Component.SQL.CLR",
220+
"Microsoft.VisualStudio.Component.SQL.CMDUtils",
221+
"Microsoft.VisualStudio.Component.SQL.DataSources",
222+
"Microsoft.VisualStudio.Component.SQL.LocalDB.Runtime",
223+
"Microsoft.VisualStudio.Component.SQL.NCLI",
224+
"Microsoft.VisualStudio.Component.SQL.SSDT",
225+
"Microsoft.VisualStudio.Component.Static.Analysis.Tools",
226+
"Microsoft.VisualStudio.Component.TeamOffice",
227+
"Microsoft.VisualStudio.Component.TestTools.CodedUITest",
228+
"Microsoft.VisualStudio.Component.TestTools.Core",
229+
"Microsoft.VisualStudio.Component.TestTools.FeedbackClient",
230+
"Microsoft.VisualStudio.Component.TestTools.MicrosoftTestManager",
231+
"Microsoft.VisualStudio.Component.TestTools.WebLoadTest",
232+
"Microsoft.VisualStudio.Component.TextTemplating",
233+
"Microsoft.VisualStudio.Component.TypeScript.2.0",
234+
"Microsoft.VisualStudio.Component.TypeScript.2.1",
235+
"Microsoft.VisualStudio.Component.Unity",
236+
"Microsoft.VisualStudio.Component.UWP.Support",
237+
"Microsoft.VisualStudio.Component.VC.140",
238+
"Microsoft.VisualStudio.Component.VC.ATL",
239+
"Microsoft.VisualStudio.Component.VC.ATLMFC",
240+
"Microsoft.VisualStudio.Component.VC.ClangC2",
241+
"Microsoft.VisualStudio.Component.VC.CLI.Support",
242+
"Microsoft.VisualStudio.Component.VC.CMake.Project",
243+
"Microsoft.VisualStudio.Component.VC.CoreBuildTools",
244+
"Microsoft.VisualStudio.Component.VC.CoreIde",
245+
"Microsoft.VisualStudio.Component.VC.DiagnosticTools",
246+
"Microsoft.VisualStudio.Component.VC.Modules.x86.x64",
247+
"Microsoft.VisualStudio.Component.VC.Tools.ARM",
248+
"Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
249+
"Microsoft.VisualStudio.Component.VisualStudioData",
250+
"Microsoft.VisualStudio.Component.VSSDK",
251+
"Microsoft.VisualStudio.Component.Wcf.Tooling",
252+
"Microsoft.VisualStudio.Component.Web",
253+
"Microsoft.VisualStudio.Component.WebDeploy",
254+
"Microsoft.VisualStudio.Component.Windows10SDK",
255+
"Microsoft.VisualStudio.Component.Windows10SDK.10240",
256+
"Microsoft.VisualStudio.Component.Windows10SDK.10586",
257+
"Microsoft.VisualStudio.Component.Windows10SDK.14393",
258+
"Microsoft.VisualStudio.Component.Windows10SDK.15063.Desktop",
259+
"Microsoft.VisualStudio.Component.Windows10SDK.15063.UWP",
260+
"Microsoft.VisualStudio.Component.Windows10SDK.15063.UWP.Native",
261+
"Microsoft.VisualStudio.Component.Windows81SDK",
262+
"Microsoft.VisualStudio.Component.WinXP",
263+
"Microsoft.VisualStudio.Component.Workflow",
264+
"Microsoft.VisualStudio.ComponentGroup.ArchitectureTools.Managed",
265+
"Microsoft.VisualStudio.ComponentGroup.ArchitectureTools.Native",
266+
"Microsoft.VisualStudio.ComponentGroup.Azure.CloudServices",
267+
"Microsoft.VisualStudio.ComponentGroup.Azure.Prerequisites",
268+
"Microsoft.VisualStudio.ComponentGroup.Azure.ResourceManager.Tools",
269+
"Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
270+
"Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Win81",
271+
"Microsoft.VisualStudio.ComponentGroup.NativeDesktop.WinXP",
272+
"Microsoft.VisualStudio.ComponentGroup.TestTools.TestAgent",
273+
"Microsoft.VisualStudio.ComponentGroup.TestTools.TestController",
274+
"Microsoft.VisualStudio.ComponentGroup.UWP.Cordova",
275+
"Microsoft.VisualStudio.ComponentGroup.UWP.VC",
276+
"Microsoft.VisualStudio.ComponentGroup.UWP.Xamarin",
277+
"Microsoft.VisualStudio.ComponentGroup.VisualStudioExtension.Prerequisites",
278+
"Microsoft.VisualStudio.Web.BuildTools.ComponentGroup",
279+
"Microsoft.VisualStudio.Web.Mvc4.ComponentGroup"
280+
]
281+
}
282+
```

docs/install/automatically-apply-product-keys-when-deploying-visual-studio.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,6 @@ translation.priority.mt:
3232
# Automatically apply product keys when deploying Visual Studio
3333
You can apply your product key programmatically as part of a script used to automate the deployment of Visual Studio. Product keys can be set on a device programmatically during installation of Visual Studio or after an installation completed.
3434

35-
## Apply the license during installation
36-
Use the `--productKey` parameter to apply a product key during Visual Studio’s setup process. This setup parameter can be used with the `--quiet parameter` to install Visual Studio in an already licensed state for an end user. To use the `--productKey` parameter, open up a command prompt. Run the setup program (e.g. vs_enterprise.exe or vs_professional.exe) and set the `--productKey` parameter with a product key (25 characters) with or without the dashes:
37-
38-
This is an example command for installing Visual Studio 2015 Enterprise with product key AAAAABBBBBCCCCCDDDDDEEEEEEE:
39-
40-
`vs_enterprise.exe [any other setup parameters] --productKey AAAAABBBBBCCCCCDDDDDDEEEEEE`
41-
4235
## Apply the license after installation
4336
You can activate an installed version of Visual Studio with a product key by using the storePID.exe utility on the target machines in silent mode. StorePID.exe is a utility program that installs with Visual Studio at **\<drive>:\\\Program Files (x86)\Microsoft Visual Studio 15.0\Common7\IDE\StorePID.exe**.
4437

@@ -57,13 +50,6 @@ You can apply your product key programmatically as part of a script used to auto
5750
|Visual Studio Enterprise 2017|08860|
5851
|Visual Studio Professional 2017|08862|
5952
|Visual Studio Test Professional 2017|08866|
60-
|Visual Studio Enterprise 2015|07060|
61-
|Visual Studio Professional 2015|07062|
62-
|Visual Studio Test Professional 2015|07066|
63-
|Visual Studio Ultimate 2013|06181|
64-
|Visual Studio Premium 2013|06191|
65-
|Visual Studio Professional 2013|06177|
66-
|Visual Studio Test Professional 2013|06194|
6753

6854
If StorePID.exe successfully applied the product key, it will return 0. If it encounters errors, it will return a number ranging from 1 to 6.
6955

docs/install/command-line-parameter-examples.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,26 +56,23 @@ vs_enterprise.exe --installPath C:\desktopVS ^
5656
> [!NOTE]
5757
> The `--wait` parameter is designed for use in a batch file. In a batch file, execution of the next command will not continue until the installation has completed. The `%ERRORLEVEL%` environment variable will contain the return value of the command, as documented in the [Use command-line parameters to install Visual Studio](use-command-line-parameters-to-install-visual-studio.md) page.
5858
59+
* Download the Visual Studio core editor (the most minimal Visual Studio configuration). Only include the English language pack:
60+
```cmd
61+
vs_community.exe --layout C:\VS2017
62+
--lang en-US ^
63+
--add Microsoft.VisualStudio.Workload.CoreEditor
64+
```
65+
5966
* Download the .NET desktop and .NET web workloads along with all recommended components and the GitHub extension. Only include the English language pack:
6067
```cmd
6168
vs_community.exe --layout C:\VS2017
6269
--lang en-US ^
63-
--add Microsoft.VisualStudio.Workload.CoreEditor ^
6470
--add Microsoft.VisualStudio.Workload.NetWeb ^
6571
--add Microsoft.VisualStudio.Workload.ManagedDesktop ^
66-
--add Microsoft.Net.ComponentGroup.TargetingPacks.Common ^
67-
--add Microsoft.ComponentGroup.Blend ^
68-
--add Microsoft.VisualStudio.Component.EntityFramework ^
69-
--add Microsoft.VisualStudio.Component.DiagnosticTools ^
70-
--add Microsoft.VisualStudio.Component.DockerTools ^
71-
--add Microsoft.VisualStudio.Component.CloudExplorer ^
72-
--add Microsoft.VisualStudio.Component.Wcf.Tooling ^
73-
--add Component.GitHub.VisualStudio
72+
--add Component.GitHub.VisualStudio ^
73+
--includeRecommended
7474
```
7575

76-
>[!NOTE]
77-
The Enterprise edition contains additional recommended components beyond those included here. See [Visual Studio Enterprise 2017 component directory](workload-component-id-vs-enterprise.md) for a listing of all recommended components available in Visual Studio Enterprise.
78-
7976
* Start an interactive installation of all workloads and components that are available in the Visual Studio 2017 Enterprise edition:
8077
```cmd
8178
vs_enterprise.exe --all --includeRecommended --includeOptional

0 commit comments

Comments
 (0)