Share via

WebserviceDeploymentConfiguration Class

  • Reference

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

Name Description
type
Required
Webservice

The type of Webservice associated with this object.
description
str

A description to give this Webservice.

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

The Azure region to deploy this Webservice to.

Default value: None
type
Required
Webservice

The type of Webservice associated with this object.
description
Required
str

A description to give this Webservice.
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.
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.
location
Required
str

The Azure region to deploy this Webservice to.

Variables

Name Description
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

Type Description
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

Name Description
cls
Required

Indicates that this is a class method.
image
Required
Image

The image that will be deployed to the webservice.

Exceptions

Type Description
WebserviceException