@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A multi-stage process to perform update operations across members of a Fleet.
*
* Uses Azure REST API version 2024-05-02-preview. In version 2.x of the Azure Native provider, it used API version 2023-03-15-preview.
*
* Other available API versions: 2023-03-15-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native containerservice [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class UpdateRun extends pulumi.CustomResource {
/**
* Get an existing UpdateRun resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): UpdateRun;
/**
* Returns true if the given object is an instance of UpdateRun. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is UpdateRun;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
*/
readonly eTag: pulumi.Output<string>;
/**
* The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
*/
readonly managedClusterUpdate: pulumi.Output<outputs.containerservice.ManagedClusterUpdateResponse>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The provisioning state of the UpdateRun resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The status of the UpdateRun.
*/
readonly status: pulumi.Output<outputs.containerservice.UpdateRunStatusResponse>;
/**
* The strategy defines the order in which the clusters will be updated.
* If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.
* The strategy of the UpdateRun can be modified until the run is started.
*/
readonly strategy: pulumi.Output<outputs.containerservice.UpdateRunStrategyResponse | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.containerservice.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* The resource id of the FleetUpdateStrategy resource to reference.
*
* When creating a new run, there are three ways to define a strategy for the run:
* 1. Define a new strategy in place: Set the "strategy" field.
* 2. Use an existing strategy: Set the "updateStrategyId" field. (since 2023-08-15-preview)
* 3. Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. (since 2023-08-15-preview)
*
* Setting both "updateStrategyId" and "strategy" is invalid.
*
* UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field.
* Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate.
* UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun.
*/
readonly updateStrategyId: pulumi.Output<string | undefined>;
/**
* Create a UpdateRun resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UpdateRunArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a UpdateRun resource.
*/
export interface UpdateRunArgs {
/**
* The name of the Fleet resource.
*/
fleetName: pulumi.Input<string>;
/**
* The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
*/
managedClusterUpdate: pulumi.Input<inputs.containerservice.ManagedClusterUpdateArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The strategy defines the order in which the clusters will be updated.
* If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.
* The strategy of the UpdateRun can be modified until the run is started.
*/
strategy?: pulumi.Input<inputs.containerservice.UpdateRunStrategyArgs>;
/**
* The name of the UpdateRun resource.
*/
updateRunName?: pulumi.Input<string>;
/**
* The resource id of the FleetUpdateStrategy resource to reference.
*
* When creating a new run, there are three ways to define a strategy for the run:
* 1. Define a new strategy in place: Set the "strategy" field.
* 2. Use an existing strategy: Set the "updateStrategyId" field. (since 2023-08-15-preview)
* 3. Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. (since 2023-08-15-preview)
*
* Setting both "updateStrategyId" and "strategy" is invalid.
*
* UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field.
* Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate.
* UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun.
*/
updateStrategyId?: pulumi.Input<string>;
}