Share via

OnlineEndpointProperties interface

  • Reference
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. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
traffic

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

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

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?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

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

publicNetworkAccess

Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.

publicNetworkAccess?: string

Property Value

string

traffic

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

traffic?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

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