@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get virtual machine.
*
* Uses Azure REST API version 2018-09-15.
*/
export declare function getVirtualMachine(args: GetVirtualMachineArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualMachineResult>;
export interface GetVirtualMachineArgs {
/**
* Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'
*/
expand?: string;
/**
* The name of the lab.
*/
labName: string;
/**
* The name of the LabVirtualMachine
*/
name: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A virtual machine.
*/
export interface GetVirtualMachineResult {
/**
* Indicates whether another user can take ownership of the virtual machine
*/
readonly allowClaim?: boolean;
/**
* The applicable schedule for the virtual machine.
*/
readonly applicableSchedule: outputs.devtestlab.ApplicableScheduleResponse;
/**
* The artifact deployment status for the virtual machine.
*/
readonly artifactDeploymentStatus: outputs.devtestlab.ArtifactDeploymentStatusPropertiesResponse;
/**
* The artifacts to be installed on the virtual machine.
*/
readonly artifacts?: outputs.devtestlab.ArtifactInstallPropertiesResponse[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The resource identifier (Microsoft.Compute) of the virtual machine.
*/
readonly computeId: string;
/**
* The compute virtual machine properties.
*/
readonly computeVm: outputs.devtestlab.ComputeVmPropertiesResponse;
/**
* The email address of creator of the virtual machine.
*/
readonly createdByUser: string;
/**
* The object identifier of the creator of the virtual machine.
*/
readonly createdByUserId: string;
/**
* The creation date of the virtual machine.
*/
readonly createdDate?: string;
/**
* The custom image identifier of the virtual machine.
*/
readonly customImageId?: string;
/**
* New or existing data disks to attach to the virtual machine after creation
*/
readonly dataDiskParameters?: outputs.devtestlab.DataDiskPropertiesResponse[];
/**
* Indicates whether the virtual machine is to be created without a public IP address.
*/
readonly disallowPublicIpAddress?: boolean;
/**
* The resource ID of the environment that contains this virtual machine, if any.
*/
readonly environmentId?: string;
/**
* The expiration date for VM.
*/
readonly expirationDate?: string;
/**
* The fully-qualified domain name of the virtual machine.
*/
readonly fqdn: string;
/**
* The Microsoft Azure Marketplace image reference of the virtual machine.
*/
readonly galleryImageReference?: outputs.devtestlab.GalleryImageReferenceResponse;
/**
* The identifier of the resource.
*/
readonly id: string;
/**
* Indicates whether this virtual machine uses an SSH key for authentication.
*/
readonly isAuthenticationWithSshKey?: boolean;
/**
* The lab subnet name of the virtual machine.
*/
readonly labSubnetName?: string;
/**
* The lab virtual network identifier of the virtual machine.
*/
readonly labVirtualNetworkId?: string;
/**
* Last known compute power state captured in DTL
*/
readonly lastKnownPowerState: string;
/**
* The location of the resource.
*/
readonly location?: string;
/**
* The name of the resource.
*/
readonly name: string;
/**
* The network interface properties.
*/
readonly networkInterface?: outputs.devtestlab.NetworkInterfacePropertiesResponse;
/**
* The notes of the virtual machine.
*/
readonly notes?: string;
/**
* The OS type of the virtual machine.
*/
readonly osType: string;
/**
* The object identifier of the owner of the virtual machine.
*/
readonly ownerObjectId?: string;
/**
* The user principal name of the virtual machine owner.
*/
readonly ownerUserPrincipalName?: string;
/**
* The password of the virtual machine administrator.
*/
readonly password?: string;
/**
* The id of the plan associated with the virtual machine image
*/
readonly planId?: string;
/**
* The provisioning status of the resource.
*/
readonly provisioningState: string;
/**
* Virtual Machine schedules to be created
*/
readonly scheduleParameters?: outputs.devtestlab.ScheduleCreationParameterResponse[];
/**
* The size of the virtual machine.
*/
readonly size?: string;
/**
* The SSH key of the virtual machine administrator.
*/
readonly sshKey?: string;
/**
* Storage type to use for virtual machine (i.e. Standard, Premium).
*/
readonly storageType?: string;
/**
* The tags of the resource.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource.
*/
readonly type: string;
/**
* The unique immutable identifier of a resource (Guid).
*/
readonly uniqueIdentifier: string;
/**
* The user name of the virtual machine.
*/
readonly userName?: string;
/**
* Tells source of creation of lab virtual machine. Output property only.
*/
readonly virtualMachineCreationSource: string;
}
/**
* Get virtual machine.
*
* Uses Azure REST API version 2018-09-15.
*/
export declare function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVirtualMachineResult>;
export interface GetVirtualMachineOutputArgs {
/**
* Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'
*/
expand?: pulumi.Input<string>;
/**
* The name of the lab.
*/
labName: pulumi.Input<string>;
/**
* The name of the LabVirtualMachine
*/
name: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}