Azure Native v3.7.1, Aug 13 25

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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.compute.getVirtualMachineExtension

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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getVirtualMachineExtension

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 getVirtualMachineExtension(args: GetVirtualMachineExtensionArgs, opts?: InvokeOptions): Promise<GetVirtualMachineExtensionResult>
function getVirtualMachineExtensionOutput(args: GetVirtualMachineExtensionOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineExtensionResult>

def get_virtual_machine_extension(expand: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  vm_extension_name: Optional[str] = None,
                                  vm_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetVirtualMachineExtensionResult
def get_virtual_machine_extension_output(expand: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  vm_extension_name: Optional[pulumi.Input[str]] = None,
                                  vm_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineExtensionResult]

func LookupVirtualMachineExtension(ctx *Context, args *LookupVirtualMachineExtensionArgs, opts ...InvokeOption) (*LookupVirtualMachineExtensionResult, error)
func LookupVirtualMachineExtensionOutput(ctx *Context, args *LookupVirtualMachineExtensionOutputArgs, opts ...InvokeOption) LookupVirtualMachineExtensionResultOutput

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

public static class GetVirtualMachineExtension 
{
    public static Task<GetVirtualMachineExtensionResult> InvokeAsync(GetVirtualMachineExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineExtensionResult> Invoke(GetVirtualMachineExtensionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualMachineExtensionResult> getVirtualMachineExtension(GetVirtualMachineExtensionArgs args, InvokeOptions options)
public static Output<GetVirtualMachineExtensionResult> getVirtualMachineExtension(GetVirtualMachineExtensionArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:compute:getVirtualMachineExtension
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
VmExtensionName string: The name of the virtual machine extension.
VmName string: The name of the virtual machine.
Expand string: The expand expression to apply on the operation.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
VmExtensionName string: The name of the virtual machine extension.
VmName string: The name of the virtual machine.
Expand string: The expand expression to apply on the operation.

resourceGroupName String: The name of the resource group. The name is case insensitive.
vmExtensionName String: The name of the virtual machine extension.
vmName String: The name of the virtual machine.
expand String: The expand expression to apply on the operation.

resourceGroupName string: The name of the resource group. The name is case insensitive.
vmExtensionName string: The name of the virtual machine extension.
vmName string: The name of the virtual machine.
expand string: The expand expression to apply on the operation.

resource_group_name str: The name of the resource group. The name is case insensitive.
vm_extension_name str: The name of the virtual machine extension.
vm_name str: The name of the virtual machine.
expand str: The expand expression to apply on the operation.

resourceGroupName String: The name of the resource group. The name is case insensitive.
vmExtensionName String: The name of the virtual machine extension.
vmName String: The name of the virtual machine.
expand String: The expand expression to apply on the operation.

getVirtualMachineExtension Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state, which only appears in the response.
SystemData Pulumi.AzureNative.Compute.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"
AutoUpgradeMinorVersion bool: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
EnableAutomaticUpgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView Pulumi.AzureNative.Compute.Outputs.VirtualMachineExtensionInstanceViewResponse: The virtual machine extension instance view.
ProtectedSettings object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettingsFromKeyVault Pulumi.AzureNative.Compute.Outputs.KeyVaultSecretReferenceResponse: The extensions protected settings that are passed by reference, and consumed from key vault
ProvisionAfterExtensions List<string>: Collection of extension names after which this extension needs to be provisioned.
Publisher string: The name of the extension handler publisher.
Settings object: Json formatted public settings for the extension.
SuppressFailures bool: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
Tags Dictionary<string, string>: Resource tags.
TypeHandlerVersion string: Specifies the version of the script handler.

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state, which only appears in the response.
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"
AutoUpgradeMinorVersion bool: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
EnableAutomaticUpgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView VirtualMachineExtensionInstanceViewResponse: The virtual machine extension instance view.
ProtectedSettings interface{}: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettingsFromKeyVault KeyVaultSecretReferenceResponse: The extensions protected settings that are passed by reference, and consumed from key vault
ProvisionAfterExtensions []string: Collection of extension names after which this extension needs to be provisioned.
Publisher string: The name of the extension handler publisher.
Settings interface{}: Json formatted public settings for the extension.
SuppressFailures bool: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
Tags map[string]string: Resource tags.
TypeHandlerVersion string: Specifies the version of the script handler.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state, which only appears in the response.
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"
autoUpgradeMinorVersion Boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView VirtualMachineExtensionInstanceViewResponse: The virtual machine extension instance view.
protectedSettings Object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault KeyVaultSecretReferenceResponse: The extensions protected settings that are passed by reference, and consumed from key vault
provisionAfterExtensions List<String>: Collection of extension names after which this extension needs to be provisioned.
publisher String: The name of the extension handler publisher.
settings Object: Json formatted public settings for the extension.
suppressFailures Boolean: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
tags Map<String,String>: Resource tags.
typeHandlerVersion String: Specifies the version of the script handler.

azureApiVersion string: The Azure API version of the resource.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
name string: The name of the resource
provisioningState string: The provisioning state, which only appears in the response.
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"
autoUpgradeMinorVersion boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView VirtualMachineExtensionInstanceViewResponse: The virtual machine extension instance view.
protectedSettings any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault KeyVaultSecretReferenceResponse: The extensions protected settings that are passed by reference, and consumed from key vault
provisionAfterExtensions string[]: Collection of extension names after which this extension needs to be provisioned.
publisher string: The name of the extension handler publisher.
settings any: Json formatted public settings for the extension.
suppressFailures boolean: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
tags {[key: string]: string}: Resource tags.
typeHandlerVersion string: Specifies the version of the script handler.

azure_api_version str: The Azure API version of the resource.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
name str: The name of the resource
provisioning_state str: The provisioning state, which only appears in the response.
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"
auto_upgrade_minor_version bool: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enable_automatic_upgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
force_update_tag str: How the extension handler should be forced to update even if the extension configuration has not changed.
instance_view VirtualMachineExtensionInstanceViewResponse: The virtual machine extension instance view.
protected_settings Any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protected_settings_from_key_vault KeyVaultSecretReferenceResponse: The extensions protected settings that are passed by reference, and consumed from key vault
provision_after_extensions Sequence[str]: Collection of extension names after which this extension needs to be provisioned.
publisher str: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
suppress_failures bool: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
tags Mapping[str, str]: Resource tags.
type_handler_version str: Specifies the version of the script handler.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state, which only appears in the response.
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"
autoUpgradeMinorVersion Boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView Property Map: The virtual machine extension instance view.
protectedSettings Any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault Property Map: The extensions protected settings that are passed by reference, and consumed from key vault
provisionAfterExtensions List<String>: Collection of extension names after which this extension needs to be provisioned.
publisher String: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
suppressFailures Boolean: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
tags Map<String>: Resource tags.
typeHandlerVersion String: Specifies the version of the script handler.

Supporting Types

InstanceViewStatusResponse

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

code string: The status code.
displayStatus string: The short localizable label for the status.
level string: The level code.
message string: The detailed status message, including for alerts and error messages.
time string: The time of the status.

code str: The status code.
display_status str: The short localizable label for the status.
level str: The level code.
message str: The detailed status message, including for alerts and error messages.
time str: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

KeyVaultSecretReferenceResponse

SecretUrl string: The URL referencing a secret in a Key Vault.
SourceVault Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The relative URL of the Key Vault containing the secret.

SecretUrl string: The URL referencing a secret in a Key Vault.
SourceVault SubResourceResponse: The relative URL of the Key Vault containing the secret.

secretUrl String: The URL referencing a secret in a Key Vault.
sourceVault SubResourceResponse: The relative URL of the Key Vault containing the secret.

secretUrl string: The URL referencing a secret in a Key Vault.
sourceVault SubResourceResponse: The relative URL of the Key Vault containing the secret.

secret_url str: The URL referencing a secret in a Key Vault.
source_vault SubResourceResponse: The relative URL of the Key Vault containing the secret.

secretUrl String: The URL referencing a secret in a Key Vault.
sourceVault Property Map: The relative URL of the Key Vault containing the secret.

SubResourceResponse

Id string: Resource Id

Id string: Resource Id

id String: Resource Id

id string: Resource Id

id str: Resource Id

id String: Resource Id

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.

VirtualMachineExtensionInstanceViewResponse

Name string: The virtual machine extension name.
Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>: The resource status information.
Substatuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

Name string: The virtual machine extension name.
Statuses []InstanceViewStatusResponse: The resource status information.
Substatuses []InstanceViewStatusResponse: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<InstanceViewStatusResponse>: The resource status information.
substatuses List<InstanceViewStatusResponse>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

name string: The virtual machine extension name.
statuses InstanceViewStatusResponse[]: The resource status information.
substatuses InstanceViewStatusResponse[]: The resource status information.
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.

name str: The virtual machine extension name.
statuses Sequence[InstanceViewStatusResponse]: The resource status information.
substatuses Sequence[InstanceViewStatusResponse]: The resource status information.
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<Property Map>: The resource status information.
substatuses List<Property Map>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.compute.getVirtualMachineExtension

On this page

On this page

Using getVirtualMachineExtension

getVirtualMachineExtension Result

Supporting Types

InstanceViewStatusResponse

KeyVaultSecretReferenceResponse

SubResourceResponse

SystemDataResponse

VirtualMachineExtensionInstanceViewResponse

Package Details

On this page

On this page