The virtualMachines/guestAgents resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AzureStackHCI/virtualMachines/guestAgents resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/virtualMachines/guestAgents",
"apiVersion": "2022-12-15-preview",
"name": "string",
"properties": {
"credentials": {
"password": "string",
"username": "string"
},
"httpProxyConfig": {
"httpsProxy": "string"
},
"provisioningAction": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AzureStackHCI/virtualMachines/guestAgents' |
apiVersion | The resource api version | '2022-12-15-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Resource properties. | GuestAgentProperties (required) |
Name | Description | Value |
---|---|---|
credentials | Username / Password Credentials to provision guest agent. | GuestCredential |
httpProxyConfig | HTTP Proxy configuration for the VM. | HttpProxyConfiguration |
provisioningAction | The guest agent provisioning action. | 'install' 'repair' 'uninstall' |
Name | Description | Value |
---|---|---|
password | The password to connect with the guest. | string Constraints: Sensitive value. Pass in as a secure parameter. |
username | The username to connect with the guest. | string |
Name | Description | Value |
---|---|---|
httpsProxy | The httpsProxy url. | string |