Share via

Endpoint Class

  • Reference

Endpoint base class.

Endpoint base class.

Constructor for Endpoint base class.

Inheritance
azure.ai.ml.entities._resource.Resource
Endpoint

Constructor

Endpoint(auth_mode: str | None = None, location: str | None = None, name: str | None = None, tags: Dict[str, str] | None = None, properties: Dict[str, Any] | None = None, description: str | None = None, **kwargs: Any)

Parameters

Name Description
auth_mode
str

The authentication mode, defaults to None

Default value: None
location
str

The location of the endpoint, defaults to None

Default value: None
name
str

Name of the resource.

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

Tag dictionary. Tags can be added, removed, and updated.

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

The asset property dictionary.

Default value: None
description
Optional[str]

Description of the resource.

Default value: None
auth_mode
Required
str

The authentication mode, defaults to None
location
Required
str

The location of the endpoint, defaults to None
name
Required
str

Name of the resource.
tags
Required
Optional[Dict[str, str]]

Tag dictionary. Tags can be added, removed, and updated.
properties
Required
Optional[Dict[str, str]]

The asset property dictionary.
description
Required
Optional[str]

Description of the resource.

Keyword-Only Parameters

Name Description
traffic
Optional[Dict[str, int]]

Traffic rules on how the traffic will be routed across deployments, defaults to {}
scoring_uri
Optional[str]

str, Endpoint URI, readonly
openapi_uri
Optional[str]

str, Endpoint Open API URI, readonly
provisioning_state
Optional[str]

str, provisioning state, readonly
traffic
Optional[Dict[str, int]]

Traffic rules on how the traffic will be routed across deployments, defaults to {}
scoring_uri
Optional[str]

str, Endpoint URI, readonly
openapi_uri
Optional[str]

str, Endpoint Open API URI, readonly
provisioning_state
Optional[str]

str, provisioning state, readonly

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