Update Runs - Get
Hämta en UpdateRun
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}?api-version=2025-03-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
fleet
|
path | True |
string minLength: 1maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
Namnet på fleet-resursen. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string (uuid) |
ID för målprenumerationen. Värdet måste vara ett UUID. |
update
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
Namnet på UpdateRun-resursen. |
api-version
|
query | True |
string minLength: 1 |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Azure-åtgärden har slutförts. |
|
Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Gets an Update |
Gets an Update |
Gets an UpdateRun resource.
Exempelbegäran
Exempelsvar
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/fleets/myFleet/updateRuns/run1",
"name": "run1",
"type": "Microsoft.ContainerService/fleets/updateRuns",
"systemData": {
"createdBy": "@contoso.com",
"createdByType": "User",
"createdAt": "2023-03-01T01:10:08.395Z",
"lastModifiedBy": "@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2023-03-01T01:10:08.395Z"
},
"properties": {
"provisioningState": "Succeeded",
"strategy": {
"stages": [
{
"name": "stage1",
"groups": [
{
"name": "group-a"
}
],
"afterStageWaitInSeconds": 3600
}
]
},
"managedClusterUpdate": {
"upgrade": {
"type": "Full",
"kubernetesVersion": "1.26.1"
},
"nodeImageSelection": {
"type": "Latest"
}
},
"status": {
"status": {
"state": "NotStarted"
},
"stages": [
{
"status": {
"state": "NotStarted"
},
"name": "stage1",
"groups": [
{
"status": {
"state": "NotStarted"
},
"name": "group-a",
"members": [
{
"status": {
"state": "NotStarted"
},
"name": "member-one",
"clusterResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myClusters/providers/Microsoft.ContainerService/managedClusters/myCluster"
}
]
}
],
"afterStageWaitStatus": {
"status": {
"state": "NotStarted"
},
"waitDurationInSeconds": 3600
}
}
]
}
},
"eTag": "\"EtagValue\""
}
Gets an UpdateRun resource. - generated by [MaximumSet] rule
Exempelbegäran
Exempelsvar
{
"properties": {
"updateStrategyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/fleets/myFleet/updateStrategies/strategy1",
"strategy": {
"stages": [
{
"name": "stage1",
"groups": [
{
"name": "group-a"
}
],
"afterStageWaitInSeconds": 3600
}
]
},
"managedClusterUpdate": {
"upgrade": {
"type": "Full",
"kubernetesVersion": "1.26.1"
},
"nodeImageSelection": {
"type": "Latest",
"customNodeImageVersions": [
{
"version": "wkcmcqhecdbsoskkny"
}
]
}
},
"provisioningState": "Succeeded",
"status": {
"status": {
"startTime": "2025-02-14T23:29:32.768Z",
"completedTime": "2025-02-14T23:29:32.768Z",
"state": "NotStarted",
"error": {
"code": "ezwocfahsfmbddlqgloysjkthkn",
"message": "udtnrxlgadzqlogclb",
"target": "l",
"details": [],
"additionalInfo": [
{
"type": "fzgprz",
"info": {}
}
]
}
},
"stages": [
{
"status": {
"state": "NotStarted",
"startTime": "2025-02-14T23:29:32.767Z",
"completedTime": "2025-02-14T23:29:32.767Z",
"error": {
"code": "ezwocfahsfmbddlqgloysjkthkn",
"message": "udtnrxlgadzqlogclb",
"target": "l",
"details": [],
"additionalInfo": [
{
"type": "fzgprz",
"info": {}
}
]
}
},
"name": "stage1",
"groups": [
{
"status": {
"state": "NotStarted",
"startTime": "2025-02-14T23:29:32.767Z",
"completedTime": "2025-02-14T23:29:32.767Z",
"error": {
"code": "ezwocfahsfmbddlqgloysjkthkn",
"message": "udtnrxlgadzqlogclb",
"target": "l",
"details": [],
"additionalInfo": [
{
"type": "fzgprz",
"info": {}
}
]
}
},
"name": "group-a",
"members": [
{
"status": {
"state": "NotStarted",
"startTime": "2025-02-14T23:29:32.767Z",
"completedTime": "2025-02-14T23:29:32.767Z",
"error": {
"code": "ezwocfahsfmbddlqgloysjkthkn",
"message": "udtnrxlgadzqlogclb",
"target": "l",
"details": [],
"additionalInfo": [
{
"type": "fzgprz",
"info": {}
}
]
}
},
"name": "member-one",
"clusterResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myClusters/providers/Microsoft.ContainerService/managedClusters/myCluster",
"operationId": "islvvdetacuskjzmkcxc",
"message": "xrvhotarzemcgeen"
}
]
}
],
"afterStageWaitStatus": {
"status": {
"state": "NotStarted",
"startTime": "2025-02-14T23:29:32.767Z",
"completedTime": "2025-02-14T23:29:32.767Z",
"error": {
"code": "ezwocfahsfmbddlqgloysjkthkn",
"message": "udtnrxlgadzqlogclb",
"target": "l",
"details": [],
"additionalInfo": [
{
"type": "fzgprz",
"info": {}
}
]
}
},
"waitDurationInSeconds": 3600
}
}
],
"nodeImageSelection": {
"selectedNodeImageVersions": [
{
"version": "wkcmcqhecdbsoskkny"
}
]
}
},
"autoUpgradeProfileId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgfleets/providers/Microsoft.ContainerService/fleets/fleet1/autoUpgradeProfiles/aup1"
},
"eTag": "\"EtagValue\"",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/fleets/myFleet/updateRuns/run1",
"name": "run1",
"type": "Microsoft.ContainerService/fleets/updateRuns",
"systemData": {
"createdBy": "someUser",
"createdByType": "User",
"createdAt": "2022-03-23T05:40:40.657Z",
"lastModifiedBy": "someOtherUser",
"lastModifiedByType": "User",
"lastModifiedAt": "2022-03-23T05:40:40.657Z"
}
}
Definitioner
Name | Description |
---|---|
created |
Den typ av identitet som skapade resursen. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Managed |
Uppdateringen som ska tillämpas på ManagedClusters. |
Managed |
Uppgraderingen som ska tillämpas på en ManagedCluster. |
Managed |
Vilken typ av uppgradering som ska utföras när du riktar in dig på ManagedClusters. |
Member |
Status för en medlemsuppdateringsåtgärd. |
Node |
Den nodbilduppgradering som ska tillämpas på målnoderna i uppdateringskörningen. |
Node |
Specifikationerna för nodbilduppgradering för uppdateringskörningen. |
Node |
Uppgraderingstypen för nodbilden. |
Node |
Avbildningsversionen för noduppgradering. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Update |
En grupp som ska uppdateras. |
Update |
Status för en UpdateGroup. |
Update |
En process i flera steg för att utföra uppdateringsåtgärder för medlemmar i en flotta. |
Update |
Etableringstillståndet för UpdateRun-resursen. |
Update |
Status för en UpdateRun. |
Update |
Definierar uppdateringssekvensen för klustren via faser och grupper. Faser i en körning körs sekventiellt en efter en. Grupper i en fas körs parallellt. Medlemskluster i en grupp uppdateras sekventiellt en efter en. En giltig strategi innehåller inga duplicerade grupper inom eller mellan faser. |
Update |
Definierar ett stadium som innehåller de grupper som ska uppdateras och de steg som ska utföras (t.ex. vänta en tidsperiod) innan nästa steg påbörjas. |
Update |
Status för en UpdateStage. |
Update |
Tillståndet för UpdateRun, UpdateStage, UpdateGroup eller MemberUpdate. |
Update |
Status för en åtgärd eller grupp med åtgärder. |
Wait |
Status för väntetiden. |
createdByType
Den typ av identitet som skapade resursen.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
ManagedClusterUpdate
Uppdateringen som ska tillämpas på ManagedClusters.
Name | Typ | Description |
---|---|---|
nodeImageSelection |
Den nodbilduppgradering som ska tillämpas på målnoderna i uppdateringskörningen. |
|
upgrade |
Uppgraderingen som ska tillämpas på ManagedClusters. |
ManagedClusterUpgradeSpec
Uppgraderingen som ska tillämpas på en ManagedCluster.
Name | Typ | Description |
---|---|---|
kubernetesVersion |
string |
Kubernetes-versionen som medlemskluster ska uppgraderas till. |
type |
ManagedClusterUpgradeType är den typ av uppgradering som ska tillämpas. |
ManagedClusterUpgradeType
Vilken typ av uppgradering som ska utföras när du riktar in dig på ManagedClusters.
Värde | Description |
---|---|
ControlPlaneOnly |
ControlPlaneOnly-uppgraderingar riktar sig endast mot KubernetesVersion för ManagedClusters och tillämpas inte på AgentPool. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion anges. |
Full |
Fullständig uppgradering av kontrollplanet och alla agentpooler i målet ManagedClusters. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion anges. |
NodeImageOnly |
NodeImageOnly uppgraderar endast nodbilderna för målet ManagedClusters. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion INTE anges. |
MemberUpdateStatus
Status för en medlemsuppdateringsåtgärd.
Name | Typ | Description |
---|---|---|
clusterResourceId |
string |
Azure-resurs-ID för kubernetes-målklustret. |
message |
string |
Statusmeddelandet efter bearbetning av medlemsuppdateringsåtgärden. |
name |
string |
Namnet på FleetMember. |
operationId |
string |
Åtgärdsresurs-ID för det senaste försöket att utföra åtgärden. |
status |
Status för åtgärden MemberUpdate. |
NodeImageSelection
Den nodbilduppgradering som ska tillämpas på målnoderna i uppdateringskörningen.
Name | Typ | Description |
---|---|---|
customNodeImageVersions |
Anpassade nodbildversioner att uppgradera noderna till. Det här fältet krävs om typ av val av nodbild är Anpassad. Annars måste den vara tom. För varje nodbildfamilj (t.ex. "AKSUbuntu-1804gen2containerd" kan det här fältet innehålla högst en version (t.ex. endast en av "AKSUbuntu-1804gen2containerd-2023.01.12" eller "AKSUbuntu-1804gen2containerd-2023.02.12", inte båda). Om noderna tillhör en familj utan matchande avbildningsversion i det här fältet uppgraderas de inte. |
|
type |
Uppgraderingstypen för nodbilden. |
NodeImageSelectionStatus
Specifikationerna för nodbilduppgradering för uppdateringskörningen.
Name | Typ | Description |
---|---|---|
selectedNodeImageVersions |
De avbildningsversioner som noderna ska uppgraderas till. |
NodeImageSelectionType
Uppgraderingstypen för nodbilden.
Värde | Description |
---|---|
Consistent |
Avbildningsversionerna för att uppgradera noder till väljs enligt beskrivningen nedan: för varje nodpool i hanterade kluster som påverkas av uppdateringskörningen väljer systemet den senaste avbildningsversionen så att den är tillgänglig i alla andra nodpooler (i alla andra kluster) av samma avbildningstyp. Därför uppgraderas alla nodpooler av samma avbildningstyp till samma avbildningsversion. Om till exempel den senaste avbildningsversionen för bildtypen "AKSUbuntu-1804gen2containerd" är "AKSUbuntu-1804gen2containerd-2021.10.12" för en nodpool i kluster A i region X, och är "AKSUbuntu-1804gen2containerd-2021.10.17" för en nodpool i kluster B i regionen Y, uppgraderar systemet båda nodpoolerna till avbildningsversionen "AKSUbuntu-1804gen2containerd-2021.10.12". |
Custom |
Uppgradera noderna till de anpassade avbildningsversionerna. När den är inställd använder uppdateringskörningen nodavbildningsversioner som tillhandahålls i customNodeImageVersions för att uppgradera noderna. Om det anges får customNodeImageVersions inte vara tomt. |
Latest |
Använd den senaste avbildningsversionen när du uppgraderar noder. Kluster kan använda olika avbildningsversioner (t.ex. "AKSUbuntu-1804gen2containerd-2021.10.12" och "AKSUbuntu-1804gen2containerd-2021.10.19") eftersom den senaste tillgängliga versionen till exempel skiljer sig i olika regioner. |
NodeImageVersion
Avbildningsversionen för noduppgradering.
Name | Typ | Description |
---|---|---|
version |
string |
Avbildningsversionen för att uppgradera noderna till (t.ex. "AKSUbuntu-1804gen2containerd-2022.12.13"). |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string (date-time) |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
UpdateGroup
En grupp som ska uppdateras.
Name | Typ | Description |
---|---|---|
name |
string minLength: 1maxLength: 50 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
Gruppens namn. Den måste matcha ett gruppnamn för en befintlig medlem i flottan. |
UpdateGroupStatus
Status för en UpdateGroup.
Name | Typ | Description |
---|---|---|
members |
Listan över medlemmar som uppdateringsgruppen uppdaterar. |
|
name |
string |
Namnet på UpdateGroup. |
status |
Status för UpdateGroup. |
UpdateRun
En process i flera steg för att utföra uppdateringsåtgärder för medlemmar i en flotta.
Name | Typ | Description |
---|---|---|
eTag |
string |
Om eTag anges i svarstexten kan det också anges som en rubrik enligt den normala etag-konventionen. Entitetstaggar används för att jämföra två eller flera entiteter från samma begärda resurs. HTTP/1.1 använder entitetstaggar i etag (avsnitt 14.19), If-Match (avsnitt 14.24), If-None-Match (avsnitt 14.26) och If-Range (avsnitt 14.27) rubrikfält. |
id |
string (arm-id) |
Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Namnet på resursen |
properties.autoUpgradeProfileId |
string (arm-id) |
AutoUpgradeProfileId är ID för en profilresurs för automatisk uppgradering. |
properties.managedClusterUpdate |
Uppdateringen som ska tillämpas på alla kluster i UpdateRun. ManagedClusterUpdate kan ändras tills körningen startas. |
|
properties.provisioningState |
Etableringstillståndet för UpdateRun-resursen. |
|
properties.status |
Status för UpdateRun. |
|
properties.strategy |
Strategin definierar i vilken ordning klustren ska uppdateras. Om det inte anges uppdateras alla medlemmar sekventiellt. UpdateRun-statusen visar en enda UpdateStage och en enda UpdateGroup som riktar sig till alla medlemmar. Strategin för UpdateRun kan ändras tills körningen startas. |
|
properties.updateStrategyId |
string (arm-id) |
Resurs-ID för FleetUpdateStrategy-resursen att referera till. När du skapar en ny körning finns det tre sätt att definiera en strategi för körningen:
Det är ogiltigt att ange både "updateStrategyId" och "strategi". UpdateRuns som skapats av ögonblicksbilden "updateStrategyId" refererade till UpdateStrategy vid tidpunkten för skapandet och lagrar den i fältet "strategi". Efterföljande ändringar av den refererade FleetUpdateStrategy-resursen sprids inte. UpdateRunStrategy-ändringar kan göras direkt i fältet "strategi" innan du startar UpdateRun. |
systemData |
Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
UpdateRunProvisioningState
Etableringstillståndet för UpdateRun-resursen.
Värde | Description |
---|---|
Canceled |
Resursskapandet avbröts. |
Failed |
Det gick inte att skapa resurser. |
Succeeded |
Resursen har skapats. |
UpdateRunStatus
Status för en UpdateRun.
Name | Typ | Description |
---|---|---|
nodeImageSelection |
Specifikationerna för nodbilduppgradering för uppdateringskörningen. Den anges bara i uppdateringskörningen när |
|
stages |
Faserna som utgör en uppdateringskörning. Faser körs sekventiellt med en UpdateRun. |
|
status |
Status för UpdateRun. |
UpdateRunStrategy
Definierar uppdateringssekvensen för klustren via faser och grupper.
Faser i en körning körs sekventiellt en efter en. Grupper i en fas körs parallellt. Medlemskluster i en grupp uppdateras sekventiellt en efter en.
En giltig strategi innehåller inga duplicerade grupper inom eller mellan faser.
Name | Typ | Description |
---|---|---|
stages |
Listan över steg som utgör den här uppdateringskörningen. Minsta storlek: 1. |
UpdateStage
Definierar ett stadium som innehåller de grupper som ska uppdateras och de steg som ska utföras (t.ex. vänta en tidsperiod) innan nästa steg påbörjas.
Name | Typ | Description |
---|---|---|
afterStageWaitInSeconds |
integer (int32) |
Tiden i sekunder att vänta i slutet av den här fasen innan nästa påbörjas. Standardvärdet är 0 sekunder om det är ospecificerat. |
groups |
Definierar de grupper som ska köras parallellt i det här steget. Duplicerade grupper tillåts inte. Minsta storlek: 1. |
|
name |
string minLength: 1maxLength: 50 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
Namnet på fasen. Måste vara unikt i UpdateRun. |
UpdateStageStatus
Status för en UpdateStage.
Name | Typ | Description |
---|---|---|
afterStageWaitStatus |
Status för väntetiden som konfigurerats på UpdateStage. |
|
groups |
Listan över grupper som ska uppdateras som en del av denna UpdateStage. |
|
name |
string |
Namnet på UpdateStage. |
status |
Status för UpdateStage. |
UpdateState
Tillståndet för UpdateRun, UpdateStage, UpdateGroup eller MemberUpdate.
Värde | Description |
---|---|
Completed |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har slutförts. |
Failed |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har misslyckats. |
NotStarted |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som inte har startats. |
Running |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som körs. |
Skipped |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har hoppats över. |
Stopped |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har stoppats. |
Stopping |
Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som stoppas. |
UpdateStatus
Status för en åtgärd eller grupp med åtgärder.
Name | Typ | Description |
---|---|---|
completedTime |
string (date-time) |
Den tid då åtgärden eller gruppen slutfördes. |
error |
Felinformationen när ett fel påträffas. |
|
startTime |
string (date-time) |
Den tid då åtgärden eller gruppen startades. |
state |
Åtgärdens eller gruppens tillstånd. |
WaitStatus
Status för väntetiden.
Name | Typ | Description |
---|---|---|
status |
Status för väntetiden. |
|
waitDurationInSeconds |
integer (int32) |
Väntetiden som konfigurerats i sekunder. |