OnlineEndpointProperties interface

Package:

@azure/arm-machinelearning

Online endpoint configuration

Extends

EndpointPropertiesBase

Properties

compute	ARM resource ID of the compute if it exists. optional
mirrorTraffic	Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
provisioningState	Provisioning state for the endpoint.
publicNetworkAccess	Enum to determine whether PublicNetworkAccess is Enabled or Disabled.
traffic	Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

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

compute

ARM resource ID of the compute if it exists. optional

compute?: string

Property Value

string

mirrorTraffic

Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.

mirrorTraffic?: Record<string, number>

Property Value

Record<string, number>

provisioningState

Provisioning state for the endpoint.

provisioningState?: string

Property Value

string

publicNetworkAccess

Enum to determine whether PublicNetworkAccess is Enabled or Disabled.

publicNetworkAccess?: string

Property Value

string

traffic

Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

traffic?: Record<string, number>

Property Value

Record<string, number>

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

EndpointAuthKeys

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