Share via

UpdateRun interface

  • Reference
Package:
@azure/arm-containerservicefleet

A multi-stage process to perform update operations across members of a Fleet.

Extends
ProxyResource

Properties

eTag

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. NOTE: This property will not be serialized. It can only be populated by the server.
managedClusterUpdate

The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
provisioningState

The provisioning state of the UpdateRun resource. NOTE: This property will not be serialized. It can only be populated by the server.
status

The status of the UpdateRun. NOTE: This property will not be serialized. It can only be populated by the server.
strategy

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

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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

eTag

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. NOTE: This property will not be serialized. It can only be populated by the server.

eTag?: string

Property Value

string

managedClusterUpdate

The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.

managedClusterUpdate?: ManagedClusterUpdate

Property Value

ManagedClusterUpdate

provisioningState

The provisioning state of the UpdateRun resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

status

The status of the UpdateRun. NOTE: This property will not be serialized. It can only be populated by the server.

status?: UpdateRunStatus

Property Value

UpdateRunStatus

strategy

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?: UpdateRunStrategy

Property Value

UpdateRunStrategy

updateStrategyId

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?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type