зеркало из https://github.com/Azure/AzureVM.git
43 строки
3.0 KiB
R
43 строки
3.0 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/az_vm_resource.R
|
|
\docType{class}
|
|
\name{az_vm_resource}
|
|
\alias{az_vm_resource}
|
|
\title{Virtual machine resource class}
|
|
\format{
|
|
An R6 object of class \code{az_vm_resource}, inheriting from \code{AzureRMR::az_resource}.
|
|
}
|
|
\description{
|
|
Class representing a virtual machine resource. In general, the methods in this class should not be called directly, nor should objects be directly instantiated from it. Use the \code{az_vm_template} class for interacting with VMs instead.
|
|
}
|
|
\section{Methods}{
|
|
|
|
The following methods are available, in addition to those provided by the \link[AzureRMR:az_resource]{AzureRMR::az_resource} class:
|
|
\itemize{
|
|
\item \code{start(wait=TRUE)}: Start the VM. By default, wait until the startup process is complete.
|
|
\item \code{stop(deallocate=TRUE, wait=FALSE)}: Stop the VM. By default, deallocate it as well.
|
|
\item \code{restart(wait=TRUE)}: Restart the VM.
|
|
\item \code{run_deployed_command(command, parameters, script)}: Run a PowerShell command on the VM.
|
|
\item \code{run_script(script, parameters)}: Run a script on the VM. For a Linux VM, this will be a shell script; for a Windows VM, a PowerShell script. Pass the script as a character vector.
|
|
\item \code{sync_vm_status()}: Check the status of the VM.
|
|
\item \code{resize(size, deallocate=FALSE, wait=FALSE)}: Resize the VM. Optionally stop and deallocate it first (may sometimes be necessary).
|
|
\item \code{redeploy()}: Redeploy the VM.
|
|
\item \code{reimage()}: Reimage the VM.
|
|
\item \code{get_public_ip_address(nic=1, config=1)}: Get the public IP address of the VM. Returns NA if the VM is shut down, or is not publicly accessible.
|
|
\item \code{get_private_ip_address(nic=1, config=1)}: Get the private IP address of the VM.
|
|
\item \code{get_public_ip_resource(nic=1, config=1)}: Get the Azure resource for the VM's public IP address.
|
|
\item \code{get_nic(nic=1)}: Get the VM's network interface resource.
|
|
\item \code{get_vnet(nic=1, config=1)}: Get the VM's virtual network resource.
|
|
\item \code{get_nsg(nic=1, config=1)}: Get the VM's network security group resource. Note that an NSG can be attached to either the VM's network interface or to its virtual network subnet; if there is an NSG attached to both, this method returns a list containing the two NSG resource objects.
|
|
\item \code{get_disk(disk="os")}: Get a managed disk resource attached to the VM. The \code{disk} argument can be "os" for the OS disk, or a number indicating the LUN of a data disk. AzureVM only supports managed disks.
|
|
\item \code{add_extension(publisher, type, version, settings=list(), protected_settings=list(), key_vault_settings=list())}: Add an extension to the VM.
|
|
\item \code{do_vm_operation(...)}: Carry out an arbitrary operation on the VM resource. See the \code{do_operation} method of the \link[AzureRMR:az_resource]{AzureRMR::az_resource} class for more details.
|
|
}
|
|
}
|
|
|
|
\seealso{
|
|
\link[AzureRMR:az_resource]{AzureRMR::az_resource}, \link{get_vm_resource}, \link{az_vm_template}
|
|
|
|
\href{https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines}{VM API reference}
|
|
}
|