Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. connectedvmwarevsphere
  5. getVMInstanceGuestAgent
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.connectedvmwarevsphere.getVMInstanceGuestAgent

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

Implements GuestAgent GET method.

Uses Azure REST API version 2023-12-01.

Other available API versions: 2023-03-01-preview, 2023-10-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native connectedvmwarevsphere [ApiVersion]. See the version guide for details.

Using getVMInstanceGuestAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVMInstanceGuestAgent(args: GetVMInstanceGuestAgentArgs, opts?: InvokeOptions): Promise<GetVMInstanceGuestAgentResult>
function getVMInstanceGuestAgentOutput(args: GetVMInstanceGuestAgentOutputArgs, opts?: InvokeOptions): Output<GetVMInstanceGuestAgentResult>
Copy
def get_vm_instance_guest_agent(resource_uri: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetVMInstanceGuestAgentResult
def get_vm_instance_guest_agent_output(resource_uri: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetVMInstanceGuestAgentResult]
Copy
func LookupVMInstanceGuestAgent(ctx *Context, args *LookupVMInstanceGuestAgentArgs, opts ...InvokeOption) (*LookupVMInstanceGuestAgentResult, error)
func LookupVMInstanceGuestAgentOutput(ctx *Context, args *LookupVMInstanceGuestAgentOutputArgs, opts ...InvokeOption) LookupVMInstanceGuestAgentResultOutput
Copy

> Note: This function is named LookupVMInstanceGuestAgent in the Go SDK.

public static class GetVMInstanceGuestAgent 
{
    public static Task<GetVMInstanceGuestAgentResult> InvokeAsync(GetVMInstanceGuestAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetVMInstanceGuestAgentResult> Invoke(GetVMInstanceGuestAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVMInstanceGuestAgentResult> getVMInstanceGuestAgent(GetVMInstanceGuestAgentArgs args, InvokeOptions options)
public static Output<GetVMInstanceGuestAgentResult> getVMInstanceGuestAgent(GetVMInstanceGuestAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:connectedvmwarevsphere:getVMInstanceGuestAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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.
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.
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.
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.
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.
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.

getVMInstanceGuestAgent Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
Gets the provisioning state.
Status string
Gets or sets the guest agent status.
Statuses List<Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.ResourceStatusResponse>
The resource status information.
SystemData Pulumi.AzureNative.ConnectedVMwarevSphere.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.
Credentials Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.GuestCredentialResponse
Username / Password Credentials to provision guest agent.
HttpProxyConfig Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
PrivateLinkScopeResourceId string
The resource id of the private link scope this machine is assigned to, if any.
ProvisioningAction string
Gets or sets the guest agent provisioning action.
AzureApiVersion string
The Azure API version of the resource.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
Gets the provisioning state.
Status string
Gets or sets the guest agent status.
Statuses []ResourceStatusResponse
The resource status information.
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.
Credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
HttpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
PrivateLinkScopeResourceId string
The resource id of the private link scope this machine is assigned to, if any.
ProvisioningAction string
Gets or sets the guest agent provisioning action.
azureApiVersion String
The Azure API version of the resource.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
Gets the provisioning state.
status String
Gets or sets the guest agent status.
statuses List<ResourceStatusResponse>
The resource status information.
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
privateLinkScopeResourceId String
The resource id of the private link scope this machine is assigned to, if any.
provisioningAction String
Gets or sets the guest agent provisioning action.
azureApiVersion string
The Azure API version of the resource.
customResourceName string
Gets the name of the corresponding resource in Kubernetes.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
provisioningState string
Gets the provisioning state.
status string
Gets or sets the guest agent status.
statuses ResourceStatusResponse[]
The resource status information.
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
privateLinkScopeResourceId string
The resource id of the private link scope this machine is assigned to, if any.
provisioningAction string
Gets or sets the guest agent provisioning action.
azure_api_version str
The Azure API version of the resource.
custom_resource_name str
Gets the name of the corresponding resource in Kubernetes.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
provisioning_state str
Gets the provisioning state.
status str
Gets or sets the guest agent status.
statuses Sequence[ResourceStatusResponse]
The resource status information.
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
http_proxy_config HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
private_link_scope_resource_id str
The resource id of the private link scope this machine is assigned to, if any.
provisioning_action str
Gets or sets the guest agent provisioning action.
azureApiVersion String
The Azure API version of the resource.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
Gets the provisioning state.
status String
Gets or sets the guest agent status.
statuses List<Property Map>
The resource status information.
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.
credentials Property Map
Username / Password Credentials to provision guest agent.
httpProxyConfig Property Map
HTTP Proxy configuration for the VM.
privateLinkScopeResourceId String
The resource id of the private link scope this machine is assigned to, if any.
provisioningAction String
Gets or sets the guest agent provisioning action.

Supporting Types

GuestCredentialResponse

PrivateKey string
Private key used to authenticate to a virtual machine through ssh.
Username string
Gets or sets username to connect with the guest.
PrivateKey string
Private key used to authenticate to a virtual machine through ssh.
Username string
Gets or sets username to connect with the guest.
privateKey String
Private key used to authenticate to a virtual machine through ssh.
username String
Gets or sets username to connect with the guest.
privateKey string
Private key used to authenticate to a virtual machine through ssh.
username string
Gets or sets username to connect with the guest.
private_key str
Private key used to authenticate to a virtual machine through ssh.
username str
Gets or sets username to connect with the guest.
privateKey String
Private key used to authenticate to a virtual machine through ssh.
username String
Gets or sets username to connect with the guest.

HttpProxyConfigurationResponse

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.

ResourceStatusResponse

LastUpdatedAt This property is required. string
The last update time for this condition.
Message This property is required. string
A human readable message indicating details about the status.
Reason This property is required. string
The reason for the condition's status.
Severity This property is required. string
Severity with which to treat failures of this type of condition.
Status This property is required. string
Status of the condition.
Type This property is required. string
The type of the condition.
LastUpdatedAt This property is required. string
The last update time for this condition.
Message This property is required. string
A human readable message indicating details about the status.
Reason This property is required. string
The reason for the condition's status.
Severity This property is required. string
Severity with which to treat failures of this type of condition.
Status This property is required. string
Status of the condition.
Type This property is required. string
The type of the condition.
lastUpdatedAt This property is required. String
The last update time for this condition.
message This property is required. String
A human readable message indicating details about the status.
reason This property is required. String
The reason for the condition's status.
severity This property is required. String
Severity with which to treat failures of this type of condition.
status This property is required. String
Status of the condition.
type This property is required. String
The type of the condition.
lastUpdatedAt This property is required. string
The last update time for this condition.
message This property is required. string
A human readable message indicating details about the status.
reason This property is required. string
The reason for the condition's status.
severity This property is required. string
Severity with which to treat failures of this type of condition.
status This property is required. string
Status of the condition.
type This property is required. string
The type of the condition.
last_updated_at This property is required. str
The last update time for this condition.
message This property is required. str
A human readable message indicating details about the status.
reason This property is required. str
The reason for the condition's status.
severity This property is required. str
Severity with which to treat failures of this type of condition.
status This property is required. str
Status of the condition.
type This property is required. str
The type of the condition.
lastUpdatedAt This property is required. String
The last update time for this condition.
message This property is required. String
A human readable message indicating details about the status.
reason This property is required. String
The reason for the condition's status.
severity This property is required. String
Severity with which to treat failures of this type of condition.
status This property is required. String
Status of the condition.
type This property is required. String
The type of the condition.

SystemDataResponse

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.

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