Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getExtension
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.getExtension

Explore with Pulumi AI

azure-native logo
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get particular Arc Extension of HCI Cluster.

    Uses Azure REST API version 2024-04-01.

    Other available API versions: 2022-12-15-preview, 2023-02-01, 2023-03-01, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-09-01-preview, 2024-12-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

    Using getExtension

    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 getExtension(args: GetExtensionArgs, opts?: InvokeOptions): Promise<GetExtensionResult>
function getExtensionOutput(args: GetExtensionOutputArgs, opts?: InvokeOptions): Output<GetExtensionResult>
    def get_extension(arc_setting_name: Optional[str] = None,
                  cluster_name: Optional[str] = None,
                  extension_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetExtensionResult
def get_extension_output(arc_setting_name: Optional[pulumi.Input[str]] = None,
                  cluster_name: Optional[pulumi.Input[str]] = None,
                  extension_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetExtensionResult]
    func LookupExtension(ctx *Context, args *LookupExtensionArgs, opts ...InvokeOption) (*LookupExtensionResult, error)
func LookupExtensionOutput(ctx *Context, args *LookupExtensionOutputArgs, opts ...InvokeOption) LookupExtensionResultOutput

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

    public static class GetExtension 
{
    public static Task<GetExtensionResult> InvokeAsync(GetExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetExtensionResult> Invoke(GetExtensionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)
public static Output<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getExtension
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ArcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    ClusterName string
    The name of the cluster.
    ExtensionName string
    The name of the machine extension.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ArcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    ClusterName string
    The name of the cluster.
    ExtensionName string
    The name of the machine extension.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    arcSettingName String
    The name of the proxy resource holding details of HCI ArcSetting information.
    clusterName String
    The name of the cluster.
    extensionName String
    The name of the machine extension.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    arcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    clusterName string
    The name of the cluster.
    extensionName string
    The name of the machine extension.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    arc_setting_name str
    The name of the proxy resource holding details of HCI ArcSetting information.
    cluster_name str
    The name of the cluster.
    extension_name str
    The name of the machine extension.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    arcSettingName String
    The name of the proxy resource holding details of HCI ArcSetting information.
    clusterName String
    The name of the cluster.
    extensionName String
    The name of the machine extension.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getExtension Result

    The following output properties are available:

    AggregateState string
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    ManagedBy string
    Indicates if the extension is managed by azure or the user.
    Name string
    The name of the resource
    PerNodeExtensionDetails List<Pulumi.AzureNative.AzureStackHCI.Outputs.PerNodeExtensionStateResponse>
    State of Arc Extension in each of the nodes.
    ProvisioningState string
    Provisioning state of the Extension proxy resource.
    SystemData Pulumi.AzureNative.AzureStackHCI.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.
    ProtectedSettings object
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.
    AggregateState string
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    ManagedBy string
    Indicates if the extension is managed by azure or the user.
    Name string
    The name of the resource
    PerNodeExtensionDetails []PerNodeExtensionStateResponse
    State of Arc Extension in each of the nodes.
    ProvisioningState string
    Provisioning state of the Extension proxy resource.
    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.
    ProtectedSettings interface{}
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.
    aggregateState String
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    managedBy String
    Indicates if the extension is managed by azure or the user.
    name String
    The name of the resource
    perNodeExtensionDetails List<PerNodeExtensionStateResponse>
    State of Arc Extension in each of the nodes.
    provisioningState String
    Provisioning state of the Extension proxy resource.
    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.
    protectedSettings Object
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.
    aggregateState string
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    managedBy string
    Indicates if the extension is managed by azure or the user.
    name string
    The name of the resource
    perNodeExtensionDetails PerNodeExtensionStateResponse[]
    State of Arc Extension in each of the nodes.
    provisioningState string
    Provisioning state of the Extension proxy resource.
    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.
    protectedSettings any
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.
    aggregate_state str
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    managed_by str
    Indicates if the extension is managed by azure or the user.
    name str
    The name of the resource
    per_node_extension_details Sequence[PerNodeExtensionStateResponse]
    State of Arc Extension in each of the nodes.
    provisioning_state str
    Provisioning state of the Extension proxy resource.
    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.
    protected_settings Any
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.
    aggregateState String
    Aggregate state of Arc Extensions across the nodes in this HCI cluster.
    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}
    managedBy String
    Indicates if the extension is managed by azure or the user.
    name String
    The name of the resource
    perNodeExtensionDetails List<Property Map>
    State of Arc Extension in each of the nodes.
    provisioningState String
    Provisioning state of the Extension proxy resource.
    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.
    protectedSettings Any
    Protected settings (may contain secrets).
    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. Latest version would be used if not specified.

    Supporting Types

    ExtensionInstanceViewResponse

    Name string
    The extension name.
    Status Pulumi.AzureNative.AzureStackHCI.Inputs.ExtensionInstanceViewResponseStatus
    Instance view status.
    Type string
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Name string
    The extension name.
    Status ExtensionInstanceViewResponseStatus
    Instance view status.
    Type string
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    name String
    The extension name.
    status ExtensionInstanceViewResponseStatus
    Instance view status.
    type String
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    typeHandlerVersion String
    Specifies the version of the script handler.
    name string
    The extension name.
    status ExtensionInstanceViewResponseStatus
    Instance view status.
    type string
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    typeHandlerVersion string
    Specifies the version of the script handler.
    name str
    The extension name.
    status ExtensionInstanceViewResponseStatus
    Instance view status.
    type str
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    type_handler_version str
    Specifies the version of the script handler.
    name String
    The extension name.
    status Property Map
    Instance view status.
    type String
    Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
    typeHandlerVersion String
    Specifies the version of the script handler.

    ExtensionInstanceViewResponseStatus

    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.

    PerNodeExtensionStateResponse

    Extension string
    Fully qualified resource ID for the particular Arc Extension on this node.
    InstanceView Pulumi.AzureNative.AzureStackHCI.Inputs.ExtensionInstanceViewResponse
    The extension instance view.
    Name string
    Name of the node in HCI Cluster.
    State string
    State of Arc Extension in this node.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Extension string
    Fully qualified resource ID for the particular Arc Extension on this node.
    InstanceView ExtensionInstanceViewResponse
    The extension instance view.
    Name string
    Name of the node in HCI Cluster.
    State string
    State of Arc Extension in this node.
    TypeHandlerVersion string
    Specifies the version of the script handler.
    extension String
    Fully qualified resource ID for the particular Arc Extension on this node.
    instanceView ExtensionInstanceViewResponse
    The extension instance view.
    name String
    Name of the node in HCI Cluster.
    state String
    State of Arc Extension in this node.
    typeHandlerVersion String
    Specifies the version of the script handler.
    extension string
    Fully qualified resource ID for the particular Arc Extension on this node.
    instanceView ExtensionInstanceViewResponse
    The extension instance view.
    name string
    Name of the node in HCI Cluster.
    state string
    State of Arc Extension in this node.
    typeHandlerVersion string
    Specifies the version of the script handler.
    extension str
    Fully qualified resource ID for the particular Arc Extension on this node.
    instance_view ExtensionInstanceViewResponse
    The extension instance view.
    name str
    Name of the node in HCI Cluster.
    state str
    State of Arc Extension in this node.
    type_handler_version str
    Specifies the version of the script handler.
    extension String
    Fully qualified resource ID for the particular Arc Extension on this node.
    instanceView Property Map
    The extension instance view.
    name String
    Name of the node in HCI Cluster.
    state String
    State of Arc Extension in this node.
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native