Deployments - Create Or Update Deployment

Servizio:: Device Update

Versione API:: 2020-09-01

Crea o aggiorna una distribuzione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountEndpoint	path	True	string	Endpoint dell'account.
deploymentId	path	True	string	Identificatore di distribuzione.
instanceId	path	True	string	Identificatore dell'istanza dell'account.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
deploymentId	True	string	Ottiene o imposta l'identificatore di distribuzione.
deploymentType	True	DeploymentType	Ottiene o imposta il tipo di distribuzione.
deviceGroupDefinition	True	string[]	Ottiene o imposta la definizione del gruppo di dispositivi.
deviceGroupType	True	DeviceGroupType	Ottiene o imposta il tipo di gruppo di dispositivi.
startDateTime	True	string (date-time)	Ottiene o imposta l'ora di inizio della distribuzione.
updateId	True	UpdateId	Aggiornare l'identità.
deviceClassId		string	Ottiene o imposta l'identificatore della classe del dispositivo.
isCanceled		boolean	Flag booleano che indica se la distribuzione è stata annullata.
isCompleted		boolean	Flag booleano che indica se la distribuzione è stata completata.
isRetried		boolean	Flag booleano che indica se la distribuzione è stata ritentata.

Risposte

Nome	Tipo	Descrizione
200 OK	Deployment	Proprietà di distribuzione.
404 Not Found		Non trovato.

Sicurezza

azure_auth_implicit

Flusso implicito OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

azure_auth_code

Flusso di codice di accesso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

azure_auth_application

Flusso dell'applicazione OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: application
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ambiti

Nome	Descrizione
.default	ambito delle credenziali client

azure_auth_password

Flusso password OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: password
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Deployments_CreateOrUpdateDeployment

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 404

Definizioni

Nome	Descrizione
Deployment	Metadati della distribuzione.
DeploymentType	Tipi di distribuzione supportati.
DeviceGroupType	Tipi di gruppo di distribuzione supportati.
UpdateId	Aggiornare l'identificatore.

Deployment

Object

Metadati della distribuzione.

Nome	Tipo	Descrizione
deploymentId	string	Ottiene o imposta l'identificatore di distribuzione.
deploymentType	DeploymentType	Ottiene o imposta il tipo di distribuzione.
deviceClassId	string	Ottiene o imposta l'identificatore della classe del dispositivo.
deviceGroupDefinition	string[]	Ottiene o imposta la definizione del gruppo di dispositivi.
deviceGroupType	DeviceGroupType	Ottiene o imposta il tipo di gruppo di dispositivi.
isCanceled	boolean	Flag booleano che indica se la distribuzione è stata annullata.
isCompleted	boolean	Flag booleano che indica se la distribuzione è stata completata.
isRetried	boolean	Flag booleano che indica se la distribuzione è stata ritentata.
startDateTime	string (date-time)	Ottiene o imposta l'ora di inizio della distribuzione.
updateId	UpdateId	Aggiornare l'identità.

DeploymentType

Enumerazione

Tipi di distribuzione supportati.

Valore	Descrizione
Complete	Una distribuzione completa, tra cui il download, l'installazione e l'applicazione di azioni.
Download	Distribuzione di sola download che non include alcuna azione di installazione o applicazione. Attualmente non supportata.
Install	Implementazione di sola installazione che non include azioni di download, solo installazione e completamento. Attualmente non supportata.

DeviceGroupType

Enumerazione

Tipi di gruppo di distribuzione supportati.

Valore	Descrizione
All	La distribuzione deve essere inviata a tutti i dispositivi nella classe del dispositivo.
Devices	La distribuzione deve essere inviata all'elenco di dispositivi nella definizione del gruppo di dispositivi.
DeviceGroupDefinitions	La distribuzione deve essere inviata all'elenco dei dispositivi restituiti dall'unione di tutte le query di definizione del gruppo di dispositivi.

UpdateId

Object

Aggiornare l'identificatore.

Nome	Tipo	Descrizione
name	string	Aggiornare il nome.
provider	string	Provider di aggiornamento.
version	string	Aggiornare la versione.