AI Platform Notebooks v1 API - Class VirtualMachineConfig (2.2.0)

public sealed class VirtualMachineConfig : IMessage<VirtualMachineConfig>, IEquatable<VirtualMachineConfig>, IDeepCloneable<VirtualMachineConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the AI Platform Notebooks v1 API class VirtualMachineConfig.

The config settings for virtual machine.

Inheritance

Object > VirtualMachineConfig

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

VirtualMachineConfig()

public VirtualMachineConfig()

VirtualMachineConfig(VirtualMachineConfig)

public VirtualMachineConfig(VirtualMachineConfig other)
Parameter
NameDescription
otherVirtualMachineConfig

Properties

AcceleratorConfig

public RuntimeAcceleratorConfig AcceleratorConfig { get; set; }

Optional. The Compute Engine accelerator configuration for this runtime.

Property Value
TypeDescription
RuntimeAcceleratorConfig

BootImage

public VirtualMachineConfig.Types.BootImage BootImage { get; set; }

Optional. Boot image metadata used for runtime upgradeability.

Property Value
TypeDescription
VirtualMachineConfig.Types.BootImage

ContainerImages

public RepeatedField<ContainerImage> ContainerImages { get; }

Optional. Use a list of container images to use as Kernels in the notebook instance.

Property Value
TypeDescription
RepeatedField<ContainerImage>

DataDisk

public LocalDisk DataDisk { get; set; }

Required. Data disk option configuration settings.

Property Value
TypeDescription
LocalDisk

EncryptionConfig

public EncryptionConfig EncryptionConfig { get; set; }

Optional. Encryption settings for virtual machine data disk.

Property Value
TypeDescription
EncryptionConfig

GuestAttributes

public MapField<string, string> GuestAttributes { get; }

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

Property Value
TypeDescription
MapField<String, String>

InternalIpOnly

public bool InternalIpOnly { get; set; }

Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

Property Value
TypeDescription
Boolean

Labels

public MapField<string, string> Labels { get; }

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Property Value
TypeDescription
MapField<String, String>

MachineType

public string MachineType { get; set; }

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

  • n1-standard-2
  • e2-standard-8
Property Value
TypeDescription
String

Metadata

public MapField<string, string> Metadata { get; }

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

Property Value
TypeDescription
MapField<String, String>

Network

public string Network { get; set; }

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists.

A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
  • projects/[project_id]/global/networks/default

Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:

  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
Property Value
TypeDescription
String

NicType

public VirtualMachineConfig.Types.NicType NicType { get; set; }

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Property Value
TypeDescription
VirtualMachineConfig.Types.NicType

ReservedIpRange

public string ReservedIpRange { get; set; }

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.

Example: managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING

Field value will be: managed-notebooks-range-c

Property Value
TypeDescription
String

ShieldedInstanceConfig

public RuntimeShieldedInstanceConfig ShieldedInstanceConfig { get; set; }

Optional. Shielded VM Instance configuration settings.

Property Value
TypeDescription
RuntimeShieldedInstanceConfig

Subnet

public string Subnet { get; set; }

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network.

A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
Property Value
TypeDescription
String

Tags

public RepeatedField<string> Tags { get; }

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Property Value
TypeDescription
RepeatedField<String>

Zone

public string Zone { get; set; }

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

  • us-central1-b
Property Value
TypeDescription
String