Sdílet prostřednictvím


Consoles - Get

Načtěte konzolu virtuálního počítače.
Získejte vlastnosti poskytnuté konzoly virtuálního počítače.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
consoleName
path True

string

Název konzoly virtuálního počítače.

Vzor regulárního výrazu: ^default$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

uuid

ID cílového předplatného. Hodnota musí být UUID.

virtualMachineName
path True

string

Název virtuálního počítače.

Vzor regulárního výrazu: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

Console

OK

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get virtual machine console

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
Console

Konzola představuje konzolu místního virtuálního počítače Network Cloud.

ConsoleDetailedStatus

Podrobnější stav konzoly

ConsoleEnabled

Indikátor, jestli je povolený přístup ke konzole.

ConsoleProvisioningState

Stav zřizování konzoly virtuálního počítače.

createdByType

Typ identity, která vytvořila prostředek.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Odpověď na chybu

ExtendedLocation

ExtendedLocation představuje vlastní umístění Azure, ve kterém se prostředek vytvoří.

SshPublicKey

SshPublicKey představuje veřejný klíč, který se používá k ověření prostředku prostřednictvím SSH.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Console

Konzola představuje konzolu místního virtuálního počítače Network Cloud.

Name Typ Description
extendedLocation

ExtendedLocation

ExtendedLocation představuje vlastní umístění Azure, ve kterém se prostředek vytvoří.
Rozšířené umístění správce clusteru přidruženého ke clusteru, pro který je tento virtuální počítač vytvořen.

id

string

Plně kvalifikované ID prostředku. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Geografické umístění, ve kterém se nachází prostředek

name

string

Název prostředku

properties.detailedStatus

ConsoleDetailedStatus

Podrobnější stav konzoly

properties.detailedStatusMessage

string

Popisná zpráva o aktuálním podrobném stavu.

properties.enabled

ConsoleEnabled

Indikátor, jestli je povolený přístup ke konzole.

properties.expiration

string

Datum a čas, po jehož uplynutí bude přístup ke klíči zakázán.

properties.privateLinkServiceId

string

ID prostředku služby private link, která se používá k poskytování přístupu ke konzole virtuálního počítače.

properties.provisioningState

ConsoleProvisioningState

Stav zřizování konzoly virtuálního počítače.

properties.sshPublicKey

SshPublicKey

SshPublicKey představuje veřejný klíč, který se používá k ověření prostředku prostřednictvím SSH.
Veřejný klíč SSH, který se zřídí pro uživatelský přístup. Očekává se, že uživatel bude mít odpovídající privátní klíč SSH pro přihlášení.

properties.virtualMachineAccessId

string

Jedinečný identifikátor virtuálního počítače, který se používá pro přístup ke konzole.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

tags

object

Značky prostředků.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ConsoleDetailedStatus

Podrobnější stav konzoly

Name Typ Description
Error

string

Ready

string

ConsoleEnabled

Indikátor, jestli je povolený přístup ke konzole.

Name Typ Description
False

string

True

string

ConsoleProvisioningState

Stav zřizování konzoly virtuálního počítače.

Name Typ Description
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

ExtendedLocation

ExtendedLocation představuje vlastní umístění Azure, ve kterém se prostředek vytvoří.

Name Typ Description
name

string

ID prostředku rozšířeného umístění, ve kterém se prostředek vytvoří.

type

string

Typ rozšířeného umístění, například CustomLocation.

SshPublicKey

SshPublicKey představuje veřejný klíč, který se používá k ověření prostředku prostřednictvím SSH.

Name Typ Description
keyData

string

Data veřejného klíče SSH.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která vytvořila prostředek.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.