Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. GuestAgent
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.GuestAgent

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Defines the GuestAgent. Azure REST API version: 2022-12-15-preview.

    Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview.

    Example Usage

    CreateGuestAgent

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

return await Deployment.RunAsync(() => 
{
    var guestAgent = new AzureNative.AzureStackHCI.GuestAgent("guestAgent", new()
    {
        Credentials = new AzureNative.AzureStackHCI.Inputs.GuestCredentialArgs
        {
            Password = "<password>",
            Username = "tempuser",
        },
        Name = "default",
        ProvisioningAction = AzureNative.AzureStackHCI.ProvisioningAction.Install,
        ResourceGroupName = "testrg",
        VirtualMachineName = "ContosoVm",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewGuestAgent(ctx, "guestAgent", &azurestackhci.GuestAgentArgs{
			Credentials: &azurestackhci.GuestCredentialArgs{
				Password: pulumi.String("<password>"),
				Username: pulumi.String("tempuser"),
			},
			Name:               pulumi.String("default"),
			ProvisioningAction: pulumi.String(azurestackhci.ProvisioningActionInstall),
			ResourceGroupName:  pulumi.String("testrg"),
			VirtualMachineName: pulumi.String("ContosoVm"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurestackhci.GuestAgent;
import com.pulumi.azurenative.azurestackhci.GuestAgentArgs;
import com.pulumi.azurenative.azurestackhci.inputs.GuestCredentialArgs;
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 guestAgent = new GuestAgent("guestAgent", GuestAgentArgs.builder()
            .credentials(GuestCredentialArgs.builder()
                .password("<password>")
                .username("tempuser")
                .build())
            .name("default")
            .provisioningAction("install")
            .resourceGroupName("testrg")
            .virtualMachineName("ContosoVm")
            .build());

    }
}

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

const guestAgent = new azure_native.azurestackhci.GuestAgent("guestAgent", {
    credentials: {
        password: "<password>",
        username: "tempuser",
    },
    name: "default",
    provisioningAction: azure_native.azurestackhci.ProvisioningAction.Install,
    resourceGroupName: "testrg",
    virtualMachineName: "ContosoVm",
});

    import pulumi
import pulumi_azure_native as azure_native

guest_agent = azure_native.azurestackhci.GuestAgent("guestAgent",
    credentials={
        "password": "<password>",
        "username": "tempuser",
    },
    name="default",
    provisioning_action=azure_native.azurestackhci.ProvisioningAction.INSTALL,
    resource_group_name="testrg",
    virtual_machine_name="ContosoVm")

    resources:
  guestAgent:
    type: azure-native:azurestackhci:GuestAgent
    properties:
      credentials:
        password: <password>
        username: tempuser
      name: default
      provisioningAction: install
      resourceGroupName: testrg
      virtualMachineName: ContosoVm

    Create GuestAgent Resource

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

    Constructor syntax

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

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

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

    Parameters

    name string
    The unique name of the resource.
    args GuestAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GuestAgentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GuestAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GuestAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GuestAgentArgs
    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 guestAgentResource = new AzureNative.AzureStackHCI.GuestAgent("guestAgentResource", new()
{
    ResourceGroupName = "string",
    VirtualMachineName = "string",
    Credentials = new AzureNative.AzureStackHCI.Inputs.GuestCredentialArgs
    {
        Password = "string",
        Username = "string",
    },
    HttpProxyConfig = new AzureNative.AzureStackHCI.Inputs.HttpProxyConfigurationArgs
    {
        HttpsProxy = "string",
    },
    Name = "string",
    ProvisioningAction = "string",
});

    example, err := azurestackhci.NewGuestAgent(ctx, "guestAgentResource", &azurestackhci.GuestAgentArgs{
	ResourceGroupName:  pulumi.String("string"),
	VirtualMachineName: pulumi.String("string"),
	Credentials: &azurestackhci.GuestCredentialArgs{
		Password: pulumi.String("string"),
		Username: pulumi.String("string"),
	},
	HttpProxyConfig: &azurestackhci.HttpProxyConfigurationArgs{
		HttpsProxy: pulumi.String("string"),
	},
	Name:               pulumi.String("string"),
	ProvisioningAction: pulumi.String("string"),
})

    var guestAgentResource = new GuestAgent("guestAgentResource", GuestAgentArgs.builder()
    .resourceGroupName("string")
    .virtualMachineName("string")
    .credentials(GuestCredentialArgs.builder()
        .password("string")
        .username("string")
        .build())
    .httpProxyConfig(HttpProxyConfigurationArgs.builder()
        .httpsProxy("string")
        .build())
    .name("string")
    .provisioningAction("string")
    .build());

    guest_agent_resource = azure_native.azurestackhci.GuestAgent("guestAgentResource",
    resource_group_name="string",
    virtual_machine_name="string",
    credentials={
        "password": "string",
        "username": "string",
    },
    http_proxy_config={
        "https_proxy": "string",
    },
    name="string",
    provisioning_action="string")

    const guestAgentResource = new azure_native.azurestackhci.GuestAgent("guestAgentResource", {
    resourceGroupName: "string",
    virtualMachineName: "string",
    credentials: {
        password: "string",
        username: "string",
    },
    httpProxyConfig: {
        httpsProxy: "string",
    },
    name: "string",
    provisioningAction: "string",
});

    type: azure-native:azurestackhci:GuestAgent
properties:
    credentials:
        password: string
        username: string
    httpProxyConfig:
        httpsProxy: string
    name: string
    provisioningAction: string
    resourceGroupName: string
    virtualMachineName: string

    GuestAgent 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 GuestAgent resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualMachineName string
    Name of the vm.
    Credentials Pulumi.AzureNative.AzureStackHCI.Inputs.GuestCredential
    Username / Password Credentials to provision guest agent.
    HttpProxyConfig Pulumi.AzureNative.AzureStackHCI.Inputs.HttpProxyConfiguration
    HTTP Proxy configuration for the VM.
    Name string
    Name of the guestAgents.
    ProvisioningAction string | Pulumi.AzureNative.AzureStackHCI.ProvisioningAction
    The guest agent provisioning action.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualMachineName string
    Name of the vm.
    Credentials GuestCredentialArgs
    Username / Password Credentials to provision guest agent.
    HttpProxyConfig HttpProxyConfigurationArgs
    HTTP Proxy configuration for the VM.
    Name string
    Name of the guestAgents.
    ProvisioningAction string | ProvisioningAction
    The guest agent provisioning action.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualMachineName String
    Name of the vm.
    credentials GuestCredential
    Username / Password Credentials to provision guest agent.
    httpProxyConfig HttpProxyConfiguration
    HTTP Proxy configuration for the VM.
    name String
    Name of the guestAgents.
    provisioningAction String | ProvisioningAction
    The guest agent provisioning action.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    virtualMachineName string
    Name of the vm.
    credentials GuestCredential
    Username / Password Credentials to provision guest agent.
    httpProxyConfig HttpProxyConfiguration
    HTTP Proxy configuration for the VM.
    name string
    Name of the guestAgents.
    provisioningAction string | ProvisioningAction
    The guest agent provisioning action.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    virtual_machine_name str
    Name of the vm.
    credentials GuestCredentialArgs
    Username / Password Credentials to provision guest agent.
    http_proxy_config HttpProxyConfigurationArgs
    HTTP Proxy configuration for the VM.
    name str
    Name of the guestAgents.
    provisioning_action str | ProvisioningAction
    The guest agent provisioning action.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualMachineName String
    Name of the vm.
    credentials Property Map
    Username / Password Credentials to provision guest agent.
    httpProxyConfig Property Map
    HTTP Proxy configuration for the VM.
    name String
    Name of the guestAgents.
    provisioningAction String | "install" | "uninstall" | "repair"
    The guest agent provisioning action.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state.
    Status string
    The guest agent status.
    SystemData Pulumi.AzureNative.AzureStackHCI.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"
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state.
    Status string
    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"
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state.
    status String
    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"
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    The provisioning state.
    status string
    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"
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    The provisioning state.
    status str
    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"
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state.
    status String
    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"

    Supporting Types

    GuestCredential, GuestCredentialArgs

    Password string
    The password to connect with the guest.
    Username string
    The username to connect with the guest.
    Password string
    The password to connect with the guest.
    Username string
    The username to connect with the guest.
    password String
    The password to connect with the guest.
    username String
    The username to connect with the guest.
    password string
    The password to connect with the guest.
    username string
    The username to connect with the guest.
    password str
    The password to connect with the guest.
    username str
    The username to connect with the guest.
    password String
    The password to connect with the guest.
    username String
    The username to connect with the guest.

    GuestCredentialResponse, GuestCredentialResponseArgs

    Username string
    The username to connect with the guest.
    Username string
    The username to connect with the guest.
    username String
    The username to connect with the guest.
    username string
    The username to connect with the guest.
    username str
    The username to connect with the guest.
    username String
    The username to connect with the guest.

    HttpProxyConfiguration, HttpProxyConfigurationArgs

    HttpsProxy string
    The httpsProxy url.
    HttpsProxy string
    The httpsProxy url.
    httpsProxy String
    The httpsProxy url.
    httpsProxy string
    The httpsProxy url.
    https_proxy str
    The httpsProxy url.
    httpsProxy String
    The httpsProxy url.

    HttpProxyConfigurationResponse, HttpProxyConfigurationResponseArgs

    HttpsProxy string
    The httpsProxy url.
    HttpsProxy string
    The httpsProxy url.
    httpsProxy String
    The httpsProxy url.
    httpsProxy string
    The httpsProxy url.
    https_proxy str
    The httpsProxy url.
    httpsProxy String
    The 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:azurestackhci:GuestAgent default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualMachines/{virtualMachineName}/guestAgents/{name}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native