AksAttachConfiguration Class

Represents configuration parameters for attaching AksCompute targets.

Use the attach_configuration method of the AksCompute class to specify attach parameters.

Initialize the configuration object.

Inheritance

ComputeTargetAttachConfiguration

AksAttachConfiguration

Constructor

AksAttachConfiguration(resource_group=None, cluster_name=None, resource_id=None, cluster_purpose=None, load_balancer_type=None, load_balancer_subnet=None)

Parameters

resource_group

str

default value: None

The name of the resource group in which the AKS cluster is located.

cluster_name

str

default value: None

The AKS cluster name.

resource_id

str

default value: None

The Azure resource ID for the compute resource being attached.

cluster_purpose

str

default value: None

The targeted usage of the cluster. This is used to provision Azure Machine Learning components to ensure the desired level of fault-tolerance and QoS. The ClusterPurpose class defines the possible values. For more information, see Attach an existing AKS cluster.

resource_group

str

Required

The name of the resource group in which the AKS cluster is located.

cluster_name

str

Required

The AKS cluster name.

resource_id

str

Required

The Azure resource ID for the compute resource being attached.

cluster_purpose

str

Required

The targeted usage of the cluster. This is used to provision Azure Machine Learning components to ensure the desired level of fault-tolerance and QoS. The ClusterPurpose class defines the possible values. For more information, see Attach an existing AKS cluster.

load_balancer_type

str

default value: None

The AKS cluster type. Valid values are PublicIp and InternalLoadBalancer. Default value is PublicIp.

load_balancer_subnet

str

default value: None

The AKS load balancer subnet. It can be used only when InternalLoadBalancer is used as load balancer type. Default value is aks-subnet.

Methods

enable_ssl	Enable SSL validation on the AKS cluster.
validate_configuration	Check that the specified configuration values are valid. Raises a ComputeTargetException if validation fails.

enable_ssl

Enable SSL validation on the AKS cluster.

enable_ssl(ssl_cname=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, leaf_domain_label=None, overwrite_existing_domain=False)

Parameters

ssl_cname

str

default value: None

A CNAME to use if enabling SSL validation on the cluster. To enable SSL validation, you must provide the three related parameters: CNAME, cert PEM file, and key PEM file.

ssl_cert_pem_file

str

default value: None

A file path to a file containing cert information for SSL validation. To enable SSL validation, you must provide the three related parameters: CNAME, cert PEM file, and key PEM file.

ssl_key_pem_file

str

default value: None

A file path to a file containing key information for SSL validation. To enable SSL validation, you must provide the three related parameters: CNAME, cert PEM file, and key PEM file.

leaf_domain_label

str

default value: None

The leaf domain label to use if enabling SSL validation on the cluster. When leaf domain label is provided, do not specify CNAME, cert PEM file, or key PEM file.

overwrite_existing_domain

bool

default value: False

Whether to overwrite the existing leaf domain label. Overwrite of an existing domain only applies to leaf domain label. When this parameter is provided, CNAME, cert PEM file, and key PEM file should not be provided.

validate_configuration

Check that the specified configuration values are valid.

Raises a ComputeTargetException if validation fails.

validate_configuration()

Exceptions

ComputeTargetException