WebserviceDeploymentConfiguration Class

Defines the base-class functionality for all Webservice deployment configuration objects.

This class represents the configuration parameters for deploying a Webservice on a specific target. For example, to create deployment for Azure Kubernetes Service, use the deploy_configuration method of the AksWebservice class.

Initialize the configuration object.

Inheritance

ABC

WebserviceDeploymentConfiguration

Constructor

WebserviceDeploymentConfiguration(type, description=None, tags=None, properties=None, primary_key=None, secondary_key=None, location=None)

Parameters

type

Webservice

Required

The type of Webservice associated with this object.

description

str

default value: None

A description to give this Webservice.

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.

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.

location

str

default value: None

The Azure region to deploy this Webservice to.

type

Webservice

Required

The type of Webservice associated with this object.

description

str

Required

A description to give this Webservice.

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.

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.

location

str

Required

The Azure region to deploy this Webservice to.

Variables

azureml.core.webservice.Webservice.description

A description to give this Webservice.

azureml.core.webservice.Webservice.tags

A dictionary of key value tags to give this Webservice.

azureml.core.webservice.Webservice.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.Webservice.primary_key

A primary auth key to use for this Webservice.

azureml.core.webservice.Webservice.secondary_key

A secondary auth key to use for this Webservice.

azureml.core.webservice.Webservice.location

The Azure region to deploy this Webservice to.

Methods

print_deploy_configuration	Print the deployment configuration.
validate_configuration	Check that the specified configuration values are valid. Raises a WebserviceException if validation fails.
validate_image	Check that the image that is being deployed to the Webservice is valid. Raises a WebserviceException if validation fails.

print_deploy_configuration

Print the deployment configuration.

abstract print_deploy_configuration()

validate_configuration

Check that the specified configuration values are valid.

Raises a WebserviceException if validation fails.

abstract validate_configuration()

Exceptions

WebserviceException

validate_image

Check that the image that is being deployed to the Webservice is valid.

Raises a WebserviceException if validation fails.

validate_image(image)

Parameters

cls

Required

Indicates that this is a class method.

image

Image

Required

The image that will be deployed to the webservice.

Exceptions

WebserviceException