VMScaleSetLifecycleHookEventUpdate interface
Specifies information about the virtual machine scale set lifecycle hook event.
Properties
| additional |
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. |
| default |
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. |
| max |
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. |
| state | Specifies the state of the virtual machine scale set lifecycle hook event. |
| target |
List of target resources which are getting processed in the virtual machine scale set lifecycle hook event. |
| time |
The UTC timestamp in ISO 8601 format at which the platform creates the virtual machine scale set lifecycle hook event entity. |
| type | Defines the type or scenario for sending a virtual machine scale set lifecycle hook event to the customer. |
| wait |
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. |
Property Details
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
Property Value
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.
defaultAction?: string
Property Value
string
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?: string
Property Value
string
state
Specifies the state of the virtual machine scale set lifecycle hook event.
state?: string
Property Value
string
targetResources
List of target resources which are getting processed in the virtual machine scale set lifecycle hook event.
targetResources?: VMScaleSetLifecycleHookEventTargetResource[]
Property Value
timeCreated
The UTC timestamp in ISO 8601 format at which the platform creates the virtual machine scale set lifecycle hook event entity.
timeCreated?: string
Property Value
string
type
Defines the type or scenario for sending a virtual machine scale set lifecycle hook event to the customer.
type?: string
Property Value
string
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?: string
Property Value
string