1. Packages
  2. Azure Native
  3. API Docs
  4. scvmm
  5. getMachineExtension
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.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.scvmm.getMachineExtension

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.0.1 published on Monday, Apr 7, 2025 by Pulumi

The operation to get the extension.

Uses Azure REST API version 2023-04-01-preview.

Other available API versions: 2022-05-21-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native scvmm [ApiVersion]. See the version guide for details.

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>
Copy
def get_machine_extension(extension_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          virtual_machine_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMachineExtensionResult
def get_machine_extension_output(extension_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          virtual_machine_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMachineExtensionResult]
Copy
func LookupMachineExtension(ctx *Context, args *LookupMachineExtensionArgs, opts ...InvokeOption) (*LookupMachineExtensionResult, error)
func LookupMachineExtensionOutput(ctx *Context, args *LookupMachineExtensionOutputArgs, opts ...InvokeOption) LookupMachineExtensionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetMachineExtensionResult> getMachineExtension(GetMachineExtensionArgs args, InvokeOptions options)
public static Output<GetMachineExtensionResult> getMachineExtension(GetMachineExtensionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:scvmm:getMachineExtension
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExtensionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine extension.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine where the extension should be created or updated.
ExtensionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine extension.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine where the extension should be created or updated.
extensionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine where the extension should be created or updated.
extensionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine where the extension should be created or updated.
extension_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the machine extension.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_machine_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the machine where the extension should be created or updated.
extensionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine where the extension should be created or updated.

getMachineExtension 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.ScVmm.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 available.
ForceUpdateTag string
How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView Pulumi.AzureNative.ScVmm.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.
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 available.
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.
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 available.
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.
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 available.
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.
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 available.
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.
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 available.
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 This property is required. string
The status code.
DisplayStatus This property is required. string
The short localizable label for the status.
Level This property is required. string
The level code.
Message This property is required. string
The detailed status message, including for alerts and error messages.
Time This property is required. string
The time of the status.
Code This property is required. string
The status code.
DisplayStatus This property is required. string
The short localizable label for the status.
Level This property is required. string
The level code.
Message This property is required. string
The detailed status message, including for alerts and error messages.
Time This property is required. string
The time of the status.
code This property is required. String
The status code.
displayStatus This property is required. String
The short localizable label for the status.
level This property is required. String
The level code.
message This property is required. String
The detailed status message, including for alerts and error messages.
time This property is required. String
The time of the status.
code This property is required. string
The status code.
displayStatus This property is required. string
The short localizable label for the status.
level This property is required. string
The level code.
message This property is required. string
The detailed status message, including for alerts and error messages.
time This property is required. string
The time of the status.
code This property is required. str
The status code.
display_status This property is required. str
The short localizable label for the status.
level This property is required. str
The level code.
message This property is required. str
The detailed status message, including for alerts and error messages.
time This property is required. str
The time of the status.
code This property is required. String
The status code.
displayStatus This property is required. String
The short localizable label for the status.
level This property is required. String
The level code.
message This property is required. String
The detailed status message, including for alerts and error messages.
time This property is required. String
The time of the status.

MachineExtensionPropertiesResponseInstanceView

Name This property is required. string
The machine extension name.
Type This property is required. string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion This property is required. string
Specifies the version of the script handler.
Status Pulumi.AzureNative.ScVmm.Inputs.MachineExtensionInstanceViewResponseStatus
Instance view status.
Name This property is required. string
The machine extension name.
Type This property is required. string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion This property is required. string
Specifies the version of the script handler.
Status MachineExtensionInstanceViewResponseStatus
Instance view status.
name This property is required. String
The machine extension name.
type This property is required. String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion This property is required. String
Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
name This property is required. string
The machine extension name.
type This property is required. string
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion This property is required. string
Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
name This property is required. str
The machine extension name.
type This property is required. str
Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version This property is required. str
Specifies the version of the script handler.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
name This property is required. String
The machine extension name.
type This property is required. String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion This property is required. String
Specifies the version of the script handler.
status Property Map
Instance view status.

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.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi