Deployments - Create Or Update Deployment

Tjänst:

Device Update

API-version:

2020-09-01

Skapar eller uppdaterar en distribution.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountEndpoint	path	True	string	Kontoslutpunkt.
deploymentId	path	True	string	Distributionsidentifierare.
instanceId	path	True	string	Kontoinstansidentifierare.

Begärandetext

Name	Obligatorisk	Typ	Description
deploymentId	True	string	Hämtar eller anger distributionsidentifieraren.
deploymentType	True	DeploymentType	Hämtar eller anger distributionstypen.
deviceGroupDefinition	True	string[]	Hämtar eller anger enhetsgruppsdefinitionen.
deviceGroupType	True	DeviceGroupType	Hämtar eller anger enhetsgruppstypen.
startDateTime	True	string (date-time)	Hämtar eller anger startdatumtid för distribution.
updateId	True	UpdateId	Uppdatera identitet.
deviceClassId		string	Hämtar eller anger enhetsklassidentifieraren.
isCanceled		boolean	Boolesk flagga som anger om distributionen avbröts.
isCompleted		boolean	Boolesk flagga som anger om distributionen har slutförts.
isRetried		boolean	Boolesk flagga som anger om distributionen har gjorts om.

Svar

Name	Typ	Description
200 OK	Deployment	Distributionsegenskaperna.
404 Not Found		Hittades inte.

Säkerhet

azure_auth_implicit

Implicit flöde i Azure Active Directory OAuth2

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

azure_auth_code

Azure Active Directory OAuth2 AccessCode-flöde

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/v2.0/token

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

azure_auth_application

Azure Active Directory OAuth2-programflöde

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

Omfattningar

Name	Description
.default	omfång för klientautentiseringsuppgifter

azure_auth_password

Azure Active Directory OAuth2-lösenordsflöde

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Deployments_CreateOrUpdateDeployment

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:

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"
  }
}

Statuskod:

404

Definitioner

Name	Description
Deployment	Distributionsmetadata.
DeploymentType	Distributionstyper som stöds.
DeviceGroupType	Distributionsgrupptyper som stöds.
UpdateId	Uppdatera identifierare.

Deployment

Objekt

Distributionsmetadata.

Name	Typ	Description
deploymentId	string	Hämtar eller anger distributionsidentifieraren.
deploymentType	DeploymentType	Hämtar eller anger distributionstypen.
deviceClassId	string	Hämtar eller anger enhetsklassidentifieraren.
deviceGroupDefinition	string[]	Hämtar eller anger enhetsgruppsdefinitionen.
deviceGroupType	DeviceGroupType	Hämtar eller anger enhetsgruppstypen.
isCanceled	boolean	Boolesk flagga som anger om distributionen avbröts.
isCompleted	boolean	Boolesk flagga som anger om distributionen har slutförts.
isRetried	boolean	Boolesk flagga som anger om distributionen har gjorts om.
startDateTime	string (date-time)	Hämtar eller anger startdatumtid för distribution.
updateId	UpdateId	Uppdatera identitet.

DeploymentType

Uppräkning

Distributionstyper som stöds.

Värde	Description
Complete	En fullständig distribution, inklusive åtgärder för att ladda ned, installera och tillämpa.
Download	En nedladdningsbaserad distribution som inte innehåller några installations- eller tillämpningsåtgärder. Stöds inte för närvarande.
Install	En distribution med endast installation som inte innehåller några nedladdningsåtgärder, endast installation och slutförande. Stöds inte för närvarande.

DeviceGroupType

Uppräkning

Distributionsgrupptyper som stöds.

Värde	Description
All	Distributionen ska skickas till alla enheter i enhetsklassen.
Devices	Distributionen ska skickas till listan över enheter i enhetsgruppens definition.
DeviceGroupDefinitions	Distributionen ska skickas till listan över enheter som returneras av unionen av alla definitionsfrågor för enhetsgrupper.

UpdateId

Objekt

Uppdatera identifierare.

Name	Typ	Description
name	string	Uppdateringsnamn.
provider	string	Uppdateringsprovider.
version	string	Uppdatera version.