1. Packages
  2. Azure Native v1
  3. API Docs
  4. compute
  5. getVirtualMachineScaleSetVMExtension
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.compute.getVirtualMachineScaleSetVMExtension

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    The operation to get the VMSS VM extension. API Version: 2021-03-01.

    Using getVirtualMachineScaleSetVMExtension

    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 getVirtualMachineScaleSetVMExtension(args: GetVirtualMachineScaleSetVMExtensionArgs, opts?: InvokeOptions): Promise<GetVirtualMachineScaleSetVMExtensionResult>
    function getVirtualMachineScaleSetVMExtensionOutput(args: GetVirtualMachineScaleSetVMExtensionOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineScaleSetVMExtensionResult>
    def get_virtual_machine_scale_set_vm_extension(expand: Optional[str] = None,
                                                   instance_id: Optional[str] = None,
                                                   resource_group_name: Optional[str] = None,
                                                   vm_extension_name: Optional[str] = None,
                                                   vm_scale_set_name: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetVirtualMachineScaleSetVMExtensionResult
    def get_virtual_machine_scale_set_vm_extension_output(expand: Optional[pulumi.Input[str]] = None,
                                                   instance_id: Optional[pulumi.Input[str]] = None,
                                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                                   vm_extension_name: Optional[pulumi.Input[str]] = None,
                                                   vm_scale_set_name: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineScaleSetVMExtensionResult]
    func LookupVirtualMachineScaleSetVMExtension(ctx *Context, args *LookupVirtualMachineScaleSetVMExtensionArgs, opts ...InvokeOption) (*LookupVirtualMachineScaleSetVMExtensionResult, error)
    func LookupVirtualMachineScaleSetVMExtensionOutput(ctx *Context, args *LookupVirtualMachineScaleSetVMExtensionOutputArgs, opts ...InvokeOption) LookupVirtualMachineScaleSetVMExtensionResultOutput

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

    public static class GetVirtualMachineScaleSetVMExtension 
    {
        public static Task<GetVirtualMachineScaleSetVMExtensionResult> InvokeAsync(GetVirtualMachineScaleSetVMExtensionArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualMachineScaleSetVMExtensionResult> Invoke(GetVirtualMachineScaleSetVMExtensionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualMachineScaleSetVMExtensionResult> getVirtualMachineScaleSetVMExtension(GetVirtualMachineScaleSetVMExtensionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:compute:getVirtualMachineScaleSetVMExtension
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The instance ID of the virtual machine.
    ResourceGroupName string
    The name of the resource group.
    VmExtensionName string
    The name of the virtual machine extension.
    VmScaleSetName string
    The name of the VM scale set.
    Expand string
    The expand expression to apply on the operation.
    InstanceId string
    The instance ID of the virtual machine.
    ResourceGroupName string
    The name of the resource group.
    VmExtensionName string
    The name of the virtual machine extension.
    VmScaleSetName string
    The name of the VM scale set.
    Expand string
    The expand expression to apply on the operation.
    instanceId String
    The instance ID of the virtual machine.
    resourceGroupName String
    The name of the resource group.
    vmExtensionName String
    The name of the virtual machine extension.
    vmScaleSetName String
    The name of the VM scale set.
    expand String
    The expand expression to apply on the operation.
    instanceId string
    The instance ID of the virtual machine.
    resourceGroupName string
    The name of the resource group.
    vmExtensionName string
    The name of the virtual machine extension.
    vmScaleSetName string
    The name of the VM scale set.
    expand string
    The expand expression to apply on the operation.
    instance_id str
    The instance ID of the virtual machine.
    resource_group_name str
    The name of the resource group.
    vm_extension_name str
    The name of the virtual machine extension.
    vm_scale_set_name str
    The name of the VM scale set.
    expand str
    The expand expression to apply on the operation.
    instanceId String
    The instance ID of the virtual machine.
    resourceGroupName String
    The name of the resource group.
    vmExtensionName String
    The name of the virtual machine extension.
    vmScaleSetName String
    The name of the VM scale set.
    expand String
    The expand expression to apply on the operation.

    getVirtualMachineScaleSetVMExtension Result

    The following output properties are available:

    Id string
    Resource Id
    Name string
    The name of the extension.
    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
    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.
    Publisher string
    The name of the extension handler publisher.
    Settings object
    Json formatted public settings for the extension.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Id string
    Resource Id
    Name string
    The name of the extension.
    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
    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.
    Publisher string
    The name of the extension handler publisher.
    Settings interface{}
    Json formatted public settings for the extension.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    id String
    Resource Id
    name String
    The name of the extension.
    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
    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.
    publisher String
    The name of the extension handler publisher.
    settings Object
    Json formatted public settings for the extension.
    typeHandlerVersion String
    Specifies the version of the script handler.
    id string
    Resource Id
    name string
    The name of the extension.
    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
    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.
    publisher string
    The name of the extension handler publisher.
    settings any
    Json formatted public settings for the extension.
    typeHandlerVersion string
    Specifies the version of the script handler.
    id str
    Resource Id
    name str
    The name of the extension.
    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
    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.
    publisher str
    The name of the extension handler publisher.
    settings Any
    Json formatted public settings for the extension.
    type_handler_version str
    Specifies the version of the script handler.
    id String
    Resource Id
    name String
    The name of the extension.
    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
    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.
    publisher String
    The name of the extension handler publisher.
    settings Any
    Json formatted public settings for the extension.
    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.

    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi