AksProvisioningConfiguration Class
Represents configuration parameters for provisioning AksCompute targets.
Use the provisioning_configuration method of the
AksCompute class to
specify provisioning parameters.
Initialize a configuration object for provisioning an AKS compute target.
Must provide all three CName, cert file, and key file to enable SSL validation.
- Inheritance
-
AksProvisioningConfiguration
Constructor
AksProvisioningConfiguration(agent_count, vm_size, ssl_cname, ssl_cert_pem_file, ssl_key_pem_file, location, vnet_resourcegroup_name, vnet_name, subnet_name, service_cidr, dns_service_ip, docker_bridge_cidr, cluster_purpose, load_balancer_type, load_balancer_subnet)Parameters
- vm_size
- str
The size of agent VMs. A full list of options can be found here: https://aka.ms/azureml-aks-details. Defaults to Standard_D3_v2.
- ssl_cname
- str
A CNAME to use if enabling SSL validation on the cluster. Must provide all three CName, cert file, and key file to enable SSL validation
- ssl_cert_pem_file
- str
A file path to a file containing cert information for SSL validation. Must provide all three CName, cert file, and key file to enable SSL validation
- ssl_key_pem_file
- str
A file path to a file containing key information for SSL validation. Must provide all three CName, cert file, and key file to enable SSL validation
- location
- str
The location to provision cluster in. If not specified, will default to workspace location. Available regions for this compute can be found here: https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=kubernetes-service
- vnet_resourcegroup_name
- str
The name of the resource group where the virtual network is located
- cluster_purpose
- str
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 is provided for convenience to specify possible values. For more information, see Attach an existing AKS cluster.
- load_balancer_type
- str
Load balancer type of AKS cluster. Valid values are PublicIp and InternalLoadBalancer. Default value is PublicIp.
- load_balancer_subnet
- str
Load balancer subnet of AKS cluster. It can be used only when Internal Load Balancer is used as load balancer type. Default value is aks-subnet.
- vm_size
- str
The size of agent VMs. A full list of options can be found here: https://aka.ms/azureml-aks-details. Defaults to Standard_D3_v2.
- ssl_cname
- str
A CNAME to use if enabling SSL validation on the cluster. Must provide all three CName, cert file, and key file to enable SSL validation
- ssl_cert_pem_file
- str
A file path to a file containing cert information for SSL validation. Must provide all three CName, cert file, and key file to enable SSL validation
- ssl_key_pem_file
- str
A file path to a file containing key information for SSL validation. Must provide all three CName, cert file, and key file to enable SSL validation
- location
- str
The location to provision cluster in. If not specified, will default to workspace location. Available regions for this compute can be found here: https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=kubernetes-service
- vnet_resourcegroup_name
- str
The name of the resource group where the virtual network is located
- cluster_purpose
- str
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 is provided for convenience to specify possible values. For more information, see Attach an existing AKS cluster.
- load_balancer_type
- str
Load balancer type of AKS cluster. Valid values are PublicIp and InternalLoadBalancer. Default value is PublicIp.
- load_balancer_subnet
- str
Load balancer subnet of AKS cluster. It can be used only when Internal Load Balancer is used as load balancer type. Default value is aks-subnet.
Methods
| enable_ssl |
Enable SSL validation on the cluster. |
| validate_configuration |
Check that the specified configuration values are valid. Raises a ComputeTargetException if validation fails. |
enable_ssl
Enable SSL validation on the 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
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
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
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
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
Whether or not 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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for