BatchEndpointProperties interface

Batch endpoint configuration.

Extends

Properties

defaults

Default values for Batch Endpoint

provisioningState

Provisioning state for the endpoint.

Inherited Properties

authMode

[Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication.

description

Description of the inference endpoint.

keys

EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.

properties

Property dictionary. Properties can be added, but not removed or altered.

scoringUri

Endpoint URI.

swaggerUri

Endpoint Swagger URI.

Property Details

defaults

Default values for Batch Endpoint

defaults?: BatchEndpointDefaults

Property Value

provisioningState

Provisioning state for the endpoint.

provisioningState?: string

Property Value

string

Inherited Property Details

authMode

[Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication.

authMode: string

Property Value

string

Inherited From EndpointPropertiesBase.authMode

description

Description of the inference endpoint.

description?: string

Property Value

string

Inherited From EndpointPropertiesBase.description

keys

EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.

keys?: EndpointAuthKeys

Property Value

Inherited From EndpointPropertiesBase.keys

properties

Property dictionary. Properties can be added, but not removed or altered.

properties?: Record<string, string>

Property Value

Record<string, string>

Inherited From EndpointPropertiesBase.properties

scoringUri

Endpoint URI.

scoringUri?: string

Property Value

string

Inherited From EndpointPropertiesBase.scoringUri

swaggerUri

Endpoint Swagger URI.

swaggerUri?: string

Property Value

string

Inherited From EndpointPropertiesBase.swaggerUri