BatchEndpoint Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401

Assembly:: Az.MachineLearningServices.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.BatchEndpointTypeConverter))]
public class BatchEndpoint : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IBatchEndpoint, 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.BatchEndpointTypeConverter))>]
type BatchEndpoint = class
    interface IBatchEndpoint
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
    interface IHeaderSerializable

Public Class BatchEndpoint
Implements IBatchEndpoint, IHeaderSerializable, IValidates

Inheritance: Object
BatchEndpoint

Attributes: TypeConverterAttribute

Implements: IBatchEndpoint IResource ITrackedResource IHeaderSerializable IJsonSerializable IValidates

Constructors

BatchEndpoint()

Creates an new BatchEndpoint 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.
DefaultDeploymentName	Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
Description	Description of the inference endpoint.
EndpointPropertiesBaseProperty	Property dictionary. Properties can be added, but not removed or altered.
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.
KeyPrimaryKey	The primary key.
KeySecondaryKey	The secondary key.
Kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
Location	The geo-location where the resource lives
Name	The name of the resource
ProvisioningState	Provisioning state for the endpoint.
ResourceGroupName	Gets the resource group name
ScoringUri	Endpoint URI.
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.
SwaggerUri	Endpoint Swagger URI.
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 BatchEndpoint.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of BatchEndpoint.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IBatchEndpoint.
FromJsonString(String)	Creates a new instance of BatchEndpoint, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of BatchEndpoint 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

Share via