Update Runs - Put

Referenz

Service:: Azure Stack HCI

API Version:: 2023-06-01

Put-Updateausführungen für ein angegebenes Update

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}?api-version=2023-06-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Clusters.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
updateName	path	True	string	Der Name des Updates
updateRunName	path	True	string	Der Name der Updateausführung
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
location	string	Der geografische Standort, an dem sich die Ressource befindet
properties.duration	string	Dauer der Updateausführung.
properties.lastUpdatedTime	string	Zeitstempel des zuletzt abgeschlossenen Schritts in der Updateausführung.
properties.progress.description	string	Ausführlichere Beschreibung des Schritts.
properties.progress.endTimeUtc	string	Wenn der Schritt einen Endzustand erreicht hat.
properties.progress.errorMessage	string	Fehlermeldung, die angegeben wird, wenn sich der Schritt im Fehlerzustand befindet.
properties.progress.lastUpdatedTimeUtc	string	Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts.
properties.progress.name	string	Name des Schritts
properties.progress.startTimeUtc	string	Wenn der Schritt gestartet wurde, oder leer, wenn er nicht mit der Ausführung begonnen hat.
properties.progress.status	string	Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche angezeigt wird. Die Werte sind: "Success", "Error", "InProgress" und "Unknown status".
properties.progress.steps	Step[]	Rekursives Modell für untergeordnete Schritte dieses Schritts.
properties.state	updateRunPropertiesState	Status der Updateausführung.
properties.timeStarted	string	Der Zeitstempel der Updateausführung wurde gestartet.

Antworten

Name	Typ	Beschreibung
200 OK	UpdateRun	OK
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

Get Update runs under cluster resource

Sample Request

HTTP

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=2023-06-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": []
        }
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "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
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
ProvisioningState	Bereitstellungsstatus der UpdateRuns-Proxyressource.
Step	Statusdarstellung der Schritte zur Updateausführung.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UpdateRun	Details einer Updateausführung
updateRunPropertiesState	Status der Updateausführung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ProvisioningState

Bereitstellungsstatus der UpdateRuns-Proxyressource.

Name	Typ	Beschreibung
Accepted	string
Canceled	string
Failed	string
Provisioning	string
Succeeded	string

Step

Statusdarstellung der Schritte zur Updateausführung.

Name	Typ	Beschreibung
description	string	Ausführlichere Beschreibung des Schritts.
endTimeUtc	string	Wenn der Schritt einen Endzustand erreicht hat.
errorMessage	string	Fehlermeldung, die angegeben wird, wenn sich der Schritt im Fehlerzustand befindet.
lastUpdatedTimeUtc	string	Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts.
name	string	Name des Schritts
startTimeUtc	string	Wenn der Schritt gestartet wurde, oder leer, wenn er nicht mit der Ausführung begonnen hat.
status	string	Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche angezeigt wird. Die Werte sind: "Success", "Error", "InProgress" und "Unknown status".
steps	Step[]	Rekursives Modell für untergeordnete Schritte dieses Schritts.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	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. Beispiel: /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 Updateausführung.
properties.lastUpdatedTime	string	Zeitstempel des zuletzt abgeschlossenen Schritts in der Updateausführung.
properties.progress.description	string	Ausführlichere Beschreibung des Schritts.
properties.progress.endTimeUtc	string	Wenn der Schritt einen Endzustand erreicht hat.
properties.progress.errorMessage	string	Fehlermeldung, die angegeben wird, wenn sich der Schritt im Fehlerzustand befindet.
properties.progress.lastUpdatedTimeUtc	string	Abschlusszeit dieses Schritts oder des letzten abgeschlossenen Unterschritts.
properties.progress.name	string	Name des Schritts
properties.progress.startTimeUtc	string	Wenn der Schritt gestartet wurde, oder leer, wenn er nicht mit der Ausführung begonnen hat.
properties.progress.status	string	Status des Schritts, der aus dem ECE-Aktionsplan für Installationsversuche angezeigt wird. Die Werte sind: "Success", "Error", "InProgress" und "Unknown status".
properties.progress.steps	Step[]	Rekursives Modell für untergeordnete Schritte dieses Schritts.
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der UpdateRuns-Proxyressource.
properties.state	updateRunPropertiesState	Status der Updateausführung.
properties.timeStarted	string	Der Zeitstempel der Updateausführung wurde gestartet.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

updateRunPropertiesState

Status der Updateausführung.

Name	Typ	Beschreibung
Failed	string
InProgress	string
Succeeded	string
Unknown	string