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

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

Implements GuestAgent GET method. Azure REST API version: 2022-05-21-preview.

Other available API versions: 2023-04-01-preview, 2023-10-07, 2024-06-01.

Using getGuestAgent

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 getGuestAgent(args: GetGuestAgentArgs, opts?: InvokeOptions): Promise<GetGuestAgentResult>
function getGuestAgentOutput(args: GetGuestAgentOutputArgs, opts?: InvokeOptions): Output<GetGuestAgentResult>
Copy
def get_guest_agent(guest_agent_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    virtual_machine_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetGuestAgentResult
def get_guest_agent_output(guest_agent_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    virtual_machine_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetGuestAgentResult]
Copy
func LookupGuestAgent(ctx *Context, args *LookupGuestAgentArgs, opts ...InvokeOption) (*LookupGuestAgentResult, error)
func LookupGuestAgentOutput(ctx *Context, args *LookupGuestAgentOutputArgs, opts ...InvokeOption) LookupGuestAgentResultOutput
Copy

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

public static class GetGuestAgent 
{
    public static Task<GetGuestAgentResult> InvokeAsync(GetGuestAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetGuestAgentResult> Invoke(GetGuestAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGuestAgentResult> getGuestAgent(GetGuestAgentArgs args, InvokeOptions options)
public static Output<GetGuestAgentResult> getGuestAgent(GetGuestAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:scvmm:getGuestAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GuestAgentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the GuestAgent.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
Name of the vm.
GuestAgentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the GuestAgent.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
Name of the vm.
guestAgentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the GuestAgent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
Name of the vm.
guestAgentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the GuestAgent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
Name of the vm.
guest_agent_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the GuestAgent.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_machine_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the vm.
guestAgentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the GuestAgent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
Name of the vm.

getGuestAgent Result

The following output properties are available:

CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
Credentials Pulumi.AzureNative.ScVmm.Outputs.GuestCredentialResponse
Username / Password Credentials to provision guest agent.
HttpProxyConfig Pulumi.AzureNative.ScVmm.Outputs.HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
ProvisioningAction string
Gets or sets the guest agent provisioning action.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
Credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
HttpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
ProvisioningAction string
Gets or sets the guest agent provisioning action.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
provisioningAction String
Gets or sets the guest agent provisioning action.
customResourceName string
Gets the name of the corresponding resource in Kubernetes.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
httpProxyConfig HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
provisioningAction string
Gets or sets the guest agent provisioning action.
custom_resource_name str
Gets the name of the corresponding resource in Kubernetes.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
credentials GuestCredentialResponse
Username / Password Credentials to provision guest agent.
http_proxy_config HttpProxyConfigurationResponse
HTTP Proxy configuration for the VM.
provisioning_action str
Gets or sets the guest agent provisioning action.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
credentials Property Map
Username / Password Credentials to provision guest agent.
httpProxyConfig Property Map
HTTP Proxy configuration for the VM.
provisioningAction String
Gets or sets the guest agent provisioning action.

Supporting Types

GuestCredentialResponse

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.

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.

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