Retrieves information about the run-time state of a virtual machine.
Remote Desktop Manager Free 2021.1.23.0 Organize all your remote connections, manage passwords and usernames, and use the built-in network. Apr 16th 2021, 15:22 GMT. RDCMan manages multiple remote desktop connections. It is useful for managing server labs where you need regular access to each machine such as automated checkin systems and data centers. It is similar to the built-in MMC Remote Desktops snap-in, but more flexible. We would like to show you a description here but the site won’t allow us. About eight months ago, I came across a tool in the repository called Remote Desktop Connection Manager ('RDCMan' for short) written by Julian Burger, one of our principal developers on the Windows Live Experiences team. RDCMan is a central place where you can organize, group, and manage your various Remote Desktop connections.
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
path | True |
| The name of the resource group. | |
subscriptionId | path | True |
| Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
path | True |
| The name of the virtual machine. | |
api-version | query | True |
| Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK | OK |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get instance view of a virtual machine placed on a dedicated host group through automatic placement. |
Get Virtual Machine Instance View. |
Get instance view of a virtual machine placed on a dedicated host group through automatic placement.
Sample Response
Get Virtual Machine Instance View.
Sample Response
Definitions
ApiError | Unfinished a memoir. Api error. |
ApiErrorBase | Api error base. |
AvailablePatchSummary | Describes the properties of an virtual machine instance view for available patch summary. |
BootDiagnosticsInstanceView | The instance view of a virtual machine boot diagnostics. |
DiskEncryptionSettings | Describes a Encryption Settings for a Disk |
DiskInstanceView | The instance view of the disk. |
HyperVGenerationType | Specifies the HyperVGeneration Type |
InnerError | Inner error details. |
InstanceViewStatus | Instance view status. |
KeyVaultKeyReference | Describes a reference to Key Vault Key |
KeyVaultSecretReference | Describes a reference to Key Vault Secret |
LastPatchInstallationSummary | Describes the properties of the last installed patch summary. |
MaintenanceOperationResultCodeTypes | The Last Maintenance Operation Result Code. |
MaintenanceRedeployStatus | Maintenance Operation Status. |
PatchOperationStatus | The overall success or failure status of the operation. It remains 'InProgress' until the operation completes. At that point it will become 'Unknown', 'Failed', 'Succeeded', or 'CompletedWithWarnings.' |
StatusLevelTypes | The level code. |
SubResource | |
VirtualMachineAgentInstanceView | The instance view of the VM Agent running on the virtual machine. |
VirtualMachineExtensionHandlerInstanceView | The instance view of a virtual machine extension handler. |
VirtualMachineExtensionInstanceView | The instance view of a virtual machine extension. |
VirtualMachineHealthStatus | The health status of the VM. |
VirtualMachineInstanceView | The instance view of a virtual machine. |
VirtualMachinePatchStatus | The status of virtual machine patch operations. |
ApiError
Api error.
Name | Type | Description |
---|---|---|
code |
| The error code. |
details |
| The Api error details |
innererror | The Api inner error | |
message |
| The error message. |
target |
| The target of the particular error. |
ApiErrorBase
Api error base.
Name | Type | Description |
---|---|---|
code |
| The error code. |
message |
| The error message. |
target |
| The target of the particular error. |
AvailablePatchSummary
Describes the properties of an virtual machine instance view for available patch summary.
Name | Type | Description |
---|---|---|
assessmentActivityId |
| The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
criticalAndSecurityPatchCount |
| The number of critical or security patches that have been detected as available and not yet installed. |
error | The errors that were encountered during execution of the operation. The details array contains the list of them. | |
lastModifiedTime |
| The UTC timestamp when the operation began. |
otherPatchCount |
| The number of all available patches excluding critical and security. |
rebootPending |
| The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. |
startTime |
| The UTC timestamp when the operation began. |
status | The overall success or failure status of the operation. It remains 'InProgress' until the operation completes. At that point it will become 'Unknown', 'Failed', 'Succeeded', or 'CompletedWithWarnings.' |
BootDiagnosticsInstanceView
The instance view of a virtual machine boot diagnostics.
Name | Type | Description |
---|---|---|
consoleScreenshotBlobUri |
| The console screenshot blob URI. |
serialConsoleLogBlobUri |
| The serial console log blob Uri. |
status | The boot diagnostics status information for the VM. |
DiskEncryptionSettings
Describes a Encryption Settings for a Disk
Name | Type | Description |
---|---|---|
diskEncryptionKey | Specifies the location of the disk encryption key, which is a Key Vault Secret. | |
enabled |
| Specifies whether disk encryption should be enabled on the virtual machine. |
keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. |
DiskInstanceView
The instance view of the disk.
Name | Type | Description |
---|---|---|
encryptionSettings |
| Specifies the encryption settings for the OS Disk. |
name |
| The disk name. |
statuses |
| The resource status information. |
HyperVGenerationType
Specifies the HyperVGeneration Type
Name | Type | Description |
---|---|---|
V1 |
| |
V2 |
|
InnerError
Inner error details.
Name | Type | Description |
---|---|---|
errordetail |
| The internal error message or exception dump. |
exceptiontype |
| The exception type. |
InstanceViewStatus
Instance view status.
Name | Type | Description |
---|---|---|
code |
| The status code. |
displayStatus |
| The short localizable label for the status. |
level | The level code. | |
message |
| The detailed status message, including for alerts and error messages. |
time |
| The time of the status. |
KeyVaultKeyReference
Describes a reference to Key Vault Key
Name | Type | Description |
---|---|---|
keyUrl |
| The URL referencing a key encryption key in Key Vault. |
sourceVault | The relative URL of the Key Vault containing the key. |
KeyVaultSecretReference
Describes a reference to Key Vault Secret
Name | Type | Description |
---|---|---|
secretUrl |
| The URL referencing a secret in a Key Vault. Disk diagnostics for mac. |
sourceVault | The relative URL of the Key Vault containing the secret. |
LastPatchInstallationSummary
Describes the properties of the last installed patch summary.
Name | Type | Description |
---|---|---|
error | The errors that were encountered during execution of the operation. The details array contains the list of them. | |
excludedPatchCount |
| The number of all available patches but excluded explicitly by a customer-specified exclusion list match. |
failedPatchCount |
| The count of patches that failed installation. |
installationActivityId |
| The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
installedPatchCount |
| The count of patches that successfully installed. |
lastModifiedTime |
| The UTC timestamp when the operation began. |
maintenanceWindowExceeded |
| Describes whether the operation ran out of time before it completed all its intended actions |
notSelectedPatchCount |
| The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. |
pendingPatchCount |
| The number of all available patches expected to be installed over the course of the patch installation operation. |
startTime |
| The UTC timestamp when the operation began. |
status | The overall success or failure status of the operation. It remains 'InProgress' until the operation completes. At that point it will become 'Unknown', 'Failed', 'Succeeded', or 'CompletedWithWarnings.' |
MaintenanceOperationResultCodeTypes
The Last Maintenance Operation Result Code.
Name | Type | Description |
---|---|---|
MaintenanceAborted |
| |
MaintenanceCompleted |
| |
None |
| |
RetryLater |
|
MaintenanceRedeployStatus
Maintenance Operation Status.
Name | Type | Description |
---|---|---|
isCustomerInitiatedMaintenanceAllowed |
| True, if customer is allowed to perform Maintenance. |
lastOperationMessage |
| Message returned for the last Maintenance Operation. |
lastOperationResultCode | The Last Maintenance Operation Result Code. | |
maintenanceWindowEndTime |
| End Time for the Maintenance Window. |
maintenanceWindowStartTime |
| Start Time for the Maintenance Window. |
preMaintenanceWindowEndTime |
| End Time for the Pre Maintenance Window. |
preMaintenanceWindowStartTime |
| Start Time for the Pre Maintenance Window. |
PatchOperationStatus
The overall success or failure status of the operation. It remains 'InProgress' until the operation completes. At that point it will become 'Unknown', 'Failed', 'Succeeded', or 'CompletedWithWarnings.'
Name | Type | Description |
---|---|---|
CompletedWithWarnings |
| |
Failed |
| |
InProgress |
| |
Succeeded |
| |
Unknown |
|
StatusLevelTypes
The level code.
Name | Type | Description |
---|---|---|
Error |
| |
Info |
| |
Warning |
|
SubResource
Download Remote Desktop Connection Manager Windows 10
Name | Type | Description |
---|---|---|
id |
| Resource Id |
VirtualMachineAgentInstanceView
The instance view of the VM Agent running on the virtual machine.
Name | Type | Description |
---|---|---|
extensionHandlers |
| The virtual machine extension handler instance view. |
statuses |
| The resource status information. |
vmAgentVersion |
| The VM Agent full version. |
Remote Desktop Manager 2.7 Microsoft Login
VirtualMachineExtensionHandlerInstanceView
Windows 10 Remote Desktop Connection Manager
The instance view of a virtual machine extension handler.
Name | Type | Description |
---|---|---|
status | The extension handler status. | |
type |
| Specifies the type of the extension; an example is 'CustomScriptExtension'. Ntfs for mac snow. |
typeHandlerVersion |
| Specifies the version of the script handler. |
VirtualMachineExtensionInstanceView
The instance view of a virtual machine extension.
Name | Type | Description |
---|---|---|
name |
| The virtual machine extension name. |
statuses |
| The resource status information. |
substatuses |
| The resource status information. |
type |
| Specifies the type of the extension; an example is 'CustomScriptExtension'. |
typeHandlerVersion |
| Specifies the version of the script handler. |
VirtualMachineHealthStatus
The health status of the VM.
Name | Type | Description |
---|---|---|
status | The health status information for the VM. |
VirtualMachineInstanceView
The instance view of a virtual machine.
Name | Type | Description |
---|---|---|
assignedHost |
| Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. |
bootDiagnostics | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. | |
computerName |
| The computer name assigned to the virtual machine. |
disks |
| The virtual machine disk information. |
extensions |
| The extensions information. |
hyperVGeneration | Specifies the HyperVGeneration Type associated with a resource | |
maintenanceRedeployStatus | The Maintenance Operation status on the virtual machine. | |
osName |
| The Operating System running on the virtual machine. |
osVersion |
| The version of Operating System running on the virtual machine. |
patchStatus | [Preview Feature] The status of virtual machine patch operations. | |
platformFaultDomain |
| Specifies the fault domain of the virtual machine. |
platformUpdateDomain |
| Specifies the update domain of the virtual machine. |
rdpThumbPrint |
| The Remote desktop certificate thumbprint. |
statuses |
| The resource status information. |
vmAgent | The VM Agent running on the virtual machine. | |
vmHealth | The health status for the VM. |
VirtualMachinePatchStatus
The status of virtual machine patch operations.
Name | Type | Description |
---|---|---|
availablePatchSummary | The available patch summary of the latest assessment operation for the virtual machine. | |
configurationStatuses |
| The enablement status of the specified patchMode |
lastPatchInstallationSummary | The installation summary of the latest installation operation for the virtual machine. |