BatchEndpoint Class

Batch endpoint entity.

Inheritance

azure.ai.ml.entities._endpoint.endpoint.Endpoint

BatchEndpoint

Constructor

BatchEndpoint(*, name: str | None = None, tags: Dict | None = None, properties: Dict | None = None, auth_mode: str = 'aad_token', description: str | None = None, location: str | None = None, defaults: Dict[str, str] | None = None, default_deployment_name: str | None = None, scoring_uri: str | None = None, openapi_uri: str | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str Name of the resource.
tags Required	dict[str, str] Tag dictionary. Tags can be added, removed, and updated.
properties Required	dict[str, str] The asset property dictionary.
auth_mode Required	str Possible values include: "AMLToken", "Key", "AADToken", defaults to None
description Required	str Description of the inference endpoint, defaults to None
location Required	str defaults to None
defaults Required	Dict[str, str] Traffic rules on how the traffic will be routed across deployments, defaults to {}
default_deployment_name Required	str Equivalent to defaults.default_deployment, will be ignored if defaults is present.
scoring_uri Required	str URI to use to perform a prediction, readonly.
openapi_uri Required	str URI to check the open API definition of the endpoint.

Keyword-Only Parameters

Name	Description
name Required
tags Required
properties Required
auth_mode	default value: aad_token
description Required
location Required
defaults Required
default_deployment_name Required
scoring_uri Required
openapi_uri Required

Methods

dump

dump

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

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