VMScaleSetLifecycleHookEventProperties Class

Defines the virtual machine scale set lifecycle hook event properties.

Constructor

VMScaleSetLifecycleHookEventProperties()

Variables

Name	Description
type	Union[str, <xref:"VMScaleSetLifecycleHookEventType">] Defines the type or scenario for sending a virtual machine scale set lifecycle hook event to the customer. Known values are: "UpgradeAutoOSScheduling" and "UpgradeAutoOSRollingBatchStarting".
wait_until	str Specifies the exact UTC timestamp in ISO 8601 format till which the event would remain in the current lifecycle state waiting for an action from the customer. Beyond this timestamp, the platform will apply the defaultAction for the event.
max_wait_until	str Specifies the exact UTC timestamp in ISO 8601 format till when the customer can delay the lifecycle hook event. The customer will not be allowed to delay the event to a timestamp beyond this.
time_created	str The UTC timestamp in ISO 8601 format at which the platform creates the virtual machine scale set lifecycle hook event entity.
default_action	Union[str, <xref:"LifecycleHookAction">] Specify the action that will be applied on the a target resource in the virtual machine scale set lifecycle hook event if the platform does not get a response from the customer for the target resource before waitUntil. Known values are: "Approve" and "Reject".
target_resources	list[<xref:"VMScaleSetLifecycleHookEventTargetResource">] List of target resources which are getting processed in the virtual machine scale set lifecycle hook event.
additional_context	<xref:<xref:"VMScaleSetLifecycleHookEventAdditionalContext">> Additional key-value pairs set on the lifecycle hook event that gives customer some useful context/data. The keys in this dictionary are specific to the lifecycle hook type. Different lifecycle hook events can have different sets of keys in the additional context depending on the lifecycle hook type. For example, for a lifecycle hook event with UpgradeAutoOSScheduling type, the additional context can contain the key "priority" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the virtual machine scale set.
state	Union[str, <xref:"VMScaleSetLifecycleHookEventState">] Specifies the state of the virtual machine scale set lifecycle hook event. Known values are: "Active" and "Completed".

Attributes

additionalContext

Additional key-value pairs set on the lifecycle hook event that gives customer some useful context/data. The keys in this dictionary are specific to the lifecycle hook type. Different lifecycle hook events can have different sets of keys in the additional context depending on the lifecycle hook type. For example, for a lifecycle hook event with UpgradeAutoOSScheduling type, the additional context can contain the key "priority" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the virtual machine scale set.

additionalContext: VMScaleSetLifecycleHookEventAdditionalContext

defaultAction

Specify the action that will be applied on the a target resource in the virtual machine scale set lifecycle hook event if the platform does not get a response from the customer for the target resource before waitUntil. Known values are: "Approve" and "Reject".

defaultAction: str | LifecycleHookAction

maxWaitUntil

Specifies the exact UTC timestamp in ISO 8601 format till when the customer can delay the lifecycle hook event. The customer will not be allowed to delay the event to a timestamp beyond this.

maxWaitUntil: str

state

Specifies the state of the virtual machine scale set lifecycle hook event. Known values are: "Active" and "Completed".

state: str | VMScaleSetLifecycleHookEventState

targetResources

List of target resources which are getting processed in the virtual machine scale set lifecycle hook event.

targetResources: list['VMScaleSetLifecycleHookEventTargetResource']

timeCreated

The UTC timestamp in ISO 8601 format at which the platform creates the virtual machine scale set lifecycle hook event entity.

timeCreated: str

type

Defines the type or scenario for sending a virtual machine scale set lifecycle hook event to the customer. Known values are: "UpgradeAutoOSScheduling" and "UpgradeAutoOSRollingBatchStarting".

type: str | VMScaleSetLifecycleHookEventType

waitUntil

Specifies the exact UTC timestamp in ISO 8601 format till which the event would remain in the current lifecycle state waiting for an action from the customer. Beyond this timestamp, the platform will apply the defaultAction for the event.

waitUntil: str