azure-native.compute.getVirtualMachineExtension

Explore with Pulumi AI

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

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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:compute:getVirtualMachineExtension
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group.

VmExtensionName string

The name of the virtual machine extension.

VmName string

The name of the virtual machine containing the extension.

Expand string

The expand expression to apply on the operation.

ResourceGroupName string

The name of the resource group.

VmExtensionName string

The name of the virtual machine extension.

VmName string

The name of the virtual machine containing the extension.

Expand string

The expand expression to apply on the operation.

resourceGroupName String

The name of the resource group.

vmExtensionName String

The name of the virtual machine extension.

vmName String

The name of the virtual machine containing the extension.

expand String

The expand expression to apply on the operation.

resourceGroupName string

The name of the resource group.

vmExtensionName string

The name of the virtual machine extension.

vmName string

The name of the virtual machine containing the extension.

expand string

The expand expression to apply on the operation.

resource_group_name str

The name of the resource group.

vm_extension_name str

The name of the virtual machine extension.

vm_name str

The name of the virtual machine containing the extension.

expand str

The expand expression to apply on the operation.

resourceGroupName String

The name of the resource group.

vmExtensionName String

The name of the virtual machine extension.

vmName String

The name of the virtual machine containing the extension.

expand String

The expand expression to apply on the operation.

getVirtualMachineExtension Result

The following output properties are available:

Id string

Resource Id

Location string

Resource location

Name string

Resource name

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.

Tags Dictionary<string, string>

Resource tags

TypeHandlerVersion string

Specifies the version of the script handler.

Id string

Resource Id

Location string

Resource location

Name string

Resource name

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.

Tags map[string]string

Resource tags

TypeHandlerVersion string

Specifies the version of the script handler.

id String

Resource Id

location String

Resource location

name String

Resource name

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.

tags Map<String,String>

Resource tags

typeHandlerVersion String

Specifies the version of the script handler.

id string

Resource Id

location string

Resource location

name string

Resource name

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.

tags {[key: string]: string}

Resource tags

typeHandlerVersion string

Specifies the version of the script handler.

id str

Resource Id

location str

Resource location

name str

Resource name

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.

tags Mapping[str, str]

Resource tags

type_handler_version str

Specifies the version of the script handler.

id String

Resource Id

location String

Resource location

name String

Resource name

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.

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.

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