Online Endpoints - Get

Serviço:: Machine Learning

Versão da API:: 2026-07-01

Obtenha o endpoint online.

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
endpointName	path	True	string	Nome do ponto de extremidade online.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	O ID da assinatura de destino.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nome do Espaço de Trabalho do Azure Machine Learning
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	OnlineEndpoint	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

Get Workspace Online Endpoint.

Pedido de amostra

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-07-01

Resposta da amostra

Código de estado:: 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": {}
}

Definições

Name	Descrição
createdByType	O tipo de identidade que criou o recurso.
EndpointAuthKeys	Chaves para autenticação de ponto final.
EndpointAuthMode	Enum para determinar o modo de autenticação do ponto final.
EndpointProvisioningState	Estado de provisionamento de ponto final.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
OnlineEndpoint	Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.
OnlineEndpointProperties	Configuração de ponto final online
PublicNetworkAccessType	Enum para determinar se PublicNetworkAccess está habilitado ou desabilitado.
Sku	A definição do modelo de recursos que representa a SKU
SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Object

Chaves para autenticação de ponto final.

Name	Tipo	Descrição
primaryKey	string (password)	A chave primária.
secondaryKey	string (password)	A chave secundária.

EndpointAuthMode

Enumeração

Enum para determinar o modo de autenticação do ponto final.

Valor	Descrição
AMLToken
Key
AADToken

EndpointProvisioningState

Enumeração

Estado de provisionamento de ponto final.

Valor	Descrição
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

ManagedServiceIdentity

Object

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Name	Tipo	Descrição
principalId	string (uuid)	O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string (uuid)	O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identidades O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Descrição
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OnlineEndpoint

Object

Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.

Name	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
kind	string	Metadados usados pelo portal/ferramenta/etc para renderizar diferentes experiências de UX para recursos do mesmo tipo.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties	OnlineEndpointProperties	[Obrigatório] Atributos adicionais da entidade.
sku	Sku	Detalhes de sku necessários para o contrato ARM para Autoscaling.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

OnlineEndpointProperties

Object

Configuração de ponto final online

Name	Tipo	Valor predefinido	Descrição
authMode	EndpointAuthMode		[Obrigatório] O método de autenticação para invocar o ponto de extremidade (operação do plano de dados). Use 'Key' para autenticação baseada em chave. Use 'AMLToken' para autenticação baseada em token do Azure Machine Learning. Use 'AADToken' para autenticação baseada em token do Microsoft Entra.
compute	string		ID do recurso ARM da computação, se existir. optional
description	string		Descrição do parâmetro de avaliação de inferência.
keys	EndpointAuthKeys (password)		EndpointAuthKeys para definir inicialmente em um Endpoint. Esta propriedade será sempre retornada como null. Os valores AuthKey devem ser recuperados usando a API ListKeys.
mirrorTraffic	object		Porcentagem de tráfego a ser espelhada para cada implantação sem usar a pontuação retornada. Os valores de tráfego têm de totalizar um máximo de 50.
properties	object		Dicionário de propriedades. As propriedades podem ser adicionadas, mas não removidas ou alteradas.
provisioningState	EndpointProvisioningState		Estado de provisionamento para o ponto de extremidade.
publicNetworkAccess	PublicNetworkAccessType	Enabled	Enum para determinar se PublicNetworkAccess está habilitado ou desabilitado.
scoringUri	string (uri)		URI do ponto final.
swaggerUri	string (uri)		URI do Endpoint Swagger.
traffic	object		Porcentagem de tráfego do ponto de extremidade a ser desviado para cada implantação. Os valores de tráfego precisam somar 100.

PublicNetworkAccessType

Enumeração

Enum para determinar se PublicNetworkAccess está habilitado ou desabilitado.

Valor	Descrição
Enabled
Disabled

Sku

Object

A definição do modelo de recursos que representa a SKU

Name	Tipo	Descrição
capacity	integer (int32)	Se a SKU suportar scaleout/in, o inteiro de capacidade deve ser incluído. Se a expansão/entrada não for possível para o recurso, isso poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU. Ex - P3. Normalmente, é um código de letra + número
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e algum outro valor, este seria o código autônomo.
tier	SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

SkuTier

Enumeração

Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

Valor	Descrição
Free
Basic
Standard
Premium

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Object

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Descrição
clientId	string (uuid)	O ID do cliente da identidade atribuída.
principalId	string (uuid)	O ID principal da identidade atribuída.