Guest Agent
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/#accessing-any-api-version-via-local-packages 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",
});
});
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
})
}
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());
}
}
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
Properties
The Azure API version of the resource.
Username / Password Credentials to provision guest agent.
The guest agent provisioning action.
Provisioning state of the virtual machine instance.
Azure Resource Manager metadata containing createdBy and modifiedBy information.