AciWebservice class

Definition

Class for Azure Container Instances Webservices.

AciWebservice(workspace, name)
Inheritance
AciWebservice

Methods

add_properties(properties)

Add key value pairs to this Webservice's properties dictionary.

add_tags(tags)

Add key value pairs to this Webservice's tags dictionary.

deploy_configuration(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)

Create a configuration object for deploying an ACI Webservice.

remove_tags(tags)

Remove the specified keys from this Webservice's dictionary of tags.

run(input_data)

Call this Webservice with the provided input.

serialize()

Convert this Webservice into a json serialized dictionary.

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Update the Webservice with provided properties.

Values left as None will remain unchanged in this Webservice.

add_properties(properties)

Add key value pairs to this Webservice's properties dictionary.

add_properties(properties)

Parameters

properties
dict[str or str]

The dictionary of properties to add

add_tags(tags)

Add key value pairs to this Webservice's tags dictionary.

add_tags(tags)

Parameters

tags
dict[str or str]

The dictionary of tags to add

deploy_configuration(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)

Create a configuration object for deploying an ACI Webservice.

deploy_configuration(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)

Parameters

cpu_cores
float

The number of cpu cores to allocate for this Webservice. Can be a decimal

default value: None
memory_gb
float

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

default value: None
tags
dict[str or str]

Dictionary of key value tags to give this Webservice

default value: None
properties
dict[str or str]

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. More details on available regions can be found here: https://azure.microsoft.com/en-us/global-infrastructure/services/?regions=all&products=container-instances

default value: None
auth_enabled
bool

Whether or not to enable auth for this Webservice

default value: None
ssl_enabled
bool

Whether or not to enable SSL for this Webservice

default value: None
enable_app_insights
bool

Whether or not to enable AppInsights for this Webservice

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

Returns

A configuration object to use when deploying a Webservice object

Return type

AciServiceDeploymentConfiguration

remove_tags(tags)

Remove the specified keys from this Webservice's dictionary of tags.

remove_tags(tags)

Parameters

tags
<xref:azureml.core.webservice.list[str]>

The list of keys to remove

run(input_data)

Call this Webservice with the provided input.

run(input_data)

Parameters

input_data
varies

The input to call the Webservice with

Returns

The result of calling the Webservice

Return type

serialize()

Convert this Webservice into a json serialized dictionary.

serialize()

Returns

The json representation of this Webservice

Return type

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Update the Webservice with provided properties.

Values left as None will remain unchanged in this Webservice.

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Parameters

image
Image

A new Image to deploy to the Webservice

default value: None
tags
dict[str or str]

Dictionary of key value tags to give this Webservice. Will replace existing tags.

default value: None
properties
dict[str or str]

Dictionary of key value properties to add to existing properties dictionary

default value: None
description
str

A description to give this Webservice

default value: None
auth_enabled
bool

Enable or disable auth for this Webservice

default value: None
ssl_enabled
bool

Whether or not to enable SSL for this Webservice

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
enable_app_insights
bool

Whether or not to enable AppInsights for this Webservice

default value: None
models
<xref:list[Model]>

A list of Model objects to package into the updated service

default value: None
inference_config
InferenceConfig

An InferenceConfig object used to provide the required model deployment properties.

default value: None

Return type