Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurestackhci
  5. getUpdateRun
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azurestackhci.getUpdateRun

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the Update run for a specified update 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 getUpdateRun

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 getUpdateRun(args: GetUpdateRunArgs, opts?: InvokeOptions): Promise<GetUpdateRunResult>
function getUpdateRunOutput(args: GetUpdateRunOutputArgs, opts?: InvokeOptions): Output<GetUpdateRunResult>
Copy
def get_update_run(cluster_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   update_name: Optional[str] = None,
                   update_run_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetUpdateRunResult
def get_update_run_output(cluster_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   update_name: Optional[pulumi.Input[str]] = None,
                   update_run_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetUpdateRunResult]
Copy
func LookupUpdateRun(ctx *Context, args *LookupUpdateRunArgs, opts ...InvokeOption) (*LookupUpdateRunResult, error)
func LookupUpdateRunOutput(ctx *Context, args *LookupUpdateRunOutputArgs, opts ...InvokeOption) LookupUpdateRunResultOutput
Copy

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

public static class GetUpdateRun 
{
    public static Task<GetUpdateRunResult> InvokeAsync(GetUpdateRunArgs args, InvokeOptions? opts = null)
    public static Output<GetUpdateRunResult> Invoke(GetUpdateRunInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUpdateRunResult> getUpdateRun(GetUpdateRunArgs args, InvokeOptions options)
public static Output<GetUpdateRunResult> getUpdateRun(GetUpdateRunArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestackhci:getUpdateRun
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UpdateName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update
UpdateRunName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update Run
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UpdateName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update
UpdateRunName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update Run
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
updateName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Update
updateRunName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Update Run
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
updateName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update
updateRunName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Update Run
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
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.
update_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Update
update_run_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Update Run
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
updateName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Update
updateRunName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Update Run

getUpdateRun 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}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the UpdateRuns 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"
Description string
More detailed description of the step.
Duration string
Duration of the update run.
EndTimeUtc string
When the step reached a terminal state.
ErrorMessage string
Error message, specified if the step is in a failed state.
LastUpdatedTime string
Timestamp of the most recently completed step in the update run.
LastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
Location string
The geo-location where the resource lives
StartTimeUtc string
When the step started, or empty if it has not started executing.
State string
State of the update run.
Status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
Steps List<Pulumi.AzureNative.AzureStackHCI.Outputs.StepResponse>
Recursive model for child steps of this step.
TimeStarted string
Timestamp of the update run was started.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the UpdateRuns 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"
Description string
More detailed description of the step.
Duration string
Duration of the update run.
EndTimeUtc string
When the step reached a terminal state.
ErrorMessage string
Error message, specified if the step is in a failed state.
LastUpdatedTime string
Timestamp of the most recently completed step in the update run.
LastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
Location string
The geo-location where the resource lives
StartTimeUtc string
When the step started, or empty if it has not started executing.
State string
State of the update run.
Status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
Steps []StepResponse
Recursive model for child steps of this step.
TimeStarted string
Timestamp of the update run was started.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Provisioning state of the UpdateRuns 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"
description String
More detailed description of the step.
duration String
Duration of the update run.
endTimeUtc String
When the step reached a terminal state.
errorMessage String
Error message, specified if the step is in a failed state.
lastUpdatedTime String
Timestamp of the most recently completed step in the update run.
lastUpdatedTimeUtc String
Completion time of this step or the last completed sub-step.
location String
The geo-location where the resource lives
startTimeUtc String
When the step started, or empty if it has not started executing.
state String
State of the update run.
status String
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps List<StepResponse>
Recursive model for child steps of this step.
timeStarted String
Timestamp of the update run was started.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
Provisioning state of the UpdateRuns 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"
description string
More detailed description of the step.
duration string
Duration of the update run.
endTimeUtc string
When the step reached a terminal state.
errorMessage string
Error message, specified if the step is in a failed state.
lastUpdatedTime string
Timestamp of the most recently completed step in the update run.
lastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
location string
The geo-location where the resource lives
startTimeUtc string
When the step started, or empty if it has not started executing.
state string
State of the update run.
status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps StepResponse[]
Recursive model for child steps of this step.
timeStarted string
Timestamp of the update run was started.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
Provisioning state of the UpdateRuns 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"
description str
More detailed description of the step.
duration str
Duration of the update run.
end_time_utc str
When the step reached a terminal state.
error_message str
Error message, specified if the step is in a failed state.
last_updated_time str
Timestamp of the most recently completed step in the update run.
last_updated_time_utc str
Completion time of this step or the last completed sub-step.
location str
The geo-location where the resource lives
start_time_utc str
When the step started, or empty if it has not started executing.
state str
State of the update run.
status str
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps Sequence[StepResponse]
Recursive model for child steps of this step.
time_started str
Timestamp of the update run was started.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Provisioning state of the UpdateRuns 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"
description String
More detailed description of the step.
duration String
Duration of the update run.
endTimeUtc String
When the step reached a terminal state.
errorMessage String
Error message, specified if the step is in a failed state.
lastUpdatedTime String
Timestamp of the most recently completed step in the update run.
lastUpdatedTimeUtc String
Completion time of this step or the last completed sub-step.
location String
The geo-location where the resource lives
startTimeUtc String
When the step started, or empty if it has not started executing.
state String
State of the update run.
status String
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps List<Property Map>
Recursive model for child steps of this step.
timeStarted String
Timestamp of the update run was started.

Supporting Types

StepResponse

Description string
More detailed description of the step.
EndTimeUtc string
When the step reached a terminal state.
ErrorMessage string
Error message, specified if the step is in a failed state.
Exception List<string>
List of exceptions in AzureStackHCI Cluster Deployment.
FullStepIndex string
FullStepIndex of step.
LastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
Name string
Name of the step.
StartTimeUtc string
When the step started, or empty if it has not started executing.
Status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
Steps List<Pulumi.AzureNative.AzureStackHCI.Inputs.StepResponse>
Recursive model for child steps of this step.
Description string
More detailed description of the step.
EndTimeUtc string
When the step reached a terminal state.
ErrorMessage string
Error message, specified if the step is in a failed state.
Exception []string
List of exceptions in AzureStackHCI Cluster Deployment.
FullStepIndex string
FullStepIndex of step.
LastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
Name string
Name of the step.
StartTimeUtc string
When the step started, or empty if it has not started executing.
Status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
Steps []StepResponse
Recursive model for child steps of this step.
description String
More detailed description of the step.
endTimeUtc String
When the step reached a terminal state.
errorMessage String
Error message, specified if the step is in a failed state.
exception List<String>
List of exceptions in AzureStackHCI Cluster Deployment.
fullStepIndex String
FullStepIndex of step.
lastUpdatedTimeUtc String
Completion time of this step or the last completed sub-step.
name String
Name of the step.
startTimeUtc String
When the step started, or empty if it has not started executing.
status String
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps List<StepResponse>
Recursive model for child steps of this step.
description string
More detailed description of the step.
endTimeUtc string
When the step reached a terminal state.
errorMessage string
Error message, specified if the step is in a failed state.
exception string[]
List of exceptions in AzureStackHCI Cluster Deployment.
fullStepIndex string
FullStepIndex of step.
lastUpdatedTimeUtc string
Completion time of this step or the last completed sub-step.
name string
Name of the step.
startTimeUtc string
When the step started, or empty if it has not started executing.
status string
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps StepResponse[]
Recursive model for child steps of this step.
description str
More detailed description of the step.
end_time_utc str
When the step reached a terminal state.
error_message str
Error message, specified if the step is in a failed state.
exception Sequence[str]
List of exceptions in AzureStackHCI Cluster Deployment.
full_step_index str
FullStepIndex of step.
last_updated_time_utc str
Completion time of this step or the last completed sub-step.
name str
Name of the step.
start_time_utc str
When the step started, or empty if it has not started executing.
status str
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps Sequence[StepResponse]
Recursive model for child steps of this step.
description String
More detailed description of the step.
endTimeUtc String
When the step reached a terminal state.
errorMessage String
Error message, specified if the step is in a failed state.
exception List<String>
List of exceptions in AzureStackHCI Cluster Deployment.
fullStepIndex String
FullStepIndex of step.
lastUpdatedTimeUtc String
Completion time of this step or the last completed sub-step.
name String
Name of the step.
startTimeUtc String
When the step started, or empty if it has not started executing.
status String
Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps List<Property Map>
Recursive model for child steps of this step.

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native