Aracılığıyla paylaş


Consoles - Get

Sanal makine konsolunu alın.
Sağlanan sanal makine konsolunun özelliklerini alın.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}?api-version=2023-07-01

URI Parametreleri

Name İçinde Gerekli Tür Description
consoleName
path True

string

Sanal makine konsolunun adı.

Normal ifade deseni: ^default$

resourceGroupName
path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.

subscriptionId
path True

string

uuid

Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.

virtualMachineName
path True

string

Sanal makinenin adı.

Normal ifade deseni: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name Tür Description
200 OK

Console

Tamam

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get virtual machine console

Örnek isteği

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default?api-version=2023-07-01

Örnek yanıt

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default",
  "name": "default",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/virtualMachines/consoles",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"
  },
  "properties": {
    "sshPublicKey": {
      "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
    },
    "enabled": "True",
    "expiration": "2022-06-01T01:27:03.008Z",
    "provisioningState": "Succeeded",
    "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls",
    "virtualMachineAccessId": "VirtualMachineAccessId",
    "detailedStatus": "Ready",
    "detailedStatusMessage": "Console is ready for use"
  }
}

Tanımlar

Name Description
Console

Konsol, şirket içi Ağ Bulutu sanal makinesinin konsolunu temsil eder.

ConsoleDetailedStatus

Konsolun daha ayrıntılı durumu.

ConsoleEnabled

Konsol erişiminin etkinleştirilip etkinleştirilmediğini gösteren gösterge.

ConsoleProvisioningState

Sanal makine konsolunun sağlama durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

ExtendedLocation

ExtendedLocation, kaynağın oluşturulacağı Azure özel konumunu temsil eder.

SshPublicKey

SshPublicKey, SSH aracılığıyla bir kaynakla kimlik doğrulaması yapmak için kullanılan ortak anahtarı temsil eder.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Console

Konsol, şirket içi Ağ Bulutu sanal makinesinin konsolunu temsil eder.

Name Tür Description
extendedLocation

ExtendedLocation

ExtendedLocation, kaynağın oluşturulacağı Azure özel konumunu temsil eder.
Bu sanal makinenin oluşturulduğu kümeyle ilişkili küme yöneticisinin genişletilmiş konumu.

id

string

Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Kaynağın bulunduğu coğrafi konum

name

string

Kaynağın adı

properties.detailedStatus

ConsoleDetailedStatus

Konsolun daha ayrıntılı durumu.

properties.detailedStatusMessage

string

Geçerli ayrıntılı durumla ilgili açıklayıcı ileti.

properties.enabled

ConsoleEnabled

Konsol erişiminin etkinleştirilip etkinleştirilmediğini gösteren gösterge.

properties.expiration

string

Anahtarın erişim izninin verileceği tarih ve saat.

properties.privateLinkServiceId

string

Sanal makine konsolu erişimi sağlamak için kullanılan özel bağlantı hizmetinin kaynak kimliği.

properties.provisioningState

ConsoleProvisioningState

Sanal makine konsolunun sağlama durumu.

properties.sshPublicKey

SshPublicKey

SshPublicKey, SSH aracılığıyla bir kaynakla kimlik doğrulaması yapmak için kullanılan ortak anahtarı temsil eder.
Kullanıcı erişimi için sağlanacak SSH ortak anahtarı. Kullanıcının oturum açmak için ilgili SSH özel anahtarına sahip olması beklenir.

properties.virtualMachineAccessId

string

Konsola erişmek için kullanılan sanal makinenin benzersiz tanımlayıcısı.

systemData

systemData

Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.

tags

object

Kaynak etiketleri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Konsolun daha ayrıntılı durumu.

Name Tür Description
Error

string

Ready

string

ConsoleEnabled

Konsol erişiminin etkinleştirilip etkinleştirilmediğini gösteren gösterge.

Name Tür Description
False

string

True

string

ConsoleProvisioningState

Sanal makine konsolunun sağlama durumu.

Name Tür Description
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

ExtendedLocation

ExtendedLocation, kaynağın oluşturulacağı Azure özel konumunu temsil eder.

Name Tür Description
name

string

Kaynağın oluşturulacağı genişletilmiş konumun kaynak kimliği.

type

string

Genişletilmiş konum türü, örneğin CustomLocation.

SshPublicKey

SshPublicKey, SSH aracılığıyla bir kaynakla kimlik doğrulaması yapmak için kullanılan ortak anahtarı temsil eder.

Name Tür Description
keyData

string

SSH ortak anahtar verileri.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.