Online Endpoints - Get

Referencia

Servicio:: Machine Learning

Versión de la API:: 2025-04-01

Obtener punto de conexión en línea.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}?api-version=2025-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpointName	path	True	string	Nombre del punto de conexión en línea.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nombre del área de trabajo de Azure Machine Learning.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	OnlineEndpointTrackedResource	Éxito
Other Status Codes	ErrorResponse	Error

Ejemplos

Get Workspace Online Endpoint.

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName?api-version=2025-04-01

Respuesta de muestra

status code:: 200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example",
    "authMode": "AMLToken",
    "provisioningState": "Creating",
    "compute": "string",
    "traffic": {
      "string": 1
    }
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "principalId": "00000000-1111-2222-3333-444444444444",
        "clientId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
EndpointAuthKeys	Claves para la autenticación del punto de conexión.
EndpointAuthMode	Enumeración para determinar el modo de autenticación del punto de conexión.
EndpointProvisioningState	Estado del aprovisionamiento de puntos de conexión.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
OnlineEndpoint	Configuración del punto de conexión en línea
OnlineEndpointTrackedResource
PublicNetworkAccessType	Enumeración para determinar si PublicNetworkAccess está habilitado o deshabilitado.
Sku	Definición del modelo de recursos que representa la SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EndpointAuthKeys

Object

Claves para la autenticación del punto de conexión.

Nombre	Tipo	Description
primaryKey	string	Clave principal.
secondaryKey	string	Clave secundaria.

EndpointAuthMode

Enumeración

Enumeración para determinar el modo de autenticación del punto de conexión.

Valor	Description
AADToken
AMLToken
Key

EndpointProvisioningState

Enumeración

Estado del aprovisionamiento de puntos de conexión.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedServiceIdentity

Object

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

OnlineEndpoint

Object

Configuración del punto de conexión en línea

Nombre	Tipo	Valor predeterminado	Description
authMode	EndpointAuthMode		[Obligatorio] Método de autenticación para invocar el punto de conexión (operación del plano de datos). Use "Key" para la autenticación basada en claves. Use "AMLToken" para la autenticación basada en tokens de Azure Machine Learning. Use "AADToken" para la autenticación basada en tokens de Microsoft Entra.
compute	string		Identificador de recurso de ARM del proceso si existe. opcional
description	string		Descripción del punto de conexión de inferencia.
keys	EndpointAuthKeys		EndpointAuthKeys para establecer inicialmente en un punto de conexión. Esta propiedad siempre se devolverá como null. Los valores de AuthKey deben recuperarse mediante listKeys API.
mirrorTraffic	object		Porcentaje de tráfico que se va a reflejar en cada implementación sin usar la puntuación devuelta. Los valores de tráfico deben sumar hasta el máximo de 50.
properties	object		Diccionario de propiedades. Se pueden agregar propiedades, pero no se pueden quitar ni modificar.
provisioningState	EndpointProvisioningState		Estado de aprovisionamiento para el punto de conexión.
publicNetworkAccess	PublicNetworkAccessType	Enabled	Establézcalo en "Habilitado" para los puntos de conexión que deben permitir el acceso público cuando Private Link esté habilitado.
scoringUri	string (uri)		URI del punto de conexión.
swaggerUri	string (uri)		URI de Swagger de punto de conexión.
traffic	object		Porcentaje de tráfico del punto de conexión para desviar a cada implementación. Los valores de tráfico deben sumar a 100.

OnlineEndpointTrackedResource

Object

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
kind	string	Metadatos usados por el portal,herramientas/etcetera para representar experiencias de experiencia de usuario diferentes para los recursos del mismo tipo.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties	OnlineEndpoint	[Obligatorio] Atributos adicionales de la entidad.
sku	Sku	Detalles de SKU necesarios para el contrato arm para el escalado automático.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PublicNetworkAccessType

Enumeración

Enumeración para determinar si PublicNetworkAccess está habilitado o deshabilitado.

Valor	Description
Disabled
Enabled

Sku

Object

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Basic
Free
Premium
Standard

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Compartir a través de

Online Endpoints - Get

Parámetros de identificador URI

Respuestas

Ejemplos

Get Workspace Online Endpoint.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

OnlineEndpoint

OnlineEndpointTrackedResource

PublicNetworkAccessType

Sku

SkuTier

systemData

UserAssignedIdentity