VirtualMachineCompute Class
Virtual Machine Compute resource.
Constructor
VirtualMachineCompute(*, name: str, description: str | None = None, resource_id: str, tags: dict | None = None, ssh_settings: VirtualMachineSshSettings | None = None, **kwargs: Any)Parameters
| Name | Description |
|---|---|
|
name
Required
|
Name of the compute resource. |
|
description
Required
|
Description of the resource. Defaults to None. |
|
resource_id
Required
|
ARM resource ID of the underlying compute resource. |
|
tags
Required
|
A set of tags. Contains resource tags defined as key/value pairs. |
|
ssh_settings
Required
|
SSH settings. Defaults to None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
name
Required
|
|
|
description
|
Default value: None
|
|
resource_id
Required
|
|
|
tags
|
Default value: None
|
|
ssh_settings
|
Default value: None
|
Examples
Configuring a VirtualMachineCompute object.
from azure.ai.ml.entities import VirtualMachineCompute
vm_compute = VirtualMachineCompute(
name="vm-compute",
resource_id="/subscriptions/123456-1234-1234-1234-123456789/resourceGroups/my-rg/providers/Microsoft.Compute/virtualMachines/my-vm",
ssh_settings=ssh_settings, # type:ignore
)
Methods
| dump |
Dump the compute content into a file in yaml format. |
dump
Dump the compute content into a file in yaml format.
dump(dest: str | PathLike | IO, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
dest
Required
|
The destination to receive this compute's content. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.'. |
Attributes
base_path
created_on
creation_context
The creation context of the resource.
Returns
| Type | Description |
|---|---|
|
The creation metadata for the resource. |
