BatchEndpointProperties interface

Package:

@azure/arm-machinelearning

Batch endpoint configuration.

Extends

EndpointPropertiesBase

Properties

defaults	Default values for Batch Endpoint
provisioningState	Provisioning state for the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

authMode	[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
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. NOTE: This property will not be serialized. It can only be populated by the server.
swaggerUri	Endpoint Swagger URI. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

defaults

Default values for Batch Endpoint

defaults?: BatchEndpointDefaults

Property Value

BatchEndpointDefaults

provisioningState

Provisioning state for the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited Property Details

authMode

[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.

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

EndpointAuthKeys

Inherited From EndpointPropertiesBase.keys

properties

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

properties?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From EndpointPropertiesBase.properties

scoringUri

Endpoint URI. NOTE: This property will not be serialized. It can only be populated by the server.

scoringUri?: string

Property Value

string

Inherited From EndpointPropertiesBase.scoringUri

swaggerUri

Endpoint Swagger URI. NOTE: This property will not be serialized. It can only be populated by the server.

swaggerUri?: string

Property Value

string

Inherited From EndpointPropertiesBase.swaggerUri