VirtualMachineOperationsExtensions.CaptureOSImage Method (IVirtualMachineOperations, String, String, String, VirtualMachineCaptureOSImageParameters)

  • Article

 

The Capture Role operation creates a copy of the operating system virtual hard disk (VHD) that is deployed in the virtual machine, saves the VHD copy in the same storage location as the operating system VHD, and registers the copy as an image in your image gallery. From the captured image, you can create additional customized virtual machines. For more information about images and disks, see Manage Disks and Images at https://msdn.microsoft.com/library/windowsazure/jj672979.aspx. For more information about capturing images, see How to Capture an Image of a Virtual Machine Running Windows Server 2008 R2 at https://www.windowsazure.com/documentation/articles/virtual-machines-capture-image-windows-server/ or How to Capture an Image of a Virtual Machine Running Linux at https://www.windowsazure.com/documentation/articles/virtual-machines-linux-capture-image/. (see https://msdn.microsoft.com/library/windowsazure/jj157201.aspx for more information)

Namespace:   Microsoft.WindowsAzure.Management.Compute
Assembly:  Microsoft.WindowsAzure.Management.Compute (in Microsoft.WindowsAzure.Management.Compute.dll)

Syntax

public static OperationStatusResponse CaptureOSImage(
    this IVirtualMachineOperations operations,
    string serviceName,
    string deploymentName,
    string virtualMachineName,
    VirtualMachineCaptureOSImageParameters parameters
)

public:
[ExtensionAttribute]
static OperationStatusResponse^ CaptureOSImage(
    IVirtualMachineOperations^ operations,
    String^ serviceName,
    String^ deploymentName,
    String^ virtualMachineName,
    VirtualMachineCaptureOSImageParameters^ parameters
)

static member CaptureOSImage : 
        operations:IVirtualMachineOperations *
        serviceName:string *
        deploymentName:string *
        virtualMachineName:string *
        parameters:VirtualMachineCaptureOSImageParameters -> OperationStatusResponse

<ExtensionAttribute>
Public Shared Function CaptureOSImage (
    operations As IVirtualMachineOperations,
    serviceName As String,
    deploymentName As String,
    virtualMachineName As String,
    parameters As VirtualMachineCaptureOSImageParameters
) As OperationStatusResponse

Parameters

  • serviceName
    Type: System.String

    Required. The name of your service.

  • deploymentName
    Type: System.String

    Required. The name of your deployment.

  • virtualMachineName
    Type: System.String

    Required. The name of the virtual machine to restart.

Return Value

Type: Microsoft.Azure.OperationStatusResponse

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

See Also

VirtualMachineOperationsExtensions Class
Microsoft.WindowsAzure.Management.Compute Namespace

Return to top