Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getVirtualMachineScaleSetExtension
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.compute.getVirtualMachineScaleSetExtension

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    The operation to get the extension. Azure REST API version: 2023-03-01.

    Other available API versions: 2021-11-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.

    Using getVirtualMachineScaleSetExtension

    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 getVirtualMachineScaleSetExtension(args: GetVirtualMachineScaleSetExtensionArgs, opts?: InvokeOptions): Promise<GetVirtualMachineScaleSetExtensionResult>
function getVirtualMachineScaleSetExtensionOutput(args: GetVirtualMachineScaleSetExtensionOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineScaleSetExtensionResult>
    def get_virtual_machine_scale_set_extension(expand: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            vm_scale_set_name: Optional[str] = None,
                                            vmss_extension_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetVirtualMachineScaleSetExtensionResult
def get_virtual_machine_scale_set_extension_output(expand: Optional[pulumi.Input[str]] = None,
                                            resource_group_name: Optional[pulumi.Input[str]] = None,
                                            vm_scale_set_name: Optional[pulumi.Input[str]] = None,
                                            vmss_extension_name: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineScaleSetExtensionResult]
    func LookupVirtualMachineScaleSetExtension(ctx *Context, args *LookupVirtualMachineScaleSetExtensionArgs, opts ...InvokeOption) (*LookupVirtualMachineScaleSetExtensionResult, error)
func LookupVirtualMachineScaleSetExtensionOutput(ctx *Context, args *LookupVirtualMachineScaleSetExtensionOutputArgs, opts ...InvokeOption) LookupVirtualMachineScaleSetExtensionResultOutput

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

    public static class GetVirtualMachineScaleSetExtension 
{
    public static Task<GetVirtualMachineScaleSetExtensionResult> InvokeAsync(GetVirtualMachineScaleSetExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineScaleSetExtensionResult> Invoke(GetVirtualMachineScaleSetExtensionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualMachineScaleSetExtensionResult> getVirtualMachineScaleSetExtension(GetVirtualMachineScaleSetExtensionArgs args, InvokeOptions options)
public static Output<GetVirtualMachineScaleSetExtensionResult> getVirtualMachineScaleSetExtension(GetVirtualMachineScaleSetExtensionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    VmScaleSetName string
    The name of the VM scale set containing the extension.
    VmssExtensionName string
    The name of the VM scale set extension.
    Expand string
    The expand expression to apply on the operation.
    ResourceGroupName string
    The name of the resource group.
    VmScaleSetName string
    The name of the VM scale set containing the extension.
    VmssExtensionName string
    The name of the VM scale set extension.
    Expand string
    The expand expression to apply on the operation.
    resourceGroupName String
    The name of the resource group.
    vmScaleSetName String
    The name of the VM scale set containing the extension.
    vmssExtensionName String
    The name of the VM scale set extension.
    expand String
    The expand expression to apply on the operation.
    resourceGroupName string
    The name of the resource group.
    vmScaleSetName string
    The name of the VM scale set containing the extension.
    vmssExtensionName string
    The name of the VM scale set extension.
    expand string
    The expand expression to apply on the operation.
    resource_group_name str
    The name of the resource group.
    vm_scale_set_name str
    The name of the VM scale set containing the extension.
    vmss_extension_name str
    The name of the VM scale set extension.
    expand str
    The expand expression to apply on the operation.
    resourceGroupName String
    The name of the resource group.
    vmScaleSetName String
    The name of the VM scale set containing the extension.
    vmssExtensionName String
    The name of the VM scale set extension.
    expand String
    The expand expression to apply on the operation.

    getVirtualMachineScaleSetExtension Result

    The following output properties are available:

    Id string
    Resource Id
    ProvisioningState string
    The provisioning state, which only appears in the response.
    Type string
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    Name string
    The name of the extension.
    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.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Id string
    Resource Id
    ProvisioningState string
    The provisioning state, which only appears in the response.
    Type string
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    Name string
    The name of the extension.
    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.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    id String
    Resource Id
    provisioningState String
    The provisioning state, which only appears in the response.
    type String
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    name String
    The name of the extension.
    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.
    typeHandlerVersion String
    Specifies the version of the script handler.
    id string
    Resource Id
    provisioningState string
    The provisioning state, which only appears in the response.
    type string
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    name string
    The name of the extension.
    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.
    typeHandlerVersion string
    Specifies the version of the script handler.
    id str
    Resource Id
    provisioning_state str
    The provisioning state, which only appears in the response.
    type str
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    name str
    The name of the extension.
    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.
    type_handler_version str
    Specifies the version of the script handler.
    id String
    Resource Id
    provisioningState String
    The provisioning state, which only appears in the response.
    type String
    Resource type
    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
    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
    name String
    The name of the extension.
    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.
    typeHandlerVersion String
    Specifies the version of the script handler.

    Supporting Types

    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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native