Share via

OnlineEndpoint Class

  • Reference

Online endpoint entity.

Online endpoint entity.

Constructor for an Online endpoint entity.

Constructor

OnlineEndpoint(*, name: str | None = None, tags: Dict[str, Any] | None = None, properties: Dict[str, Any] | None = None, auth_mode: str = 'key', description: str | None = None, location: str | None = None, traffic: Dict[str, int] | None = None, mirror_traffic: Dict[str, int] | None = None, identity: IdentityConfiguration | None = None, scoring_uri: str | None = None, openapi_uri: str | None = None, provisioning_state: str | None = None, kind: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
Optional[str]

Name of the resource, defaults to None

Default value: None
tags
Optional[Dict[str, Any]]

Tag dictionary. Tags can be added, removed, and updated. defaults to None

Default value: None
properties
Optional[Dict[str, Any]]

The asset property dictionary, defaults to None

Default value: None
auth_mode

Possible values include: "aml_token", "key", defaults to KEY

Default value: key
description
Optional[str]

Description of the inference endpoint, defaults to None

Default value: None
location
Optional[str]

Location of the resource, defaults to None

Default value: None
traffic
Optional[Dict[str, int]]

Traffic rules on how the traffic will be routed across deployments, defaults to None

Default value: None
mirror_traffic
Optional[Dict[str, int]]

Duplicated live traffic used to inference a single deployment, defaults to None

Default value: None
identity
Optional[IdentityConfiguration]

Identity Configuration, defaults to SystemAssigned

Default value: None
scoring_uri
Optional[str]

Scoring URI, defaults to None

Default value: None
openapi_uri
Optional[str]

OpenAPI URI, defaults to None

Default value: None
provisioning_state
Optional[str]

Provisioning state of an endpoint, defaults to None

Default value: None
kind
Optional[str]

Kind of the resource, we have two kinds: K8s and Managed online endpoints, defaults to None

Default value: None
name
Optional[str]

Name of the resource, defaults to None
tags
Optional[Dict[str, Any]]

Tag dictionary. Tags can be added, removed, and updated. defaults to None
properties
Optional[Dict[str, Any]]

The asset property dictionary, defaults to None
auth_mode

Possible values include: "aml_token", "key", defaults to KEY
description
Optional[str]

Description of the inference endpoint, defaults to None
location
Optional[str]

Location of the resource, defaults to None
traffic
Optional[Dict[str, int]]

Traffic rules on how the traffic will be routed across deployments, defaults to None
mirror_traffic
Optional[Dict[str, int]]

Duplicated live traffic used to inference a single deployment, defaults to None
identity
Optional[IdentityConfiguration]

Identity Configuration, defaults to SystemAssigned
scoring_uri
Optional[str]

Scoring URI, defaults to None
openapi_uri
Optional[str]

OpenAPI URI, defaults to None
provisioning_state
Optional[str]

Provisioning state of an endpoint, defaults to None
kind

Kind of the resource, we have two kinds: K8s and Managed online endpoints, defaults to None

Methods

dump

dump 

abstract dump(dest: str | PathLike | IO | None = None, **kwargs: Any) -> Dict

Parameters

Name Description
dest
Default value: None

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

openapi_uri

URI to check the open api definition of the endpoint.

Returns

Type Description
Optional[str]

The open API URI

provisioning_state

Endpoint provisioning state, readonly.

Returns

Type Description
Optional[str]

Endpoint provisioning state.

scoring_uri

URI to use to perform a prediction, readonly.

Returns

Type Description
Optional[str]

The scoring URI