Share via

ServerlessEndpoint Class

  • Reference

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Serverless Endpoint Definition.

Readonly variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

ivar name: The deployment name. Required.

vartype name: str

ivar auth_mode: Authentication mode of the endpoint.

vartype auth_mode: str

ivar model_id: The id of the model to deploy. Required.

vartype model_id: str

ivar location: Location in which to create endpoint.

vartype location: str

ivar provisioning_state: Provisioning state of the endpoint. Possible values are: "creating", "deleting", "succeeded", "failed", "updating", and "canceled".

vartype provisioning_state: str

ivar tags: Tags for the endpoint.

vartype tags: dict[str, str]

ivar properties: Properties of the endpoint.

vartype properties: dict[str, str]

ivar description: Descripton of the endpoint.

vartype description: str

ivar scoring_uri: Scoring uri of the endpoint.

vartype scoring_uri: str

ivar id: ARM resource id of the endpoint.

vartype id: str

ivar headers: Headers required to hit the endpoint.

vartype id: dict[str, str]

ivar system_data: System data of the endpoint.

vartype system_data: ~azure.ai.ml.entities.SystemData

Inheritance
azure.ai.ml.entities._autogen_entities.models._models.ServerlessEndpoint
ServerlessEndpoint
azure.ai.ml.entities._autogen_entities.models._patch.ValidationMixin
ServerlessEndpoint

Constructor

ServerlessEndpoint(*args: Any, **kwargs: Any)

Methods

as_dict
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict 

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

clear 

clear() -> None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

copy 

copy() -> Model

Keyword-Only Parameters

Name Description
exclude_readonly
Required

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

items 

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

keys 

keys() -> KeysView[str]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
Required

popitem 

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
Required

update 

update(*args: Any, **kwargs: Any) -> None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

values 

values() -> ValuesView[Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

Attributes

auth_mode

"key", "aad". Defaults to "key" if not given.

auth_mode: str | None

description

Descripton of the endpoint.

description: str | None

headers

Headers required to hit the endpoint.

headers: Dict[str, str] | None

id

ARM resource id of the endpoint.

id: str | None

location

Location in which to create endpoint.

location: str | None

model_id

The id of the model to deploy. Required.

model_id: str

name

The deployment name. Required.

name: str

properties

Properties of the endpoint.

properties: Dict[str, str] | None

provisioning_state

"creating", "deleting", "succeeded", "failed", "updating", and "canceled".

provisioning_state: str | None

scoring_uri

Scoring uri of the endpoint.

scoring_uri: str | None

system_data

System data of the endpoint.

system_data: SystemData | None

tags

Tags for the endpoint.

tags: Dict[str, str] | None