AciServiceDeploymentConfiguration Class

Represents deployment configuration information for a service deployed on Azure Container Instances.

Create an AciServiceDeploymentConfiguration object using the deploy_configuration method of the AciWebservice class.

Create a configuration object for deploying an ACI Webservice.

Inheritance

WebserviceDeploymentConfiguration

AciServiceDeploymentConfiguration

Constructor

AciServiceDeploymentConfiguration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

Parameters

Name	Description
cpu_cores	float The number of CPU cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1 Default value: None
memory_gb	float The amount of memory (in GB) to allocate for this Webservice. Can be a decimal. Defaults to 0.5 Default value: None
tags	dict[str, str] A dictionary of key value tags to give this Webservice. Default value: None
properties	dict[str, str] A dictionary of key value properties to give this Webservice. These properties cannot be changed after deployment, however new key value pairs can be added. Default value: None
description	str A description to give this Webservice. Default value: None
location	str The Azure region to deploy this Webservice to. If not specified, the Workspace location will be used. For more details on available regions, see Products by region. Default value: None
auth_enabled	bool Whether or not to enable auth for this Webservice. Defaults to False. Default value: None
ssl_enabled	bool Whether or not to enable SSL for this Webservice. Defaults to False. Default value: None
enable_app_insights	bool Whether or not to enable AppInsights for this Webservice. Defaults to False. Default value: None
ssl_cert_pem_file	str The cert file needed if SSL is enabled. Default value: None
ssl_key_pem_file	str The key file needed if SSL is enabled. Default value: None
ssl_cname	str The cname for if SSL is enabled. Default value: None
dns_name_label	str The DNS name label for the scoring endpoint. If not specified a unique DNS name label will be generated for the scoring endpoint. Default value: None
primary_key	str A primary auth key to use for this Webservice. Default value: None
secondary_key	str A secondary auth key to use for this Webservice. Default value: None
collect_model_data	bool Whether or not to enable model data collection for this Webservice. Defaults to False Default value: None
cmk_vault_base_url	str customer managed key vault base url Default value: None
cmk_key_name	str customer managed key name. Default value: None
cmk_key_version	str customer managed key version. Default value: None
vnet_name	str virtual network name. Default value: None
subnet_name	str subnet name within virtual network. Default value: None
cpu_cores Required	float The number of CPU cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1
memory_gb Required	float The amount of memory (in GB) to allocate for this Webservice. Can be a decimal. Defaults to 0.5
tags Required	dict[str, str] A dictionary of key value tags to give this Webservice.
properties Required	dict[str, str] A dictionary of key value properties to give this Webservice. These properties cannot be changed after deployment, however new key value pairs can be added.
description Required	str A description to give this Webservice.
location Required	str The Azure region to deploy this Webservice to. If not specified, the Workspace location will be used. For more details on available regions, see Products by region.
auth_enabled Required	bool Whether or not to enable auth for this Webservice. Defaults to False.
ssl_enabled Required	bool Whether or not to enable SSL for this Webservice. Defaults to False.
enable_app_insights Required	bool Whether or not to enable AppInsights for this Webservice. Defaults to False.
ssl_cert_pem_file Required	str The cert file needed if SSL is enabled.
ssl_key_pem_file Required	str The key file needed if SSL is enabled.
ssl_cname Required	str The cname for if SSL is enabled.
dns_name_label Required	str The DNS name label for the scoring endpoint. If not specified a unique DNS name label will be generated for the scoring endpoint.
primary_key Required	str A primary auth key to use for this Webservice.
secondary_key Required	str A secondary auth key to use for this Webservice.
collect_model_data Required	bool Whether or not to enable model data collection for this Webservice. Defaults to False
cmk_vault_base_url Required	str customer managed key vault base url
cmk_key_name Required	str customer managed key name.
cmk_key_version Required	str customer managed key version.
vnet_name Required	str virtual network name.
subnet_name Required	str subnet name within virtual network.

Variables

Name	Description
cpu_cores	float The number of CPU cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1
memory_gb	float The amount of memory (in GB) to allocate for this Webservice. Can be a decimal. Defaults to 0.5
azureml.core.webservice.AciServiceDeploymentConfiguration.tags	A dictionary of key value tags to give this Webservice.
azureml.core.webservice.AciServiceDeploymentConfiguration.properties	A dictionary of key value properties to give this Webservice. These properties cannot be changed after deployment, however new key value pairs can be added.
azureml.core.webservice.AciServiceDeploymentConfiguration.description	A description to give this Webservice.
azureml.core.webservice.AciServiceDeploymentConfiguration.location	The Azure region to deploy this Webservice to. If not specified, the Workspace location will be used. For more details on available regions, see Products by region.
auth_enabled	bool Whether or not to enable auth for this Webservice. Defaults to False.
ssl_enabled	bool Whether or not to enable SSL for this Webservice. Defaults to False.
enable_app_insights	bool Whether or not to enable AppInsights for this Webservice. Defaults to False.
ssl_cert_pem_file	str The cert file needed if SSL is enabled.
ssl_key_pem_file	str The key file needed if SSL is enabled.
ssl_cname	str The cname for if SSL is enabled.
dns_name_label	str The DNS name label for the scoring endpoint. If not specified a unique DNS name label will be generated for the scoring endpoint.
primary_key	str A primary auth key to use for this Webservice.
secondary_key	str A secondary auth key to use for this Webservice.
collect_model_data	bool Whether or not to enabled model data collection for the Webservice.

Methods

print_deploy_configuration	Print the deployment configuration.
validate_configuration	Check that the specified configuration values are valid. Will raise a WebserviceException if validation fails.

print_deploy_configuration

Print the deployment configuration.

print_deploy_configuration()

validate_configuration

Check that the specified configuration values are valid.

Will raise a WebserviceException if validation fails.

validate_configuration()

Exceptions

Type	Description
WebserviceException