Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. scvmm
  5. VMInstanceGuestAgent
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.scvmm.VMInstanceGuestAgent

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Defines the GuestAgent. Azure REST API version: 2023-04-01-preview.

Example Usage

CreateGuestAgent

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var vmInstanceGuestAgent = new AzureNative.ScVmm.VMInstanceGuestAgent("vmInstanceGuestAgent", new()
    {
        Credentials = new AzureNative.ScVmm.Inputs.GuestCredentialArgs
        {
            Password = "<password>",
            Username = "tempuser",
        },
        HttpProxyConfig = new AzureNative.ScVmm.Inputs.HttpProxyConfigurationArgs
        {
            HttpsProxy = "http://192.1.2.3:8080",
        },
        ProvisioningAction = AzureNative.ScVmm.ProvisioningAction.Install,
        ResourceUri = "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM",
    });

});
Copy
package main

import (
	scvmm "github.com/pulumi/pulumi-azure-native-sdk/scvmm/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scvmm.NewVMInstanceGuestAgent(ctx, "vmInstanceGuestAgent", &scvmm.VMInstanceGuestAgentArgs{
			Credentials: &scvmm.GuestCredentialArgs{
				Password: pulumi.String("<password>"),
				Username: pulumi.String("tempuser"),
			},
			HttpProxyConfig: &scvmm.HttpProxyConfigurationArgs{
				HttpsProxy: pulumi.String("http://192.1.2.3:8080"),
			},
			ProvisioningAction: pulumi.String(scvmm.ProvisioningActionInstall),
			ResourceUri:        pulumi.String("subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.scvmm.VMInstanceGuestAgent;
import com.pulumi.azurenative.scvmm.VMInstanceGuestAgentArgs;
import com.pulumi.azurenative.scvmm.inputs.GuestCredentialArgs;
import com.pulumi.azurenative.scvmm.inputs.HttpProxyConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vmInstanceGuestAgent = new VMInstanceGuestAgent("vmInstanceGuestAgent", VMInstanceGuestAgentArgs.builder()
            .credentials(GuestCredentialArgs.builder()
                .password("<password>")
                .username("tempuser")
                .build())
            .httpProxyConfig(HttpProxyConfigurationArgs.builder()
                .httpsProxy("http://192.1.2.3:8080")
                .build())
            .provisioningAction("install")
            .resourceUri("subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const vmInstanceGuestAgent = new azure_native.scvmm.VMInstanceGuestAgent("vmInstanceGuestAgent", {
    credentials: {
        password: "<password>",
        username: "tempuser",
    },
    httpProxyConfig: {
        httpsProxy: "http://192.1.2.3:8080",
    },
    provisioningAction: azure_native.scvmm.ProvisioningAction.Install,
    resourceUri: "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

vm_instance_guest_agent = azure_native.scvmm.VMInstanceGuestAgent("vmInstanceGuestAgent",
    credentials={
        "password": "<password>",
        "username": "tempuser",
    },
    http_proxy_config={
        "https_proxy": "http://192.1.2.3:8080",
    },
    provisioning_action=azure_native.scvmm.ProvisioningAction.INSTALL,
    resource_uri="subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM")
Copy
resources:
  vmInstanceGuestAgent:
    type: azure-native:scvmm:VMInstanceGuestAgent
    properties:
      credentials:
        password: <password>
        username: tempuser
      httpProxyConfig:
        httpsProxy: http://192.1.2.3:8080
      provisioningAction: install
      resourceUri: subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM
Copy

Create VMInstanceGuestAgent Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VMInstanceGuestAgent(name: string, args: VMInstanceGuestAgentArgs, opts?: CustomResourceOptions);
@overload
def VMInstanceGuestAgent(resource_name: str,
                         args: VMInstanceGuestAgentArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def VMInstanceGuestAgent(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_uri: Optional[str] = None,
                         credentials: Optional[GuestCredentialArgs] = None,
                         http_proxy_config: Optional[HttpProxyConfigurationArgs] = None,
                         provisioning_action: Optional[Union[str, ProvisioningAction]] = None)
func NewVMInstanceGuestAgent(ctx *Context, name string, args VMInstanceGuestAgentArgs, opts ...ResourceOption) (*VMInstanceGuestAgent, error)
public VMInstanceGuestAgent(string name, VMInstanceGuestAgentArgs args, CustomResourceOptions? opts = null)
public VMInstanceGuestAgent(String name, VMInstanceGuestAgentArgs args)
public VMInstanceGuestAgent(String name, VMInstanceGuestAgentArgs args, CustomResourceOptions options)

type: azure-native:scvmm:VMInstanceGuestAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VMInstanceGuestAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VMInstanceGuestAgentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VMInstanceGuestAgentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VMInstanceGuestAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VMInstanceGuestAgentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azure_nativeVMInstanceGuestAgentResource = new AzureNative.Scvmm.VMInstanceGuestAgent("azure-nativeVMInstanceGuestAgentResource", new()
{
    ResourceUri = "string",
    Credentials = 
    {
        { "password", "string" },
        { "username", "string" },
    },
    HttpProxyConfig = 
    {
        { "httpsProxy", "string" },
    },
    ProvisioningAction = "string",
});
Copy
example, err := scvmm.NewVMInstanceGuestAgent(ctx, "azure-nativeVMInstanceGuestAgentResource", &scvmm.VMInstanceGuestAgentArgs{
	ResourceUri: "string",
	Credentials: map[string]interface{}{
		"password": "string",
		"username": "string",
	},
	HttpProxyConfig: map[string]interface{}{
		"httpsProxy": "string",
	},
	ProvisioningAction: "string",
})
Copy
var azure_nativeVMInstanceGuestAgentResource = new VMInstanceGuestAgent("azure-nativeVMInstanceGuestAgentResource", VMInstanceGuestAgentArgs.builder()
    .resourceUri("string")
    .credentials(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .httpProxyConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .provisioningAction("string")
    .build());
Copy
azure_native_vm_instance_guest_agent_resource = azure_native.scvmm.VMInstanceGuestAgent("azure-nativeVMInstanceGuestAgentResource",
    resource_uri=string,
    credentials={
        password: string,
        username: string,
    },
    http_proxy_config={
        httpsProxy: string,
    },
    provisioning_action=string)
Copy
const azure_nativeVMInstanceGuestAgentResource = new azure_native.scvmm.VMInstanceGuestAgent("azure-nativeVMInstanceGuestAgentResource", {
    resourceUri: "string",
    credentials: {
        password: "string",
        username: "string",
    },
    httpProxyConfig: {
        httpsProxy: "string",
    },
    provisioningAction: "string",
});
Copy
type: azure-native:scvmm:VMInstanceGuestAgent
properties:
    credentials:
        password: string
        username: string
    httpProxyConfig:
        httpsProxy: string
    provisioningAction: string
    resourceUri: string
Copy

VMInstanceGuestAgent Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VMInstanceGuestAgent resource accepts the following input properties:

ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
Credentials Pulumi.AzureNative.ScVmm.Inputs.GuestCredential
Username / Password Credentials to provision guest agent.
HttpProxyConfig Pulumi.AzureNative.ScVmm.Inputs.HttpProxyConfiguration
HTTP Proxy configuration for the VM.
ProvisioningAction string | Pulumi.AzureNative.ScVmm.ProvisioningAction
Gets or sets the guest agent provisioning action.
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
Credentials GuestCredentialArgs
Username / Password Credentials to provision guest agent.
HttpProxyConfig HttpProxyConfigurationArgs
HTTP Proxy configuration for the VM.
ProvisioningAction string | ProvisioningAction
Gets or sets the guest agent provisioning action.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
credentials GuestCredential
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfiguration
HTTP Proxy configuration for the VM.
provisioningAction String | ProvisioningAction
Gets or sets the guest agent provisioning action.
resourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
credentials GuestCredential
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfiguration
HTTP Proxy configuration for the VM.
provisioningAction string | ProvisioningAction
Gets or sets the guest agent provisioning action.
resource_uri
This property is required.
Changes to this property will trigger replacement.
str
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
credentials GuestCredentialArgs
Username / Password Credentials to provision guest agent.
http_proxy_config HttpProxyConfigurationArgs
HTTP Proxy configuration for the VM.
provisioning_action str | ProvisioningAction
Gets or sets the guest agent provisioning action.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
credentials Property Map
Username / Password Credentials to provision guest agent.
httpProxyConfig Property Map
HTTP Proxy configuration for the VM.
provisioningAction String | "install" | "uninstall" | "repair"
Gets or sets the guest agent provisioning action.

Outputs

All input properties are implicitly available as output properties. Additionally, the VMInstanceGuestAgent resource produces the following output properties:

CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Gets or sets the provisioning state.
Status string
Gets or sets the guest agent status.
SystemData Pulumi.AzureNative.ScVmm.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uuid string
Gets or sets a unique identifier for this resource.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Gets or sets the provisioning state.
Status string
Gets or sets the guest agent status.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uuid string
Gets or sets a unique identifier for this resource.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Gets or sets the provisioning state.
status String
Gets or sets the guest agent status.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid String
Gets or sets a unique identifier for this resource.
customResourceName string
Gets the name of the corresponding resource in Kubernetes.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Gets or sets the provisioning state.
status string
Gets or sets the guest agent status.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid string
Gets or sets a unique identifier for this resource.
custom_resource_name str
Gets the name of the corresponding resource in Kubernetes.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Gets or sets the provisioning state.
status str
Gets or sets the guest agent status.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid str
Gets or sets a unique identifier for this resource.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Gets or sets the provisioning state.
status String
Gets or sets the guest agent status.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid String
Gets or sets a unique identifier for this resource.

Supporting Types

GuestCredential
, GuestCredentialArgs

Password string
Gets or sets the password to connect with the guest.
Username string
Gets or sets username to connect with the guest.
Password string
Gets or sets the password to connect with the guest.
Username string
Gets or sets username to connect with the guest.
password String
Gets or sets the password to connect with the guest.
username String
Gets or sets username to connect with the guest.
password string
Gets or sets the password to connect with the guest.
username string
Gets or sets username to connect with the guest.
password str
Gets or sets the password to connect with the guest.
username str
Gets or sets username to connect with the guest.
password String
Gets or sets the password to connect with the guest.
username String
Gets or sets username to connect with the guest.

GuestCredentialResponse
, GuestCredentialResponseArgs

Username This property is required. string
Gets or sets username to connect with the guest.
Username This property is required. string
Gets or sets username to connect with the guest.
username This property is required. String
Gets or sets username to connect with the guest.
username This property is required. string
Gets or sets username to connect with the guest.
username This property is required. str
Gets or sets username to connect with the guest.
username This property is required. String
Gets or sets username to connect with the guest.

HttpProxyConfiguration
, HttpProxyConfigurationArgs

HttpsProxy string
Gets or sets httpsProxy url.
HttpsProxy string
Gets or sets httpsProxy url.
httpsProxy String
Gets or sets httpsProxy url.
httpsProxy string
Gets or sets httpsProxy url.
https_proxy str
Gets or sets httpsProxy url.
httpsProxy String
Gets or sets httpsProxy url.

HttpProxyConfigurationResponse
, HttpProxyConfigurationResponseArgs

HttpsProxy string
Gets or sets httpsProxy url.
HttpsProxy string
Gets or sets httpsProxy url.
httpsProxy String
Gets or sets httpsProxy url.
httpsProxy string
Gets or sets httpsProxy url.
https_proxy str
Gets or sets httpsProxy url.
httpsProxy String
Gets or sets httpsProxy url.

ProvisioningAction
, ProvisioningActionArgs

Install
install
Uninstall
uninstall
Repair
repair
ProvisioningActionInstall
install
ProvisioningActionUninstall
uninstall
ProvisioningActionRepair
repair
Install
install
Uninstall
uninstall
Repair
repair
Install
install
Uninstall
uninstall
Repair
repair
INSTALL
install
UNINSTALL
uninstall
REPAIR
repair
"install"
install
"uninstall"
uninstall
"repair"
repair

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:scvmm:VMInstanceGuestAgent default /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native