Docs Home Pulumi IaC Pulumi ESC Pulumi Insights 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 v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.GuestAgent

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Defines the GuestAgent.

Uses Azure REST API version 2025-02-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-12-15-preview.

Other available API versions: 2022-12-15-preview, 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-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

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",
        },
        ProvisioningAction = AzureNative.AzureStackHCI.ProvisioningAction.Install,
        ResourceUri = "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM",
    });

});
Copy
package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3"
	"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"),
			},
			ProvisioningAction: pulumi.String(azurestackhci.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.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())
            .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 guestAgent = new azure_native.azurestackhci.GuestAgent("guestAgent", {
    credentials: {
        password: "<password>",
        username: "tempuser",
    },
    provisioningAction: azure_native.azurestackhci.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

guest_agent = azure_native.azurestackhci.GuestAgent("guestAgent",
    credentials={
        "password": "<password>",
        "username": "tempuser",
    },
    provisioning_action=azure_native.azurestackhci.ProvisioningAction.INSTALL,
    resource_uri="subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM")
Copy
resources:
  guestAgent:
    type: azure-native:azurestackhci:GuestAgent
    properties:
      credentials:
        password: <password>
        username: tempuser
      provisioningAction: install
      resourceUri: subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM
Copy

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_uri: Optional[str] = None,
               credentials: Optional[GuestCredentialArgs] = 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 This property is required. string
The unique name of the resource.
args This property is required. GuestAgentArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. GuestAgentArgs
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. GuestAgentArgs
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. 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()
{
    ResourceUri = "string",
    Credentials = new AzureNative.AzureStackHCI.Inputs.GuestCredentialArgs
    {
        Password = "string",
        Username = "string",
    },
    ProvisioningAction = "string",
});
Copy
example, err := azurestackhci.NewGuestAgent(ctx, "guestAgentResource", &azurestackhci.GuestAgentArgs{
	ResourceUri: pulumi.String("string"),
	Credentials: &azurestackhci.GuestCredentialArgs{
		Password: pulumi.String("string"),
		Username: pulumi.String("string"),
	},
	ProvisioningAction: pulumi.String("string"),
})
Copy
var guestAgentResource = new GuestAgent("guestAgentResource", GuestAgentArgs.builder()
    .resourceUri("string")
    .credentials(GuestCredentialArgs.builder()
        .password("string")
        .username("string")
        .build())
    .provisioningAction("string")
    .build());
Copy
guest_agent_resource = azure_native.azurestackhci.GuestAgent("guestAgentResource",
    resource_uri="string",
    credentials={
        "password": "string",
        "username": "string",
    },
    provisioning_action="string")
Copy
const guestAgentResource = new azure_native.azurestackhci.GuestAgent("guestAgentResource", {
    resourceUri: "string",
    credentials: {
        password: "string",
        username: "string",
    },
    provisioningAction: "string",
});
Copy
type: azure-native:azurestackhci:GuestAgent
properties:
    credentials:
        password: string
        username: string
    provisioningAction: string
    resourceUri: string
Copy

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:

ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
Credentials Pulumi.AzureNative.AzureStackHCI.Inputs.GuestCredential
Username / Password Credentials to provision guest agent.
ProvisioningAction string | Pulumi.AzureNative.AzureStackHCI.ProvisioningAction
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 resource.
Credentials GuestCredentialArgs
Username / Password Credentials to provision guest agent.
ProvisioningAction string | ProvisioningAction
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 resource.
credentials GuestCredential
Username / Password Credentials to provision guest agent.
provisioningAction String | ProvisioningAction
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 resource.
credentials GuestCredential
Username / Password Credentials to provision guest agent.
provisioningAction string | ProvisioningAction
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 resource.
credentials GuestCredentialArgs
Username / Password Credentials to provision guest agent.
provisioning_action str | ProvisioningAction
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 resource.
credentials Property Map
Username / Password Credentials to provision guest agent.
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:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the virtual machine instance.
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"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the virtual machine instance.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the virtual machine instance.
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"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Provisioning state of the virtual machine instance.
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"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Provisioning state of the virtual machine instance.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the virtual machine instance.
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.

ProvisioningAction
, ProvisioningActionArgs

Install
installInstall guest agent
Uninstall
uninstallUninstall guest agent
Repair
repairRepair guest agent
ProvisioningActionInstall
installInstall guest agent
ProvisioningActionUninstall
uninstallUninstall guest agent
ProvisioningActionRepair
repairRepair guest agent
Install
installInstall guest agent
Uninstall
uninstallUninstall guest agent
Repair
repairRepair guest agent
Install
installInstall guest agent
Uninstall
uninstallUninstall guest agent
Repair
repairRepair guest agent
INSTALL
installInstall guest agent
UNINSTALL
uninstallUninstall guest agent
REPAIR
repairRepair guest agent
"install"
installInstall guest agent
"uninstall"
uninstallUninstall guest agent
"repair"
repairRepair guest agent

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 /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native