Share via


OnlineEndpointProperties Class

Definition

Online endpoint configuration

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.OnlineEndpointPropertiesTypeConverter))]
public class OnlineEndpointProperties : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IOnlineEndpointProperties, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.OnlineEndpointPropertiesTypeConverter))>]
type OnlineEndpointProperties = class
    interface IOnlineEndpointProperties
    interface IJsonSerializable
    interface IEndpointPropertiesBase
    interface IValidates
Public Class OnlineEndpointProperties
Implements IOnlineEndpointProperties, IValidates
Inheritance
OnlineEndpointProperties
Attributes
Implements

Constructors

OnlineEndpointProperties()

Creates an new OnlineEndpointProperties instance.

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.

Compute

ARM resource ID of the compute if it exists. optional

Description

Description of the inference endpoint.

Key

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

KeyPrimaryKey

The primary key.

KeySecondaryKey

The secondary key.

MirrorTraffic

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

Property

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

ProvisioningState

Provisioning state for the endpoint.

PublicNetworkAccess

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

ScoringUri

Endpoint URI.

SwaggerUri

Endpoint Swagger URI.

Traffic

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of OnlineEndpointProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of OnlineEndpointProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IOnlineEndpointProperties.

FromJsonString(String)

Creates a new instance of OnlineEndpointProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of OnlineEndpointProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to