Set-AzVmssLifecycleHooksProfile

Fügt Lebenszyklus-Hooks an eine VMSS-Konfiguration (Virtual Machine Scale Set) oder ein LIVE-VMSS-Objekt an.

Syntax

Default (Standard)

Set-AzVmssLifecycleHooksProfile
    -VirtualMachineScaleSet <PSVirtualMachineScaleSet>
    -LifecycleHook <LifecycleHook[]>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzVmssLifecycleHooksProfile fügt Lebenszyklus-Hooks an ein VMSS-Konfigurationsobjekt (PSVirtualMachineScaleSet) an und gibt das aktualisierte Objekt zurück. Dies folgt der Az.Compute Builder-Standardkonvention (identisch mit Set-AzVmssOsProfile, Set-AzVmssStorageProfile): es mutiert das VMSS-Konfigurationsobjekt UND gibt es zurück.

Das aktualisierte Objekt muss an New-AzVmss (für neue Skalierungssätze) oder Update-AzVmss (für vorhandene Skalierungssätze) übergeben werden, um die Änderungen an Azure beizubehalten.

Beispiele

Beispiel 1: Anfügen eines Lebenszyklus-Hooks an eine neue VMSS-Konfiguration

$hook   = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSScheduling' -WaitDuration 'PT8H'
$config = New-AzVmssConfig -Location 'eastus' -SkuCapacity 2
$config = Set-AzVmssLifecycleHooksProfile -VirtualMachineScaleSet $config -LifecycleHook $hook
New-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -VirtualMachineScaleSet $config

In diesem Beispiel wird ein neuer VMSS mit einem angefügten Lebenszyklus-Hook erstellt.

Beispiel 2: Hinzufügen eines Lebenszyklus-Hooks zu einer vorhandenen VMSS

$vmss     = Get-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss'
$existing = if ($vmss.LifecycleHooksProfile) { $vmss.LifecycleHooksProfile.LifecycleHooks } else { @() }
$batch    = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSRollingBatchStarting' -WaitDuration 'PT30M'
$vmss     = Set-AzVmssLifecycleHooksProfile -VirtualMachineScaleSet $vmss -LifecycleHook ($existing + $batch)
Update-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -VirtualMachineScaleSet $vmss

In diesem Beispiel wird einem vorhandenen VMSS ein zweiter Lebenszyklus-Hook hinzugefügt, wobei die vorhandenen Hooks erhalten bleiben.

Beispiel 3: Verwenden der Pipeline zum Anfügen von Hooks

$hook = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSScheduling' -WaitDuration 'PT8H'
New-AzVmssConfig -Location 'eastus' -SkuCapacity 2 | Set-AzVmssLifecycleHooksProfile -LifecycleHook $hook

In diesem Beispiel wird die Pipeline verwendet, um einen Lebenszyklus-Hook an eine VMSS-Konfiguration anzufügen.

Parameter

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Cf

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Parametereigenschaften

Typ:IAzureContextContainer
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AzContext, AzureRmContext, AzureCredential

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-LifecycleHook

Mindestens ein Lebenszyklus-Hook-Objekt, das an vmSS angefügt werden soll. Verwenden Sie "New-AzVmssLifecycleHookConfig", um Hook-Objekte zu erstellen. Ersetzt alle vorhandenen Lebenszyklus-Hooks für das VMSS-Konfigurationsobjekt.

Parametereigenschaften

Typ:

LifecycleHook[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-VirtualMachineScaleSet

Das VMSS-Konfigurationsobjekt (PSVirtualMachineScaleSet), das aktualisiert werden soll. Dabei kann es sich um eine In-Memory-Konfiguration aus "New-AzVmssConfig" oder um ein LIVE-VMSS-Objekt aus "Get-AzVmss" handeln.

Parametereigenschaften

Typ:PSVirtualMachineScaleSet
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSVirtualMachineScaleSet

LifecycleHook

Ausgaben

PSVirtualMachineScaleSet