AciServiceDeploymentConfiguration Class

  • Reference

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

cpu_cores
float
default value: None

The number of CPU cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1

memory_gb
float
default value: None

The amount of memory (in GB) to allocate for this Webservice. Can be a decimal. Defaults to 0.5

tags
dict[str, str]
default value: None

A dictionary of key value tags to give this Webservice.

properties
dict[str, str]
default value: None

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
str
default value: None

A description to give this Webservice.

location
str
default value: None

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
default value: None

Whether or not to enable auth for this Webservice. Defaults to False.

ssl_enabled
bool
default value: None

Whether or not to enable SSL for this Webservice. Defaults to False.

enable_app_insights
bool
default value: None

Whether or not to enable AppInsights for this Webservice. Defaults to False.

ssl_cert_pem_file
str
default value: None

The cert file needed if SSL is enabled.

ssl_key_pem_file
str
default value: None

The key file needed if SSL is enabled.

ssl_cname
str
default value: None

The cname for if SSL is enabled.

dns_name_label
str
default value: None

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
default value: None

A primary auth key to use for this Webservice.

secondary_key
str
default value: None

A secondary auth key to use for this Webservice.

collect_model_data
bool
default value: None

Whether or not to enable model data collection for this Webservice. Defaults to False

cmk_vault_base_url
str
default value: None

customer managed key vault base url

cmk_key_name
str
default value: None

customer managed key name.

cmk_key_version
str
default value: None

customer managed key version.

vnet_name
str
default value: None

virtual network name.

subnet_name
str
default value: None

subnet name within virtual network.

cpu_cores
float
Required

The number of CPU cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1

memory_gb
float
Required

The amount of memory (in GB) to allocate for this Webservice. Can be a decimal. Defaults to 0.5

tags
dict[str, str]
Required

A dictionary of key value tags to give this Webservice.

properties
dict[str, str]
Required

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
str
Required

A description to give this Webservice.

location
str
Required

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
Required

Whether or not to enable auth for this Webservice. Defaults to False.

ssl_enabled
bool
Required

Whether or not to enable SSL for this Webservice. Defaults to False.

enable_app_insights
bool
Required

Whether or not to enable AppInsights for this Webservice. Defaults to False.

ssl_cert_pem_file
str
Required

The cert file needed if SSL is enabled.

ssl_key_pem_file
str
Required

The key file needed if SSL is enabled.

ssl_cname
str
Required

The cname for if SSL is enabled.

dns_name_label
str
Required

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
Required

A primary auth key to use for this Webservice.

secondary_key
str
Required

A secondary auth key to use for this Webservice.

collect_model_data
bool
Required

Whether or not to enable model data collection for this Webservice. Defaults to False

cmk_vault_base_url
str
Required

customer managed key vault base url

cmk_key_name
str
Required

customer managed key name.

cmk_key_version
str
Required

customer managed key version.

vnet_name
str
Required

virtual network name.

subnet_name
str
Required

subnet name within virtual network.

Variables

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

WebserviceException