Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

Docs Docs Docs! Adding windowsAgent apimodel parameters #3939

Merged
merged 2 commits into from
Oct 3, 2018
Merged

Docs Docs Docs! Adding windowsAgent apimodel parameters #3939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccd34f1
Adding windowsAgent apimodel parameters
Oct 3, 2018
996a101
Review feedback and example
Oct 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/clusterdefinition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,50 @@ format for `sourceVault.id`, can be obtained in cli, or found in the portal: /su
format for `vaultCertificates.certificateUrl`, can be obtained in cli, or found in the portal:
https://{keyvaultname}.vault.azure.net:443/secrets/{secretName}/{version}


### windowsProfile

`windowsProfile` provides configuration specific to Windows nodes in the cluster

| Name | Required | Description |
| -------------------------------- | -------- | ------------------------------------------------------------------------ |
| adminUsername | yes | Username for the Windows adminstrator account created on each Windows node |
| adminPassword | yes | Password for the Windows adminstrator account created on each Windows node |
| windowsPublisher | no | Publisher used to find Windows VM to deploy from marketplace. Default: `MicrosoftWindowsServer` |
| windowsOffer | no | Offer used to find Windows VM to deploy from marketplace. Default: `WindowsServerSemiAnnual` |
| windowsSku | no | SKU usedto find Windows VM to deploy from marketplace. Default: `Datacenter-Core-1803-with-Containers-smalldisk` |
| imageVersion | no | Specific image version to deploy from marketplace. Default: `latest` |
| windowsImageSourceURL | no | Path to an existing Azure storage blob with a sysprepped VHD. This is used to test pre-release or customized VHD files that you have uploaded to Azure. If provided, the above 4 parameters are ignored. |

#### Choosing a Windows version

If you want to choose a specific Windows image, but automatically use the latest - set `windowsPublisher`, `windowsOffer`, and `windowsSku`. If you need a specific version, then add `imageVersion` too.

You can find all available images with `az vm image list`

```bash
$ az vm image list --publisher MicrosoftWindowsServer --all -o table

Offer Publisher Sku Urn Version
----------------------- ----------------------------- ---------------------------------------------- ------------------------------------------------------------------------------------------------------------- -----------------
...
WindowsServerSemiAnnual MicrosoftWindowsServer Datacenter-Core-1709-with-Containers-smalldisk MicrosoftWindowsServer:WindowsServerSemiAnnual:Datacenter-Core-1709-with-Containers-smalldisk:1709.0.20180412 1709.0.20180412
WindowsServerSemiAnnual MicrosoftWindowsServer Datacenter-Core-1803-with-Containers-smalldisk MicrosoftWindowsServer:WindowsServerSemiAnnual:Datacenter-Core-1803-with-Containers-smalldisk:1803.0.20180504 1803.0.20180504
```

If you wanted to use the last one in the list above, then set:

```json
"windowsProfile": {
"adminUsername": "...",
"adminPassword": "...",
"windowsPublisher": "MicrosoftWindowsServer",
"windowsOffer": "WindowsServerSemiAnnual",
"windowsSku": "Datacenter-Core-1803-with-Containers-smalldisk",
"imageVersion": "1803.0.20180504"
},
```

### servicePrincipalProfile

`servicePrincipalProfile` describes an Azure Service credentials to be used by the cluster for self-configuration. See [service principal](serviceprincipal.md) for more details on creation.
Expand Down