Update Runs - Put
Put Update runs for a specified update
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}?api-version=2024-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
cluster
|
path | True |
string |
Der Name des Clusters. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string minLength: 1 |
Die ID des Zielabonnements. |
update
|
path | True |
string |
Der Name des Updates |
update
|
path | True |
string |
Der Name der Updateausführung |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
properties.duration |
string |
Dauer der Aktualisierungsausführung. |
properties.lastUpdatedTime |
string (date-time) |
Zeitstempel des zuletzt abgeschlossenen Schritts in der Updateausführung. |
properties.progress.description |
string |
Ausführlichere Beschreibung des Schritts. |
properties.progress.endTimeUtc |
string (date-time) |
Wenn der Schritt einen Terminalzustand erreicht hat. |
properties.progress.errorMessage |
string |
Fehlermeldung, angegeben, wenn sich der Schritt in einem fehlgeschlagenen Zustand befindet. |
properties.progress.expectedExecutionTime |
string |
Ausführungszeit eines bestimmten Schritts erwartet. Dies ist optional im Updateaktionsplan erstellt und kann leer sein. |
properties.progress.lastUpdatedTimeUtc |
string (date-time) |
Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts. |
properties.progress.name |
string |
Name des Schritts. |
properties.progress.startTimeUtc |
string (date-time) |
Wenn der Schritt gestartet oder leer ist, wenn er nicht ausgeführt wurde. |
properties.progress.status |
string |
Der Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche eingeblasen wurde. Werte sind: 'Success', 'Error', 'InProgress' und 'Unbekannter Status'. |
properties.progress.steps |
Step[] |
Rekursives Modell für untergeordnete Schritte dieses Schritts. |
properties.state |
Status der Updateausführung. |
|
properties.timeStarted |
string (date-time) |
Der Zeitstempel der Updateausführung wurde gestartet. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Get Update runs under cluster resource
Beispielanforderung
PUT https://management.azure.com/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3?api-version=2024-04-01
{
"properties": {
"progress": {
"name": "Unnamed step",
"description": "Update Azure Stack.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
"endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
"lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
"steps": [
{
"name": "PreUpdate Cloud",
"description": "Prepare for SSU update",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
"endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
"lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
"steps": []
}
]
}
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3",
"name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3",
"type": "Microsoft.AzureStackHCI/updates/updateRuns",
"location": "West US",
"properties": {
"progress": {
"name": "Unnamed step",
"description": "Update Azure Stack.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
"endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
"lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
"steps": [
{
"name": "PreUpdate Cloud",
"description": "Prepare for SSU update",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
"endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
"lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
"steps": []
}
]
}
}
}
Definitionen
Name | Beschreibung |
---|---|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
Provisioning |
Bereitstellungsstatus der UpdateRuns-Proxyressource. |
Step |
Statusdarstellung der Aktualisierungsausführungsschritte. |
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
Update |
Details einer Updateausführung |
update |
Status der Updateausführung. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
ProvisioningState
Bereitstellungsstatus der UpdateRuns-Proxyressource.
Wert | Beschreibung |
---|---|
Accepted | |
Canceled | |
Failed | |
Provisioning | |
Succeeded |
Step
Statusdarstellung der Aktualisierungsausführungsschritte.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Ausführlichere Beschreibung des Schritts. |
endTimeUtc |
string (date-time) |
Wenn der Schritt einen Terminalzustand erreicht hat. |
errorMessage |
string |
Fehlermeldung, angegeben, wenn sich der Schritt in einem fehlgeschlagenen Zustand befindet. |
expectedExecutionTime |
string |
Ausführungszeit eines bestimmten Schritts erwartet. Dies ist optional im Updateaktionsplan erstellt und kann leer sein. |
lastUpdatedTimeUtc |
string (date-time) |
Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts. |
name |
string |
Name des Schritts. |
startTimeUtc |
string (date-time) |
Wenn der Schritt gestartet oder leer ist, wenn er nicht ausgeführt wurde. |
status |
string |
Der Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche eingeblasen wurde. Werte sind: 'Success', 'Error', 'InProgress' und 'Unbekannter Status'. |
steps |
Step[] |
Rekursives Modell für untergeordnete Schritte dieses Schritts. |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
UpdateRun
Details einer Updateausführung
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.duration |
string |
Dauer der Aktualisierungsausführung. |
properties.lastUpdatedTime |
string (date-time) |
Zeitstempel des zuletzt abgeschlossenen Schritts in der Updateausführung. |
properties.progress.description |
string |
Ausführlichere Beschreibung des Schritts. |
properties.progress.endTimeUtc |
string (date-time) |
Wenn der Schritt einen Terminalzustand erreicht hat. |
properties.progress.errorMessage |
string |
Fehlermeldung, angegeben, wenn sich der Schritt in einem fehlgeschlagenen Zustand befindet. |
properties.progress.expectedExecutionTime |
string |
Ausführungszeit eines bestimmten Schritts erwartet. Dies ist optional im Updateaktionsplan erstellt und kann leer sein. |
properties.progress.lastUpdatedTimeUtc |
string (date-time) |
Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts. |
properties.progress.name |
string |
Name des Schritts. |
properties.progress.startTimeUtc |
string (date-time) |
Wenn der Schritt gestartet oder leer ist, wenn er nicht ausgeführt wurde. |
properties.progress.status |
string |
Der Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche eingeblasen wurde. Werte sind: 'Success', 'Error', 'InProgress' und 'Unbekannter Status'. |
properties.progress.steps |
Step[] |
Rekursives Modell für untergeordnete Schritte dieses Schritts. |
properties.provisioningState |
Bereitstellungsstatus der UpdateRuns-Proxyressource. |
|
properties.state |
Status der Updateausführung. |
|
properties.timeStarted |
string (date-time) |
Der Zeitstempel der Updateausführung wurde gestartet. |
systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
|
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
updateRunPropertiesState
Status der Updateausführung.
Wert | Beschreibung |
---|---|
Failed | |
InProgress | |
Succeeded | |
Unknown |