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

Online Endpoints - Create Or Update

创建或更新联机终结点 (异步) 。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}?api-version=2022-06-01-preview

URI 参数

Name In Required Type Description
endpointName
path True
  • string

联机终结点名称。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

workspaceName
path True
  • string

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

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Required Type Description
location True
  • string

资源所在的地理位置

properties True

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

identity

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

kind
  • string

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

sku

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

tags
  • object

资源标记。

响应

Name Type Description
200 OK

成功

201 Created

创建

Headers

  • x-ms-async-operation-timeout: string
  • Azure-AsyncOperation: string
Other Status Codes

错误

示例

CreateOrUpdate Online Endpoint.

Sample Request

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

{
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "authMode": "AMLToken",
    "compute": "string",
    "traffic": {
      "string": 1
    }
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Sample Response

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

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EndpointAuthKeys

终结点身份验证的密钥。

Name Type Description
primaryKey
  • string

主键。

secondaryKey
  • string

辅助密钥。

EndpointAuthMode

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

Name Type Description
AADToken
  • string
AMLToken
  • string
Key
  • string

EndpointProvisioningState

终结点预配的状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

ManagedServiceIdentity

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

Name Type Description
principalId
  • string

系统分配标识的服务主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

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

userAssignedIdentities

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

ManagedServiceIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

OnlineEndpoint

联机终结点配置

Name Type Default Value Description
authMode

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

compute
  • string

如果计算存在,则为 ARM 资源 ID。 可选

description
  • string

推理终结点的说明。

keys

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

mirrorTraffic
  • object

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

properties
  • object

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

provisioningState

终结点的预配状态。

publicNetworkAccess Enabled

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

scoringUri
  • string

终结点 URI。

swaggerUri
  • string

终结点 Swagger URI。

traffic
  • object

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

OnlineEndpointTrackedResource

Name Type Description
id
  • string

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

identity

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

kind
  • string

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

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties

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

sku

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

systemData

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

tags
  • object

资源标记。

type
  • string

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

PublicNetworkAccessType

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

Name Type Description
Disabled
  • string
Enabled
  • string

Sku

表示 SKU 的资源模型定义

Name Type Description
capacity
  • integer

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

family
  • string

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

name
  • string

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

size
  • string

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

tier

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

SkuTier

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

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

UserAssignedIdentity

用户分配的标识属性

Name Type Description
clientId
  • string

分配的标识的客户端 ID。

principalId
  • string

分配的标识的主体 ID。