1. Packages
  2. Azure Native v2
  3. API Docs
  4. hybridcompute
  5. getMachineExtension
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native-v2.hybridcompute.getMachineExtension

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

The operation to get the extension. Azure REST API version: 2022-12-27.

Other available API versions: 2020-08-15-preview, 2022-05-10-preview, 2023-06-20-preview, 2023-10-03-preview, 2024-03-31-preview, 2024-05-20-preview, 2024-07-10, 2024-07-31-preview, 2024-09-10-preview, 2024-11-10-preview.

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,
                          machine_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,
                          machine_name: Optional[pulumi.Input[str]] = None,
                          resource_group_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:hybridcompute: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.
MachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine containing the extension.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ExtensionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine extension.
MachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine containing the extension.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
extensionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine extension.
machineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine containing the extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
extensionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine extension.
machineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the machine containing the extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
extension_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the machine extension.
machine_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the machine containing the extension.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
extensionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine extension.
machineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the machine containing the extension.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

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
Properties Pulumi.AzureNative.HybridCompute.Outputs.MachineExtensionPropertiesResponse
Describes Machine Extension Properties.
SystemData Pulumi.AzureNative.HybridCompute.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"
Tags Dictionary<string, string>
Resource tags.
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
Properties MachineExtensionPropertiesResponse
Describes Machine Extension Properties.
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"
Tags map[string]string
Resource tags.
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
properties MachineExtensionPropertiesResponse
Describes Machine Extension Properties.
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"
tags Map<String,String>
Resource tags.
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
properties MachineExtensionPropertiesResponse
Describes Machine Extension Properties.
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"
tags {[key: string]: string}
Resource tags.
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
properties MachineExtensionPropertiesResponse
Describes Machine Extension Properties.
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"
tags Mapping[str, str]
Resource tags.
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
properties Property Map
Describes Machine Extension Properties.
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"
tags Map<String>
Resource tags.

Supporting Types

MachineExtensionInstanceViewResponse

Name string
The machine extension name.
Status Pulumi.AzureNative.HybridCompute.Inputs.MachineExtensionInstanceViewResponseStatus
Instance view status.
Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string
Specifies the version of the script handler.
Name string
The machine extension name.
Status MachineExtensionInstanceViewResponseStatus
Instance view status.
Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string
Specifies the version of the script handler.
name String
The machine extension name.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
type String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String
Specifies the version of the script handler.
name string
The machine extension name.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
type string
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string
Specifies the version of the script handler.
name str
The machine extension name.
status MachineExtensionInstanceViewResponseStatus
Instance view status.
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 machine extension name.
status Property Map
Instance view status.
type String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String
Specifies the version of the script handler.

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.

MachineExtensionPropertiesResponse

ProvisioningState This property is required. string
The provisioning state, which only appears in the response.
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.HybridCompute.Inputs.MachineExtensionInstanceViewResponse
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.
Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string
Specifies the version of the script handler.
ProvisioningState This property is required. string
The provisioning state, which only appears in the response.
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 MachineExtensionInstanceViewResponse
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.
Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string
Specifies the version of the script handler.
provisioningState This property is required. String
The provisioning state, which only appears in the response.
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 MachineExtensionInstanceViewResponse
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.
type String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String
Specifies the version of the script handler.
provisioningState This property is required. string
The provisioning state, which only appears in the response.
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 MachineExtensionInstanceViewResponse
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.
type string
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string
Specifies the version of the script handler.
provisioning_state This property is required. str
The provisioning state, which only appears in the response.
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 MachineExtensionInstanceViewResponse
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.
type str
Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str
Specifies the version of the script handler.
provisioningState This property is required. String
The provisioning state, which only appears in the response.
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.
type String
Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String
Specifies the version of the script handler.

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi