Microsoft.ConnectedVMwarevSphere virtualMachines/guestAgents

Bicep resource definition

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.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    credentials: {
      password: 'string'
      username: 'string'
    }
    httpProxyConfig: {
      httpsProxy: 'string'
    }
    privateLinkScopeResourceId: 'string'
    provisioningAction: 'string'
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: virtualMachines
properties Resource properties. GuestAgentProperties (required)

GuestAgentProperties

Name Description Value
credentials Username / Password Credentials to provision guest agent. GuestCredential
httpProxyConfig HTTP Proxy configuration for the VM. HttpProxyConfiguration
privateLinkScopeResourceId The resource id of the private link scope this machine is assigned to, if any. string
provisioningAction Gets or sets the guest agent provisioning action. 'install'
'repair'
'uninstall'

GuestCredential

Name Description Value
password Gets or sets the password to connect with the guest. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Gets or sets username to connect with the guest. string

HttpProxyConfiguration

Name Description Value
httpsProxy Gets or sets httpsProxy url. string

ARM template resource definition

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.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents resource, add the following JSON to your template.

{
  "type": "Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "credentials": {
      "password": "string",
      "username": "string"
    },
    "httpProxyConfig": {
      "httpsProxy": "string"
    },
    "privateLinkScopeResourceId": "string",
    "provisioningAction": "string"
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents

Name Description Value
apiVersion The api version '2023-03-01-preview'
name The resource name string (required)
properties Resource properties. GuestAgentProperties (required)
type The resource type 'Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents'

GuestAgentProperties

Name Description Value
credentials Username / Password Credentials to provision guest agent. GuestCredential
httpProxyConfig HTTP Proxy configuration for the VM. HttpProxyConfiguration
privateLinkScopeResourceId The resource id of the private link scope this machine is assigned to, if any. string
provisioningAction Gets or sets the guest agent provisioning action. 'install'
'repair'
'uninstall'

GuestCredential

Name Description Value
password Gets or sets the password to connect with the guest. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Gets or sets username to connect with the guest. string

HttpProxyConfiguration

Name Description Value
httpsProxy Gets or sets httpsProxy url. string

Usage Examples

Terraform (AzAPI provider) resource definition

The virtualMachines/guestAgents resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      credentials = {
        password = "string"
        username = "string"
      }
      httpProxyConfig = {
        httpsProxy = "string"
      }
      privateLinkScopeResourceId = "string"
      provisioningAction = "string"
    }
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: virtualMachines
properties Resource properties. GuestAgentProperties (required)
type The resource type "Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents@2023-03-01-preview"

GuestAgentProperties

Name Description Value
credentials Username / Password Credentials to provision guest agent. GuestCredential
httpProxyConfig HTTP Proxy configuration for the VM. HttpProxyConfiguration
privateLinkScopeResourceId The resource id of the private link scope this machine is assigned to, if any. string
provisioningAction Gets or sets the guest agent provisioning action. 'install'
'repair'
'uninstall'

GuestCredential

Name Description Value
password Gets or sets the password to connect with the guest. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Gets or sets username to connect with the guest. string

HttpProxyConfiguration

Name Description Value
httpsProxy Gets or sets httpsProxy url. string
  • Last updated on