Serial Ports - Create

Layanan:

Serial Console

Versi API:

2024-07-01

Membuat atau memperbarui port serial

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}?api-version=2024-07-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
parentResource	path	True	string	Nama sumber daya, atau jalur subordinat, untuk induk port serial. Misalnya: nama komputer virtual.
parentResourceType	path	True	string	Jenis sumber daya sumber daya sumber daya induk. Misalnya: 'virtualMachines' atau 'virtualMachineScaleSets'
resourceGroupName	path	True	string	Nama grup sumber daya.
resourceProviderNamespace	path	True	string	Namespace penyedia sumber daya.
serialPort	path	True	string	Nama port serial yang akan dibuat.
subscriptionId	path	True	string	ID Langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan yang memerlukannya.
api-version	query	True	string	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.connectionState	SerialPortConnectionState	Menentukan apakah port saat ini aktif.
properties.state	SerialPortState	Menentukan apakah port diaktifkan untuk koneksi konsol serial.

Respons

Nama	Jenis	Deskripsi
201 Created	SerialPort	Dibuat
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Create a new serial port resource.

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-00000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/providers/Microsoft.SerialConsole/serialPorts/0?api-version=2024-07-01

{
  "properties": {
    "state": "enabled"
  }
}

Respon sampel

Kode status:

201

{
  "name": "0",
  "id": "/subscriptions/00000000-00000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/providers/Microsoft.SerialConsole/serialPorts/0",
  "type": "Microsoft.SerialConsole/serialPorts",
  "properties": {
    "state": "enabled",
    "connectionState": "inactive"
  }
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan Batch.
createdByType	Jenis identitas yang membuat sumber daya.
SerialPort	Port serial
SerialPortConnectionState	Menentukan apakah port saat ini aktif.
SerialPortState	Menentukan apakah port diaktifkan untuk koneksi konsol serial.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Isi kesalahan cloud.

CloudErrorBody

Objek

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

SerialPort

Objek

Port serial

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.connectionState	SerialPortConnectionState	Menentukan apakah port saat ini aktif.
properties.state	SerialPortState	Menentukan apakah port diaktifkan untuk koneksi konsol serial.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SerialPortConnectionState

Enumeration

Menentukan apakah port saat ini aktif.

Nilai	Deskripsi
active
inactive

SerialPortState

Enumeration

Menentukan apakah port diaktifkan untuk koneksi konsol serial.

Nilai	Deskripsi
enabled
disabled

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.