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

azure-native.azurestackhci.getUpdate

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get specified Update

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. 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 getUpdate

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 getUpdate(args: GetUpdateArgs, opts?: InvokeOptions): Promise<GetUpdateResult>
function getUpdateOutput(args: GetUpdateOutputArgs, opts?: InvokeOptions): Output<GetUpdateResult>
Copy
def get_update(cluster_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               update_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetUpdateResult
def get_update_output(cluster_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               update_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetUpdateResult]
Copy
func LookupUpdate(ctx *Context, args *LookupUpdateArgs, opts ...InvokeOption) (*LookupUpdateResult, error)
func LookupUpdateOutput(ctx *Context, args *LookupUpdateOutputArgs, opts ...InvokeOption) LookupUpdateResultOutput
Copy

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

public static class GetUpdate 
{
    public static Task<GetUpdateResult> InvokeAsync(GetUpdateArgs args, InvokeOptions? opts = null)
    public static Output<GetUpdateResult> Invoke(GetUpdateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUpdateResult> getUpdate(GetUpdateArgs args, InvokeOptions options)
public static Output<GetUpdateResult> getUpdate(GetUpdateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestackhci:getUpdate
  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
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
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
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
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
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

getUpdate Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the Updates 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"
AdditionalProperties string
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
AvailabilityType string
Indicates the way the update content can be downloaded.
Description string
Description of the update.
DisplayName string
Display name of the Update
HealthCheckDate string
Last time the package-specific checks were run.
InstalledDate string
Date that the update was installed.
Location string
The geo-location where the resource lives
MinSbeVersionRequired string
Minimum Sbe Version of the update.
NotifyMessage string
Brief message with instructions for updates of AvailabilityType Notify.
PackagePath string
Path where the update package is available.
PackageSizeInMb double
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
PackageType string
Customer-visible type of the update.
Prerequisites List<Pulumi.AzureNative.AzureStackHCI.Outputs.UpdatePrerequisiteResponse>
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
ProgressPercentage double
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
Publisher string
Publisher of the update package.
ReleaseLink string
Link to release notes for the update.
State string
State of the update as it relates to this stamp.
Version string
Version of the update.
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}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the Updates 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"
AdditionalProperties string
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
AvailabilityType string
Indicates the way the update content can be downloaded.
Description string
Description of the update.
DisplayName string
Display name of the Update
HealthCheckDate string
Last time the package-specific checks were run.
InstalledDate string
Date that the update was installed.
Location string
The geo-location where the resource lives
MinSbeVersionRequired string
Minimum Sbe Version of the update.
NotifyMessage string
Brief message with instructions for updates of AvailabilityType Notify.
PackagePath string
Path where the update package is available.
PackageSizeInMb float64
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
PackageType string
Customer-visible type of the update.
Prerequisites []UpdatePrerequisiteResponse
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
ProgressPercentage float64
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
Publisher string
Publisher of the update package.
ReleaseLink string
Link to release notes for the update.
State string
State of the update as it relates to this stamp.
Version string
Version of the update.
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}
name String
The name of the resource
provisioningState String
Provisioning state of the Updates 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"
additionalProperties String
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType String
Indicates the way the update content can be downloaded.
description String
Description of the update.
displayName String
Display name of the Update
healthCheckDate String
Last time the package-specific checks were run.
installedDate String
Date that the update was installed.
location String
The geo-location where the resource lives
minSbeVersionRequired String
Minimum Sbe Version of the update.
notifyMessage String
Brief message with instructions for updates of AvailabilityType Notify.
packagePath String
Path where the update package is available.
packageSizeInMb Double
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType String
Customer-visible type of the update.
prerequisites List<UpdatePrerequisiteResponse>
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
progressPercentage Double
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
publisher String
Publisher of the update package.
releaseLink String
Link to release notes for the update.
state String
State of the update as it relates to this stamp.
version String
Version of the update.
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}
name string
The name of the resource
provisioningState string
Provisioning state of the Updates 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"
additionalProperties string
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType string
Indicates the way the update content can be downloaded.
description string
Description of the update.
displayName string
Display name of the Update
healthCheckDate string
Last time the package-specific checks were run.
installedDate string
Date that the update was installed.
location string
The geo-location where the resource lives
minSbeVersionRequired string
Minimum Sbe Version of the update.
notifyMessage string
Brief message with instructions for updates of AvailabilityType Notify.
packagePath string
Path where the update package is available.
packageSizeInMb number
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType string
Customer-visible type of the update.
prerequisites UpdatePrerequisiteResponse[]
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
progressPercentage number
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
publisher string
Publisher of the update package.
releaseLink string
Link to release notes for the update.
state string
State of the update as it relates to this stamp.
version string
Version of the update.
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}
name str
The name of the resource
provisioning_state str
Provisioning state of the Updates 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"
additional_properties str
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availability_type str
Indicates the way the update content can be downloaded.
description str
Description of the update.
display_name str
Display name of the Update
health_check_date str
Last time the package-specific checks were run.
installed_date str
Date that the update was installed.
location str
The geo-location where the resource lives
min_sbe_version_required str
Minimum Sbe Version of the update.
notify_message str
Brief message with instructions for updates of AvailabilityType Notify.
package_path str
Path where the update package is available.
package_size_in_mb float
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
package_type str
Customer-visible type of the update.
prerequisites Sequence[UpdatePrerequisiteResponse]
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
progress_percentage float
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
publisher str
Publisher of the update package.
release_link str
Link to release notes for the update.
state str
State of the update as it relates to this stamp.
version str
Version of the update.
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}
name String
The name of the resource
provisioningState String
Provisioning state of the Updates 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"
additionalProperties String
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType String
Indicates the way the update content can be downloaded.
description String
Description of the update.
displayName String
Display name of the Update
healthCheckDate String
Last time the package-specific checks were run.
installedDate String
Date that the update was installed.
location String
The geo-location where the resource lives
minSbeVersionRequired String
Minimum Sbe Version of the update.
notifyMessage String
Brief message with instructions for updates of AvailabilityType Notify.
packagePath String
Path where the update package is available.
packageSizeInMb Number
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType String
Customer-visible type of the update.
prerequisites List<Property Map>
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
progressPercentage Number
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
publisher String
Publisher of the update package.
releaseLink String
Link to release notes for the update.
state String
State of the update as it relates to this stamp.
version String
Version of the update.

Supporting Types

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.

UpdatePrerequisiteResponse

PackageName string
Friendly name of the prerequisite.
UpdateType string
Updatable component type.
Version string
Version of the prerequisite.
PackageName string
Friendly name of the prerequisite.
UpdateType string
Updatable component type.
Version string
Version of the prerequisite.
packageName String
Friendly name of the prerequisite.
updateType String
Updatable component type.
version String
Version of the prerequisite.
packageName string
Friendly name of the prerequisite.
updateType string
Updatable component type.
version string
Version of the prerequisite.
package_name str
Friendly name of the prerequisite.
update_type str
Updatable component type.
version str
Version of the prerequisite.
packageName String
Friendly name of the prerequisite.
updateType String
Updatable component type.
version String
Version of the prerequisite.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native