Deployments - Create Or Update Deployment

Layanan:

Device Update

Versi API:

2020-09-01

Membuat atau memperbarui penyebaran.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountEndpoint	path	True	string	Titik akhir akun.
deploymentId	path	True	string	Pengidentifikasi penyebaran.
instanceId	path	True	string	Pengidentifikasi instans akun.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
deploymentId	True	string	Mendapatkan atau mengatur pengidentifikasi penyebaran.
deploymentType	True	DeploymentType	Mendapatkan atau mengatur jenis penyebaran.
deviceGroupDefinition	True	string[]	Mendapatkan atau mengatur definisi grup perangkat.
deviceGroupType	True	DeviceGroupType	Mendapatkan atau mengatur jenis grup perangkat.
startDateTime	True	string (date-time)	Mendapatkan atau mengatur tanggalwaktu mulai penyebaran.
updateId	True	UpdateId	Perbarui identitas.
deviceClassId		string	Mendapatkan atau mengatur pengidentifikasi kelas perangkat.
isCanceled		boolean	Bendera Boolean yang menunjukkan apakah penyebaran dibatalkan.
isCompleted		boolean	Bendera Boolean menunjukkan apakah penyebaran selesai.
isRetried		boolean	Bendera Boolean menunjukkan apakah penyebaran telah dicoba kembali.

Respons

Nama	Jenis	Deskripsi
200 OK	Deployment	Properti penyebaran.
404 Not Found		Tidak ditemukan.

Keamanan

azure_auth_implicit

Alur Implisit Azure Active Directory OAuth2

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

azure_auth_code

Alur AccessCode Azure Active Directory OAuth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

azure_auth_application

Alur Aplikasi Azure Active Directory OAuth2

Jenis: oauth2
Alur: application
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Cakupan

Nama	Deskripsi
.default	cakupan kredensial klien

azure_auth_password

Alur Kata Sandi Azure Active Directory OAuth2

Jenis: oauth2
Alur: password
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Deployments_CreateOrUpdateDeployment

Permintaan sampel

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

Respon sampel

Kode status:

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

Kode status:

404

Definisi

Nama	Deskripsi
Deployment	Metadata penyebaran.
DeploymentType	Jenis penyebaran yang didukung.
DeviceGroupType	Jenis grup penyebaran yang didukung.
UpdateId	Memperbarui pengidentifikasi.

Deployment

Objek

Metadata penyebaran.

Nama	Jenis	Deskripsi
deploymentId	string	Mendapatkan atau mengatur pengidentifikasi penyebaran.
deploymentType	DeploymentType	Mendapatkan atau mengatur jenis penyebaran.
deviceClassId	string	Mendapatkan atau mengatur pengidentifikasi kelas perangkat.
deviceGroupDefinition	string[]	Mendapatkan atau mengatur definisi grup perangkat.
deviceGroupType	DeviceGroupType	Mendapatkan atau mengatur jenis grup perangkat.
isCanceled	boolean	Bendera Boolean yang menunjukkan apakah penyebaran dibatalkan.
isCompleted	boolean	Bendera Boolean menunjukkan apakah penyebaran selesai.
isRetried	boolean	Bendera Boolean menunjukkan apakah penyebaran telah dicoba kembali.
startDateTime	string (date-time)	Mendapatkan atau mengatur tanggalwaktu mulai penyebaran.
updateId	UpdateId	Perbarui identitas.

DeploymentType

Enumeration

Jenis penyebaran yang didukung.

Nilai	Deskripsi
Complete	Penyebaran lengkap termasuk mengunduh, menginstal, dan menerapkan tindakan.
Download	Penyebaran khusus unduhan yang tidak menyertakan tindakan penginstalan atau penerapan apa pun. Saat ini tidak didukung.
Install	Peluncuran khusus penginstalan yang tidak menyertakan tindakan unduhan apa pun, hanya instal dan selesaikan. Saat ini tidak didukung.

DeviceGroupType

Enumeration

Jenis grup penyebaran yang didukung.

Nilai	Deskripsi
All	Penyebaran harus dikirim ke semua perangkat di kelas perangkat.
Devices	Penyebaran harus dikirim ke daftar perangkat dalam definisi grup perangkat.
DeviceGroupDefinitions	Penyebaran harus dikirim ke daftar perangkat yang dikembalikan oleh penyatuan semua kueri definisi grup perangkat.

UpdateId

Objek

Memperbarui pengidentifikasi.

Nama	Jenis	Deskripsi
name	string	Perbarui nama.
provider	string	Perbarui penyedia.
version	string	Perbarui versi.