@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get properties of the provided virtual machine console.
*
* Uses Azure REST API version 2025-02-01.
*
* Other available API versions: 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native networkcloud [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConsole(args: GetConsoleArgs, opts?: pulumi.InvokeOptions): Promise<GetConsoleResult>;
export interface GetConsoleArgs {
/**
* The name of the virtual machine console.
*/
consoleName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the virtual machine.
*/
virtualMachineName: string;
}
export interface GetConsoleResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The more detailed status of the console.
*/
readonly detailedStatus: string;
/**
* The descriptive message about the current detailed status.
*/
readonly detailedStatusMessage: string;
/**
* The indicator of whether the console access is enabled.
*/
readonly enabled: string;
/**
* Resource ETag.
*/
readonly etag: string;
/**
* The date and time after which the key will be disallowed access.
*/
readonly expiration?: string;
/**
* The extended location of the cluster manager associated with the cluster this virtual machine is created on.
*/
readonly extendedLocation: outputs.networkcloud.ExtendedLocationResponse;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* The resource ID of the private link service that is used to provide virtual machine console access.
*/
readonly privateLinkServiceId: string;
/**
* The provisioning state of the virtual machine console.
*/
readonly provisioningState: string;
/**
* The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
*/
readonly sshPublicKey: outputs.networkcloud.SshPublicKeyResponse;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.networkcloud.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The unique identifier for the virtual machine that is used to access the console.
*/
readonly virtualMachineAccessId: string;
}
/**
* Get properties of the provided virtual machine console.
*
* Uses Azure REST API version 2025-02-01.
*
* Other available API versions: 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native networkcloud [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConsoleOutput(args: GetConsoleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConsoleResult>;
export interface GetConsoleOutputArgs {
/**
* The name of the virtual machine console.
*/
consoleName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the virtual machine.
*/
virtualMachineName: pulumi.Input<string>;
}