你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Online Endpoints - Get

获取联机终结点。

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

URI 参数

名称 必需 类型 说明
endpointName
path True

string

联机终结点名称。

resourceGroupName
path True

string

资源组的名称。 名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

workspaceName
path True

string

Azure 机器学习工作区的名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

OnlineEndpointTrackedResource

成功

Other Status Codes

ErrorResponse

错误

示例

Get Workspace Online Endpoint.

示例请求

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=2024-04-01

示例响应

{
  "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
  }
}

定义

名称 说明
createdByType

创建资源的标识的类型。

EndpointAuthKeys

终结点身份验证的密钥。

EndpointAuthMode

用于确定终结点身份验证模式的枚举。

EndpointProvisioningState

终结点预配的状态。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

OnlineEndpoint

联机终结点配置

OnlineEndpointTrackedResource
PublicNetworkAccessType

用于确定 PublicNetworkAccess 是已启用还是禁用的枚举。

Sku

表示 SKU 的资源模型定义

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

systemData

与创建和上次修改资源相关的元数据。

UserAssignedIdentity

用户分配的标识属性

createdByType

创建资源的标识的类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

EndpointAuthKeys

终结点身份验证的密钥。

名称 类型 说明
primaryKey

string

主键。

secondaryKey

string

辅助密钥。

EndpointAuthMode

用于确定终结点身份验证模式的枚举。

名称 类型 说明
AADToken

string

AMLToken

string

Key

string

EndpointProvisioningState

终结点预配的状态。

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

名称 类型 说明
principalId

string

系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OnlineEndpoint

联机终结点配置

名称 类型 默认值 说明
authMode

EndpointAuthMode

[必需]对基于密钥的身份验证使用“密钥”,将“AMLToken”用于基于 Azure 机器学习令牌的身份验证。 “Key”不会过期,但“AMLToken”会过期。

compute

string

计算的 ARM 资源 ID(如果存在)。 自选

description

string

推理终结点的说明。

keys

EndpointAuthKeys

最初在终结点上设置的 EndpointAuthKeys。 此属性将始终返回为 null。 必须使用 ListKeys API 检索 AuthKey 值。

mirrorTraffic

object

要镜像到每个部署的流量百分比,而不使用返回的评分。 流量值需要求和到最大 50。

properties

object

属性字典。 可以添加属性,但不能删除或更改属性。

provisioningState

EndpointProvisioningState

终结点的预配状态。

publicNetworkAccess

PublicNetworkAccessType

Enabled

对于启用专用链接时应允许公共访问的终结点,设置为“已启用”。

scoringUri

string

终结点 URI。

swaggerUri

string

终结点 Swagger URI。

traffic

object

从终结点转移到每个部署的流量百分比。 流量值需要总和到 100。

OnlineEndpointTrackedResource

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

kind

string

门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。

location

string

资源所在的地理位置

name

string

资源的名称

properties

OnlineEndpoint

[必需]实体的其他属性。

sku

Sku

用于自动缩放的 ARM 协定所需的 SKU 详细信息。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PublicNetworkAccessType

用于确定 PublicNetworkAccess 是已启用还是禁用的枚举。

名称 类型 说明
Disabled

string

Enabled

string

Sku

表示 SKU 的资源模型定义

名称 类型 说明
capacity

integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略此范围。

family

string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name

string

SKU 的名称。 Ex - P3. 它通常是字母+数字代码

size

string

SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。

tier

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

名称 类型 说明
Basic

string

Free

string

Premium

string

Standard

string

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string

分配的标识的客户端 ID。

principalId

string

已分配标识的主体 ID。