Deployments - Create Or Update Deployment

Dienst:

Device Update

API-Version:

2020-09-01

Erstellt oder aktualisiert eine Bereitstellung.

PUT https://{accountEndpoint}/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountEndpoint	path	True	string	Kontoendpunkt.
deploymentId	path	True	string	Bereitstellungs-ID.
instanceId	path	True	string	Kontoinstanzbezeichner.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
deploymentId	True	string	Dient zum Abrufen oder Festlegen des Bereitstellungsbezeichners.
deploymentType	True	DeploymentType	Dient zum Abrufen oder Festlegen des Bereitstellungstyps.
deviceGroupDefinition	True	string[]	Dient zum Abrufen oder Festlegen der Gerätegruppendefinition.
deviceGroupType	True	DeviceGroupType	Dient zum Abrufen oder Festlegen des Gerätegruppentyps.
startDateTime	True	string (date-time)	Dient zum Abrufen oder Festlegen des Startdatums der Bereitstellung.
updateId	True	UpdateId	Identität aktualisieren.
deviceClassId		string	Dient zum Abrufen oder Festlegen des Geräteklassenbezeichners.
isCanceled		boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung abgebrochen wurde.
isCompleted		boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung abgeschlossen wurde.
isRetried		boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung erneut versucht wurde.

Antworten

Name	Typ	Beschreibung
200 OK	Deployment	Die Bereitstellungseigenschaften.
404 Not Found		Nicht gefunden.

Sicherheit

azure_auth_implicit

Impliziter Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

azure_auth_code

Azure Active Directory OAuth2 AccessCode-Ablauf

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

azure_auth_application

Azure Active Directory OAuth2-Anwendungsablauf

Typ: oauth2
Ablauf: application
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiche

Name	Beschreibung
.default	Clientanmeldeinformationsbereich

azure_auth_password

Azure Active Directory OAuth2-Kennwortfluss

Typ: oauth2
Ablauf: password
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Deployments_CreateOrUpdateDeployment

Beispielanforderung

HTTP

PUT https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/management/deployments/deploymentId

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

Statuscode:

404

Definitionen

Name	Beschreibung
Deployment	Bereitstellungsmetadaten.
DeploymentType	Unterstützte Bereitstellungstypen.
DeviceGroupType	Unterstützte Bereitstellungsgruppentypen.
UpdateId	Updatebezeichner.

Deployment

Objekt

Bereitstellungsmetadaten.

Name	Typ	Beschreibung
deploymentId	string	Dient zum Abrufen oder Festlegen des Bereitstellungsbezeichners.
deploymentType	DeploymentType	Dient zum Abrufen oder Festlegen des Bereitstellungstyps.
deviceClassId	string	Dient zum Abrufen oder Festlegen des Geräteklassenbezeichners.
deviceGroupDefinition	string[]	Dient zum Abrufen oder Festlegen der Gerätegruppendefinition.
deviceGroupType	DeviceGroupType	Dient zum Abrufen oder Festlegen des Gerätegruppentyps.
isCanceled	boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung abgebrochen wurde.
isCompleted	boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung abgeschlossen wurde.
isRetried	boolean	Boolesche Kennzeichnung, die angibt, ob die Bereitstellung erneut versucht wurde.
startDateTime	string (date-time)	Dient zum Abrufen oder Festlegen des Startdatums der Bereitstellung.
updateId	UpdateId	Identität aktualisieren.

DeploymentType

Enumeration

Unterstützte Bereitstellungstypen.

Wert	Beschreibung
Complete	Eine vollständige Bereitstellung, einschließlich Download, Installation und Anwenden von Aktionen.
Download	Eine nur herunterladende Bereitstellung, die keine Installations- oder Anwendungsmaßnahmen enthält. Zurzeit nicht unterstützt.
Install	Ein Nur-Installationsrollout, das keine Downloadaktionen enthält, nur installieren und abschließen. Zurzeit nicht unterstützt.

DeviceGroupType

Enumeration

Unterstützte Bereitstellungsgruppentypen.

Wert	Beschreibung
All	Die Bereitstellung sollte an alle Geräte in der Geräteklasse gesendet werden.
Devices	Die Bereitstellung sollte an die Liste der Geräte in der Gerätegruppendefinition gesendet werden.
DeviceGroupDefinitions	Die Bereitstellung sollte an die Liste der Geräte gesendet werden, die von der Union aller Gerätegruppendefinitionsabfragen zurückgegeben werden.

UpdateId

Objekt

Updatebezeichner.

Name	Typ	Beschreibung
name	string	Updatename.
provider	string	Updateanbieter.
version	string	Updateversion.