Lab Plans - Create Or Update

Layanan:: Lab Services

Versi API:: 2023-06-07

Memperbarui atau membuat sumber daya Paket Lab.
Operasi untuk membuat atau memperbarui sumber daya Rencana Lab.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}?api-version=2023-06-07

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
labPlanName	path	True	string minLength: 1 maxLength: 100	Nama paket lab yang secara unik mengidentifikasinya dalam grup sumber daya yang berisi. Digunakan dalam URI sumber daya dan di UI.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi geografis tempat sumber daya berada
identity		Identity	Informasi Identitas Terkelola
properties.allowedRegions		string[]	Wilayah yang diizinkan untuk digunakan pembuat lab saat membuat lab menggunakan rencana lab ini.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Profil matikan lab default. Ini dapat diubah pada sumber daya lab dan hanya menyediakan profil default.
properties.defaultConnectionProfile		ConnectionProfile	Profil koneksi lab default. Ini dapat diubah pada sumber daya lab dan hanya menyediakan profil default.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Profil jaringan rencana lab. Untuk menerapkan kebijakan jaringan lab, kebijakan tersebut harus didefinisikan di sini dan tidak dapat diubah ketika ada lab yang terkait dengan rencana lab ini.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Url Dasar instans lms, rencana lab ini dapat menautkan daftar nama lab.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	ID sumber daya Shared Image Gallery yang dilampirkan ke paket lab ini. Saat menyimpan citra komputer virtual templat lab, gambar tersebut akan bertahan di galeri ini. Gambar bersama dari galeri dapat disediakan untuk digunakan saat membuat lab baru.
properties.supportInfo		SupportInfo	Mendukung informasi kontak dan instruksi untuk pengguna paket lab. Informasi ini ditampilkan kepada pemilik lab dan pengguna komputer virtual untuk semua lab dalam paket lab.
tags		object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	LabPlan	Pembaruan berhasil; respons berisi Rencana Lab.
201 Created	LabPlan	Pembuatan berhasil; respons berisi Rencana Lab.
202 Accepted	LabPlan	Pembaruan berhasil dan memiliki operasi yang berjalan lama; respons berisi Rencana Lab.
Other Status Codes	ErrorResponse	Respons kesalahan default.

Contoh

putLabPlan

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan?api-version=2023-06-07

{
  "location": "westus",
  "properties": {
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Kode status:: 201

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Creating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Kode status:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Updating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Definisi

Nama	Deskripsi
AutoShutdownProfile	Profil tentang cara menangani mematikan komputer virtual.
ConnectionProfile	Profil koneksi untuk cara pengguna terhubung ke komputer virtual lab.
ConnectionType	Tingkat akses yang diaktifkan untuk Akses Web melalui SSH.
createdByType	Jenis identitas yang membuat sumber daya.
EnableState	Apakah matikan saat pemutusan sambungan diaktifkan
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
Identity	Identitas untuk sumber daya.
LabPlan	Rencana Lab bertindak sebagai kontainer izin untuk membuat lab melalui labs.azure.com. Selain itu, mereka dapat menyediakan serangkaian konfigurasi default yang akan berlaku pada saat membuat lab, tetapi default ini masih dapat ditimpa.
LabPlanNetworkProfile	Profil tentang cara menangani jaringan untuk Rencana Lab.
ProvisioningState	Status provisi rencana lab saat ini.
ResourceIdentityType	Jenis identitas.
ResourceOperationError	Detail kesalahan kegagalan operasi terbaru pada sumber daya ini
shutdownOnIdleMode	Menentukan apakah akan mematikan VM saat diam dan kriteria untuk deteksi diam.
SupportInfo	Mendukung informasi kontak dan instruksi.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AutoShutdownProfile

Objek

Profil tentang cara menangani mematikan komputer virtual.

Nama	Jenis	Nilai default	Deskripsi
disconnectDelay	string (duration)		Jumlah waktu VM akan tetap berjalan setelah pengguna terputus jika perilaku ini diaktifkan.
idleDelay	string (duration)		Jumlah waktu VM akan menganggur sebelum dimatikan jika perilaku ini diaktifkan.
noConnectDelay	string (duration)		Jumlah waktu VM akan tetap berjalan sebelum dimatikan jika tidak ada koneksi yang dibuat dan perilaku ini diaktifkan.
shutdownOnDisconnect	EnableState	Disabled	Apakah matikan saat pemutusan sambungan diaktifkan
shutdownOnIdle	shutdownOnIdleMode	None	Apakah VM akan dimatikan ketika telah diam selama jangka waktu tertentu.
shutdownWhenNotConnected	EnableState	Disabled	Apakah VM akan dimatikan ketika belum tersambung setelah jangka waktu tertentu.

ConnectionProfile

Objek

Profil koneksi untuk cara pengguna terhubung ke komputer virtual lab.

Nama	Jenis	Nilai default	Deskripsi
clientRdpAccess	ConnectionType	None	Tingkat akses yang diaktifkan untuk Akses Klien melalui RDP.
clientSshAccess	ConnectionType	None	Tingkat akses yang diaktifkan untuk Akses Klien melalui SSH.
webRdpAccess	ConnectionType	None	Tingkat akses yang diaktifkan untuk Akses Web melalui RDP.
webSshAccess	ConnectionType	None	Tingkat akses yang diaktifkan untuk Akses Web melalui SSH.

ConnectionType

Enumeration

Tingkat akses yang diaktifkan untuk Akses Web melalui SSH.

Nilai	Deskripsi
Public
Private
None

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

EnableState

Enumeration

Apakah matikan saat pemutusan sambungan diaktifkan

Nilai	Deskripsi
Enabled
Disabled

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

Identity

Objek

Identitas untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string	ID utama identitas sumber daya.
tenantId	string	ID penyewa sumber daya.
type	ResourceIdentityType	Jenis identitas.

LabPlan

Objek

Rencana Lab bertindak sebagai kontainer izin untuk membuat lab melalui labs.azure.com. Selain itu, mereka dapat menyediakan serangkaian konfigurasi default yang akan berlaku pada saat membuat lab, tetapi default ini masih dapat ditimpa.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informasi Identitas Terkelola
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.allowedRegions	string[]	Wilayah yang diizinkan untuk digunakan pembuat lab saat membuat lab menggunakan rencana lab ini.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Profil matikan lab default. Ini dapat diubah pada sumber daya lab dan hanya menyediakan profil default.
properties.defaultConnectionProfile	ConnectionProfile	Profil koneksi lab default. Ini dapat diubah pada sumber daya lab dan hanya menyediakan profil default.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Profil jaringan rencana lab. Untuk menerapkan kebijakan jaringan lab, kebijakan tersebut harus didefinisikan di sini dan tidak dapat diubah ketika ada lab yang terkait dengan rencana lab ini.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Url Dasar instans lms, rencana lab ini dapat menautkan daftar nama lab.
properties.provisioningState	ProvisioningState	Status provisi rencana lab saat ini.
properties.resourceOperationError	ResourceOperationError	Detail kesalahan operasi terakhir yang dilakukan pada rencana lab.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	ID sumber daya Shared Image Gallery yang dilampirkan ke paket lab ini. Saat menyimpan citra komputer virtual templat lab, gambar tersebut akan bertahan di galeri ini. Gambar bersama dari galeri dapat disediakan untuk digunakan saat membuat lab baru.
properties.supportInfo	SupportInfo	Mendukung informasi kontak dan instruksi untuk pengguna paket lab. Informasi ini ditampilkan kepada pemilik lab dan pengguna komputer virtual untuk semua lab dalam paket lab.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir rencana lab.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Objek

Profil tentang cara menangani jaringan untuk Rencana Lab.

Nama	Jenis	Deskripsi
subnetId	string minLength: 3 maxLength: 2000	Id sumber daya subnet eksternal

ProvisioningState

Enumeration

Status provisi rencana lab saat ini.

Nilai	Deskripsi
Creating	Sumber daya sedang dalam proses dibuat.
Updating	Nilai properti baru sedang diterapkan ke sumber daya.
Deleting	Sumber daya sedang dalam proses dihapus.
Succeeded	Sumber daya dalam keadaan sehat setelah operasi pembuatan atau pembaruan.
Failed	Operasi sebelumnya pada sumber daya gagal meninggalkan sumber daya dalam keadaan tidak sehat.
Locked	Sumber daya dikunci dan perubahan saat ini diblokir. Ini bisa disebabkan oleh pemeliharaan atau operasi terjadwal. Status akan kembali berhasil setelah operasi penguncian selesai.

ResourceIdentityType

Enumeration

Jenis identitas.

Nilai	Deskripsi
SystemAssigned

ResourceOperationError

Objek

Detail kesalahan kegagalan operasi terbaru pada sumber daya ini

Nama	Jenis	Deskripsi
action	string	Tindakan operasi yang gagal
code	string	Kode yang sesuai dengan jenis kegagalan operasi
message	string	Pesan kegagalan operasi
timestamp	string (date-time)	Tanggalwaktu ketika kesalahan terjadi

shutdownOnIdleMode

Enumeration

Menentukan apakah akan mematikan VM saat diam dan kriteria untuk deteksi diam.

Nilai	Deskripsi
None	VM tidak akan dimatikan saat diam.
UserAbsence	VM akan dianggap menganggur ketika tidak ada input keyboard atau mouse.
LowUsage	VM akan dianggap menganggur ketika pengguna tidak ada dan konsumsi sumber daya (CPU dan disk) rendah.

SupportInfo

Objek

Mendukung informasi kontak dan instruksi.

Nama	Jenis	Deskripsi
email	string minLength: 6 maxLength: 254	Mendukung alamat email kontak.
instructions	string	Instruksi dukungan.
phone	string minLength: 1 maxLength: 31	Nomor telepon kontak dukungan.
url	string minLength: 3 maxLength: 2000	Alamat web dukungan.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Lab Plans - Create Or Update

Parameter URI

Isi Permintaan

Respons

Contoh

putLabPlan

Permintaan sampel

Respon sampel

Definisi

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData