Stop-AzFleetUpdateRun
Stops an UpdateRun.
Syntax
Stop-AzFleetUpdateRun
-FleetName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzFleetUpdateRun
-Name <String>
-FleetInputObject <IFleetIdentity>
[-IfMatch <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzFleetUpdateRun
-InputObject <IFleetIdentity>
[-IfMatch <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Stops an UpdateRun.
Examples
Example 1: Stop specific fleet update run with specified name
Stop-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test
AdditionalInfo :
Code :
Detail :
ETag : "cb064a93-0000-0100-0000-655c81950000"
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1
Message :
Name : run1
NodeImageSelectionSelectedNodeImageVersion :
NodeImageSelectionType : Latest
ProvisioningState : Succeeded
ResourceGroupName : K8sFleet-Test
StatusCompletedTime :
StatusStage : {{
"status": {
"startTime": "2023-11-21T10:07:09.2665585Z",
"state": "Stopping"
},
"name": "default",
"groups": [
{
"status": {
"startTime": "2023-11-21T10:07:09.2665583Z",
"state": "Stopping"
},
"name": "default",
"members": [
{
"status": {
"startTime": "2023-11-21T10:07:09.2665580Z",
"state": "Running"
},
"name": "testmember",
"clusterResourceId":
"/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01",
"operationId": "50c4e26b-a391-4f7a-9d04-510bcbeda57d",
"message": "all agent pools in managed cluster \"TestCluster01\" are already in the latest node image version"
},
{
"status": {
"state": "NotStarted"
},
"name": "testmember2",
"clusterResourceId":
"/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02"
}
]
}
]
}}
StatusStartTime : 11/21/2023 10:07:09 AM
StatusState : Stopping
StrategyStage :
SystemDataCreatedAt : 11/21/2023 10:03:56 AM
SystemDataCreatedBy : user1@example.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 11/21/2023 10:03:56 AM
SystemDataLastModifiedBy : user1@example.com
SystemDataLastModifiedByType : User
Target :
Type : Microsoft.ContainerService/fleets/updateRuns
UpdateStrategyId :
UpgradeKubernetesVersion : 1.28.3
UpgradeType : FullThis command stop specific fleet update run with specified name.
Parameters
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FleetInputObject
Identity Parameter
| Type: | IFleetIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FleetName
The name of the Fleet resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IfMatch
The request should only proceed if an entity matches this string.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter
| Type: | IFleetIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the UpdateRun resource.
| Type: | String |
| Aliases: | UpdateRunName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |