Share via


OnlineDeployment Class

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.OnlineDeploymentTypeConverter))]
public class OnlineDeployment : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IOnlineDeployment, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IHeaderSerializable, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.OnlineDeploymentTypeConverter))>]
type OnlineDeployment = class
    interface IOnlineDeployment
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
    interface IHeaderSerializable
Public Class OnlineDeployment
Implements IHeaderSerializable, IOnlineDeployment, IValidates
Inheritance
OnlineDeployment
Attributes
Implements

Constructors

OnlineDeployment()

Creates an new OnlineDeployment instance.

Properties

AppInsightsEnabled

If true, enables Application Insights logging.

CodeConfigurationCodeId

ARM resource ID of the code asset.

CodeConfigurationScoringScript

[Required] The script to execute on startup. eg. "score.py"

DataCollectorCollection

[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.

DataCollectorRollingRate

When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.

Description

Description of the endpoint deployment.

EgressPublicNetworkAccess

If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.

EndpointComputeType

[Required] The compute type of the endpoint.

EndpointDeploymentPropertiesBaseProperty

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

EnvironmentId

ARM resource ID or AssetId of the environment specification for the endpoint deployment.

EnvironmentVariable

Environment variables configuration for the deployment.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IdentityPrincipalId

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityTenantId

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

IdentityUserAssignedIdentity

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

InstanceType

Compute instance type.

Kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.

LivenessProbeFailureThreshold

The number of failures to allow before returning an unhealthy status.

LivenessProbeInitialDelay

The delay before the first probe in ISO 8601 format.

LivenessProbePeriod

The length of time between probes in ISO 8601 format.

LivenessProbeSuccessThreshold

The number of successful probes before returning a healthy status.

LivenessProbeTimeout

The probe timeout in ISO 8601 format.

Location

The geo-location where the resource lives

Model

The URI path to the model.

ModelMountPath

The path to mount the model in custom container.

Name

The name of the resource

ProvisioningState

Provisioning state for the endpoint deployment.

ReadinessProbeFailureThreshold

The number of failures to allow before returning an unhealthy status.

ReadinessProbeInitialDelay

The delay before the first probe in ISO 8601 format.

ReadinessProbePeriod

The length of time between probes in ISO 8601 format.

ReadinessProbeSuccessThreshold

The number of successful probes before returning a healthy status.

ReadinessProbeTimeout

The probe timeout in ISO 8601 format.

RequestLoggingCaptureHeader

For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.

RequestSettingMaxConcurrentRequestsPerInstance

The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.

RequestSettingMaxQueueWait

(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase request_timeout_ms to account for any networking/queue delays)

RequestSettingRequestTimeout

The scoring timeout in ISO 8601 format. Defaults to 5000ms.

ResourceGroupName

Gets the resource group name

ScaleSettingScaleType

[Required] Type of deployment scaling algorithm

SkuCapacity

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

SkuName

The name of the SKU. Ex - P3. It is typically a letter+number code

SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

XmsAsyncOperationTimeout

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of OnlineDeployment.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of OnlineDeployment.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of OnlineDeployment into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Explicit Interface Implementations

IHeaderSerializable.ReadHeaders(HttpResponseHeaders)

Applies to