Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

getMachineExtension

Describes a Machine Extension. API Version: 2020-08-02.

Using getMachineExtension

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 getMachineExtension(args: GetMachineExtensionArgs, opts?: InvokeOptions): Promise<GetMachineExtensionResult>
function getMachineExtensionOutput(args: GetMachineExtensionOutputArgs, opts?: InvokeOptions): Output<GetMachineExtensionResult>

def get_machine_extension(extension_name: Optional[str] = None,
                          name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMachineExtensionResult
def get_machine_extension_output(extension_name: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMachineExtensionResult]

func LookupMachineExtension(ctx *Context, args *LookupMachineExtensionArgs, opts ...InvokeOption) (*LookupMachineExtensionResult, error)
func LookupMachineExtensionOutput(ctx *Context, args *LookupMachineExtensionOutputArgs, opts ...InvokeOption) LookupMachineExtensionResultOutput

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

public static class GetMachineExtension 
{
    public static Task<GetMachineExtensionResult> InvokeAsync(GetMachineExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetMachineExtensionResult> Invoke(GetMachineExtensionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMachineExtensionResult> getMachineExtension(GetMachineExtensionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:hybridcompute:getMachineExtension
  arguments:
    # arguments dictionary

The following arguments are supported:

ExtensionName string: The name of the machine extension.
Name string: The name of the machine containing the extension.
ResourceGroupName string: The name of the resource group.

ExtensionName string: The name of the machine extension.
Name string: The name of the machine containing the extension.
ResourceGroupName string: The name of the resource group.

extensionName String: The name of the machine extension.
name String: The name of the machine containing the extension.
resourceGroupName String: The name of the resource group.

extensionName string: The name of the machine extension.
name string: The name of the machine containing the extension.
resourceGroupName string: The name of the resource group.

extension_name str: The name of the machine extension.
name str: The name of the machine containing the extension.
resource_group_name str: The name of the resource group.

extensionName String: The name of the machine extension.
name String: The name of the machine containing the extension.
resourceGroupName String: The name of the resource group.

getMachineExtension Result

The following output properties are available:

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.
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.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView Pulumi.AzureNative.HybridCompute.Outputs.MachineExtensionPropertiesResponseInstanceView: The 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: 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.
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.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView MachineExtensionPropertiesResponseInstanceView: The 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: 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.
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.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView MachineExtensionPropertiesResponseInstanceView: The 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: 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.
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.
forceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView MachineExtensionPropertiesResponseInstanceView: The 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: 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.
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.
force_update_tag str: How the extension handler should be forced to update even if the extension configuration has not changed.
instance_view MachineExtensionPropertiesResponseInstanceView: The 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: 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.
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.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView Property Map: The 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

MachineExtensionInstanceViewResponseStatus

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.

MachineExtensionPropertiesResponseInstanceView

Name string: The machine extension name.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.
Status Pulumi.AzureNative.HybridCompute.Inputs.MachineExtensionInstanceViewResponseStatus: Instance view status.

Name string: The machine extension name.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.
Status MachineExtensionInstanceViewResponseStatus: Instance view status.

name String: The machine extension name.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus: Instance view status.

name string: The machine extension name.
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus: Instance view status.

name str: The machine extension name.
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus: Instance view status.

name String: The machine extension name.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.
status Property Map: Instance view status.

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0