Online Endpoints - Get

Служба:: Machine Learning

Версия API:: 2026-03-01

Получение веб-конечной точки.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpointName	path	True	string	Имя конечной точки в Сети.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Имя рабочей области Машинного обучения Azure
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	OnlineEndpoint	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get Workspace Online Endpoint.

Образец запроса

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=2026-03-01

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
EndpointAuthKeys	Ключи для аутентификации конечных точек.
EndpointAuthMode	Перечисление для определения режима проверки подлинности конечной точки.
EndpointProvisioningState	Состояние подготовки конечных точек.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
OnlineEndpoint	Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства.
OnlineEndpointProperties	Настройка конечной точки в режиме онлайн
PublicNetworkAccessType	Перечисление, чтобы определить, включен или отключен PublicNetworkAccess.
Sku	Определение модели ресурсов, представляющее номер SKU
SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Объект

Ключи для аутентификации конечных точек.

Имя	Тип	Описание
primaryKey	string (password)	Первичный ключ.
secondaryKey	string (password)	Вторичный ключ.

EndpointAuthMode

Перечисление

Перечисление для определения режима проверки подлинности конечной точки.

Значение	Описание
AMLToken
Key
AADToken

EndpointProvisioningState

Перечисление

Состояние подготовки конечных точек.

Значение	Описание
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ManagedServiceIdentity

Объект

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в виде: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OnlineEndpoint

Объект

Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
kind	string	Метаданные, используемые порталом или инструментом и т. д., для отображения различных интерфейсов пользовательского интерфейса для ресурсов одного типа.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties	OnlineEndpointProperties	[Обязательный] Дополнительные атрибуты сущности.
sku	Sku	Сведения о SKU, необходимые для контракта ARM для автомасштабирования.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

OnlineEndpointProperties

Объект

Настройка конечной точки в режиме онлайн

Имя	Тип	Default value	Описание
authMode	EndpointAuthMode		[Обязательный] Метод проверки подлинности для вызова конечной точки (операции плоскости данных). Используйте "Ключ" для проверки подлинности на основе ключей. Используйте AMLToken для проверки подлинности на основе маркеров машинного обучения Azure. Используйте AADToken для проверки подлинности на основе токена Microsoft Entra.
compute	string		Идентификатор ресурса ARM для вычислительных ресурсов, если он существует. optional
description	string		Описание конечной точки вывода.
keys	EndpointAuthKeys (password)		EndpointAuthKeys, которые изначально задаются в конечной точке. Это свойство всегда возвращается как null. Значения AuthKey необходимо получить с помощью API ListKeys.
mirrorTraffic	object		Процент трафика, который будет зеркально отображаться в каждом развертывании без использования возвращаемой оценки. Значения трафика должны суммироваться до 50.
properties	object		Словарь свойств. Свойства можно добавлять, но не удалять или изменять.
provisioningState	EndpointProvisioningState		Состояние подготовки для конечной точки.
publicNetworkAccess	PublicNetworkAccessType	Enabled	Перечисление, чтобы определить, включен или отключен PublicNetworkAccess.
scoringUri	string (uri)		URI конечной точки.
swaggerUri	string (uri)		URI конечной точки Swagger.
traffic	object		Процент трафика от конечной точки для перенаправления в каждое развертывание. Значения трафика должны суммироваться до 100.

PublicNetworkAccessType

Перечисление

Перечисление, чтобы определить, включен или отключен PublicNetworkAccess.

Значение	Описание
Enabled
Disabled

Sku

Объект

Определение модели ресурсов, представляющее номер SKU

Имя	Тип	Описание
capacity	integer (int32)	Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU. Пример - П3. Обычно это код буквы и числа
size	string	Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.
tier	SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

SkuTier

Перечисление

Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

Значение	Описание
Free
Basic
Standard
Premium

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.