This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.azurestackhci.getExtension
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Get particular Arc Extension of HCI Cluster. Azure REST API version: 2023-03-01.
Other available API versions: 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.
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 dictionaryThe following arguments are supported:
- ArcSetting stringName 
- 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.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ArcSetting stringName 
- 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.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- arcSetting StringName 
- 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.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- arcSetting stringName 
- 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.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- arc_setting_ strname 
- 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_ strname 
- The name of the resource group. The name is case insensitive.
- arcSetting StringName 
- 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.
- resourceGroup StringName 
- 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.
- 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
- PerNode List<Pulumi.Extension Details Azure Native. Azure Stack HCI. Outputs. Per Node Extension State Response> 
- State of Arc Extension in each of the nodes.
- ProvisioningState string
- Provisioning state of the Extension proxy resource.
- SystemData Pulumi.Azure Native. Azure Stack HCI. Outputs. System Data Response 
- 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"
- AutoUpgrade boolMinor Version 
- 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.
- EnableAutomatic boolUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- ForceUpdate stringTag 
- 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.
- TypeHandler stringVersion 
- 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.
- 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
- PerNode []PerExtension Details Node Extension State Response 
- State of Arc Extension in each of the nodes.
- ProvisioningState string
- Provisioning state of the Extension proxy resource.
- SystemData SystemData Response 
- 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"
- AutoUpgrade boolMinor Version 
- 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.
- EnableAutomatic boolUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- ForceUpdate stringTag 
- 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.
- TypeHandler stringVersion 
- 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.
- 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
- perNode List<PerExtension Details Node Extension State Response> 
- State of Arc Extension in each of the nodes.
- provisioningState String
- Provisioning state of the Extension proxy resource.
- systemData SystemData Response 
- 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"
- autoUpgrade BooleanMinor Version 
- 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.
- enableAutomatic BooleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- forceUpdate StringTag 
- 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.
- typeHandler StringVersion 
- 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.
- 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
- perNode PerExtension Details Node Extension State Response[] 
- State of Arc Extension in each of the nodes.
- provisioningState string
- Provisioning state of the Extension proxy resource.
- systemData SystemData Response 
- 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"
- autoUpgrade booleanMinor Version 
- 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.
- enableAutomatic booleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- forceUpdate stringTag 
- 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.
- typeHandler stringVersion 
- 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.
- 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_ Sequence[Perextension_ details Node Extension State Response] 
- State of Arc Extension in each of the nodes.
- provisioning_state str
- Provisioning state of the Extension proxy resource.
- system_data SystemData Response 
- 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_ boolminor_ version 
- 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_ boolupgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- force_update_ strtag 
- 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_ strversion 
- 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.
- 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
- perNode List<Property Map>Extension Details 
- 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"
- autoUpgrade BooleanMinor Version 
- 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.
- enableAutomatic BooleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- forceUpdate StringTag 
- 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.
- typeHandler StringVersion 
- 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.Azure Native. Azure Stack HCI. Inputs. Extension Instance View Response Status 
- Instance view status.
- Type string
- Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- Name string
- The extension name.
- Status
ExtensionInstance View Response Status 
- Instance view status.
- Type string
- Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- name String
- The extension name.
- status
ExtensionInstance View Response Status 
- Instance view status.
- type String
- Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
- typeHandler StringVersion 
- Specifies the version of the script handler.
- name string
- The extension name.
- status
ExtensionInstance View Response Status 
- Instance view status.
- type string
- Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
- typeHandler stringVersion 
- Specifies the version of the script handler.
- name str
- The extension name.
- status
ExtensionInstance View Response Status 
- Instance view status.
- type str
- Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
- type_handler_ strversion 
- 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".
- typeHandler StringVersion 
- 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.Azure Native. Azure Stack HCI. Inputs. Extension Instance View Response 
- The extension instance view.
- Name string
- Name of the node in HCI Cluster.
- State string
- State of Arc Extension in this node.
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- Extension string
- Fully qualified resource ID for the particular Arc Extension on this node.
- InstanceView ExtensionInstance View Response 
- The extension instance view.
- Name string
- Name of the node in HCI Cluster.
- State string
- State of Arc Extension in this node.
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- extension String
- Fully qualified resource ID for the particular Arc Extension on this node.
- instanceView ExtensionInstance View Response 
- The extension instance view.
- name String
- Name of the node in HCI Cluster.
- state String
- State of Arc Extension in this node.
- typeHandler StringVersion 
- Specifies the version of the script handler.
- extension string
- Fully qualified resource ID for the particular Arc Extension on this node.
- instanceView ExtensionInstance View Response 
- The extension instance view.
- name string
- Name of the node in HCI Cluster.
- state string
- State of Arc Extension in this node.
- typeHandler stringVersion 
- Specifies the version of the script handler.
- extension str
- Fully qualified resource ID for the particular Arc Extension on this node.
- instance_view ExtensionInstance View Response 
- The extension instance view.
- name str
- Name of the node in HCI Cluster.
- state str
- State of Arc Extension in this node.
- type_handler_ strversion 
- 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.
- typeHandler StringVersion 
- Specifies the version of the script handler.
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi