Deployments - Create Or Update Deployment

Service:: Device Update

Version d'API:: 2020-09-01

Crée ou met à jour un déploiement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountEndpoint	path	True	string	Point de terminaison de compte.
deploymentId	path	True	string	Identificateur de déploiement.
instanceId	path	True	string	Identificateur d’instance de compte.

Corps de la demande

Nom	Obligatoire	Type	Description
deploymentId	True	string	Obtient ou définit l’identificateur de déploiement.
deploymentType	True	DeploymentType	Obtient ou définit le type de déploiement.
deviceGroupDefinition	True	string[]	Obtient ou définit la définition du groupe d’appareils.
deviceGroupType	True	DeviceGroupType	Obtient ou définit le type de groupe d’appareils.
startDateTime	True	string (date-time)	Obtient ou définit la date de début du déploiement.
updateId	True	UpdateId	Mettre à jour l’identité.
deviceClassId		string	Obtient ou définit l’identificateur de classe d’appareil.
isCanceled		boolean	Indicateur booléen indiquant si le déploiement a été annulé.
isCompleted		boolean	Indicateur booléen indiquant si le déploiement a été terminé.
isRetried		boolean	Indicateur booléen indiquant si le déploiement a été retenté.

Réponses

Nom	Type	Description
200 OK	Deployment	Propriétés de déploiement.
404 Not Found		Introuvable.

Sécurité

azure_auth_implicit

Flux implicite OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

azure_auth_code

Flux AccessCode OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

azure_auth_application

Flux d’application OAuth2 Azure Active Directory

Type: oauth2
Flux: application
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom	Description
.default	étendue des informations d’identification du client

azure_auth_password

Flux de mot de passe OAuth2 Azure Active Directory

Type: oauth2
Flux: password
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Deployments_CreateOrUpdateDeployment

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 404

Définitions

Nom	Description
Deployment	Métadonnées de déploiement.
DeploymentType	Types de déploiement pris en charge.
DeviceGroupType	Types de groupes de déploiement pris en charge.
UpdateId	Mettre à jour l’identificateur.

Deployment

Object

Métadonnées de déploiement.

Nom	Type	Description
deploymentId	string	Obtient ou définit l’identificateur de déploiement.
deploymentType	DeploymentType	Obtient ou définit le type de déploiement.
deviceClassId	string	Obtient ou définit l’identificateur de classe d’appareil.
deviceGroupDefinition	string[]	Obtient ou définit la définition du groupe d’appareils.
deviceGroupType	DeviceGroupType	Obtient ou définit le type de groupe d’appareils.
isCanceled	boolean	Indicateur booléen indiquant si le déploiement a été annulé.
isCompleted	boolean	Indicateur booléen indiquant si le déploiement a été terminé.
isRetried	boolean	Indicateur booléen indiquant si le déploiement a été retenté.
startDateTime	string (date-time)	Obtient ou définit la date de début du déploiement.
updateId	UpdateId	Mettre à jour l’identité.

DeploymentType

Énumération

Types de déploiement pris en charge.

Valeur	Description
Complete	Un déploiement complet, y compris le téléchargement, l’installation et l’application d’actions.
Download	Déploiement en téléchargement uniquement qui n’inclut aucune installation ni aucune action d’application. N’est pas pris en charge actuellement.
Install	Déploiement d’installation uniquement qui n’inclut aucune action de téléchargement, installez et terminez uniquement. N’est pas pris en charge actuellement.

DeviceGroupType

Énumération

Types de groupes de déploiement pris en charge.

Valeur	Description
All	Le déploiement doit être envoyé à tous les appareils de la classe d’appareil.
Devices	Le déploiement doit être envoyé à la liste des appareils dans la définition du groupe d’appareils.
DeviceGroupDefinitions	Le déploiement doit être envoyé à la liste des appareils retournés par l’union de toutes les requêtes de définition de groupe d’appareils.

UpdateId

Object

Mettre à jour l’identificateur.

Nom	Type	Description
name	string	Nom de mise à jour.
provider	string	Mettre à jour le fournisseur.
version	string	Mettre à jour la version.