Deployments - Create Or Update Deployment

Service:

Device Update

API-versie:

2020-09-01

Hiermee maakt of werkt u een implementatie bij.

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

URI-parameters

Name	In	Vereist	Type	Description
accountEndpoint	path	True	string	Accounteindpunt.
deploymentId	path	True	string	Implementatie-id.
instanceId	path	True	string	Accountinstantie-id.

Aanvraagbody

Name	Vereist	Type	Description
deploymentId	True	string	Hiermee haalt u de implementatie-id op of stelt u deze in.
deploymentType	True	DeploymentType	Hiermee haalt u het implementatietype op of stelt u dit in.
deviceGroupDefinition	True	string[]	Hiermee haalt u de definitie van de apparaatgroep op of stelt u deze in.
deviceGroupType	True	DeviceGroupType	Hiermee haalt u het type apparaatgroep op of stelt u dit in.
startDateTime	True	string (date-time)	Hiermee haalt u de begindatum/tijd van de implementatie op of stelt u deze in.
updateId	True	UpdateId	Identiteit bijwerken.
deviceClassId		string	Hiermee haalt u de apparaatklasse-id op of stelt u deze in.
isCanceled		boolean	Booleaanse vlag die aangeeft of de implementatie is geannuleerd.
isCompleted		boolean	Booleaanse vlag die aangeeft of de implementatie is voltooid.
isRetried		boolean	Booleaanse vlag die aangeeft of de implementatie opnieuw is geprobeerd.

Antwoorden

Name	Type	Description
200 OK	Deployment	De implementatie-eigenschappen.
404 Not Found		Niet gevonden.

Beveiliging

azure_auth_implicit

Impliciete stroom van Azure Active Directory OAuth2

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

azure_auth_code

Azure Active Directory OAuth2 AccessCode Flow

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

azure_auth_application

Azure Active Directory OAuth2-toepassingsstroom

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

Bereiken

Name	Description
.default	referentiebereik van client

azure_auth_password

Azure Active Directory OAuth2-wachtwoordstroom

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Deployments_CreateOrUpdateDeployment

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
Deployment	Metagegevens van de implementatie.
DeploymentType	Ondersteunde implementatietypen.
DeviceGroupType	Ondersteunde typen implementatiegroepen.
UpdateId	Id bijwerken.

Deployment

Object

Metagegevens van de implementatie.

Name	Type	Description
deploymentId	string	Hiermee haalt u de implementatie-id op of stelt u deze in.
deploymentType	DeploymentType	Hiermee haalt u het implementatietype op of stelt u dit in.
deviceClassId	string	Hiermee haalt u de apparaatklasse-id op of stelt u deze in.
deviceGroupDefinition	string[]	Hiermee haalt u de definitie van de apparaatgroep op of stelt u deze in.
deviceGroupType	DeviceGroupType	Hiermee haalt u het type apparaatgroep op of stelt u dit in.
isCanceled	boolean	Booleaanse vlag die aangeeft of de implementatie is geannuleerd.
isCompleted	boolean	Booleaanse vlag die aangeeft of de implementatie is voltooid.
isRetried	boolean	Booleaanse vlag die aangeeft of de implementatie opnieuw is geprobeerd.
startDateTime	string (date-time)	Hiermee haalt u de begindatum/tijd van de implementatie op of stelt u deze in.
updateId	UpdateId	Identiteit bijwerken.

DeploymentType

Inventarisatie

Ondersteunde implementatietypen.

Waarde	Description
Complete	Een volledige implementatie, waaronder het downloaden, installeren en toepassen van acties.
Download	Een implementatie met alleen downloaden die geen installatie- of toepassingsacties bevat. Momenteel niet ondersteund.
Install	Een alleen-installeren implementatie die geen downloadacties bevat, alleen installeren en voltooien. Momenteel niet ondersteund.

DeviceGroupType

Inventarisatie

Ondersteunde typen implementatiegroepen.

Waarde	Description
All	De implementatie moet worden verzonden naar alle apparaten in de apparaatklasse.
Devices	De implementatie moet worden verzonden naar de lijst met apparaten in de definitie van de apparaatgroep.
DeviceGroupDefinitions	De implementatie moet worden verzonden naar de lijst met apparaten die worden geretourneerd door de samenvoeging van alle definities van de apparaatgroep.

UpdateId

Object

Id bijwerken.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Updateprovider.
version	string	Updateversie.