您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Online Deployments - List

列出推理终结点部署。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2021-03-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2021-03-01-preview&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

URI 参数

Name In Required Type Description
endpointName
path True
  • string

推理终结点名称。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

workspaceName
path True
  • string

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

api-version
query True
  • string

要用于此操作的 API 版本。

$orderBy
query
  • string

列表排序。

$skip
query
  • string

用于分页的继续标记。

$top
query
  • integer
int32

列表顶部。

响应

Name Type Description
200 OK

成功

Other Status Codes

错误

示例

List Online Deployments.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/onlineEndpoints/testEndpoint/deployments?api-version=2021-03-01-preview

Sample Response

{
  "value": [
    {
      "tags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": {
            "clientId": "string"
          }
        }
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/onlineEndpoints/testEndpoint/deployments/testDeployment",
      "name": "testDeployment",
      "type": "Microsoft.MachineLearningServices/workspaces/onlineEndpoints/deployments",
      "properties": {
        "endpointComputeType": "Managed",
        "readinessProbe": {
          "failureThreshold": 50,
          "successThreshold": 50,
          "timeout": "PT1M",
          "period": "PT1M",
          "initialDelay": "PT1M"
        },
        "scaleSettings": {
          "pollingInterval": "PT1M",
          "scaleType": "Auto",
          "targetUtilizationPercentage": 50
        },
        "requestSettings": {
          "maxQueueWait": "PT1M",
          "requestTimeout": "PT1M",
          "maxConcurrentRequestsPerInstance": 5
        },
        "provisioningState": "Creating",
        "description": "string",
        "properties": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "appInsightsEnabled": true,
        "livenessProbe": {
          "failureThreshold": 50,
          "successThreshold": 50,
          "timeout": "PT1M",
          "period": "PT1M",
          "initialDelay": "PT1M"
        },
        "model": {
          "referenceType": "Id",
          "assetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/models/model123"
        },
        "codeConfiguration": {
          "codeId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/code123/versions/1",
          "scoringScript": "string"
        },
        "environmentId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/env123"
      }
    },
    {
      "tags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": {
            "clientId": "string"
          }
        }
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/onlineEndpoints/testEndpoint/deployments/testDeployment",
      "name": "testDeployment",
      "type": "Microsoft.MachineLearningServices/workspaces/onlineEndpoints/deployments",
      "properties": {
        "endpointComputeType": "K8S",
        "containerResourceRequirements": {
          "cpu": 4,
          "cpuLimit": 4,
          "memoryInGB": 64,
          "memoryInGBLimit": 64
        },
        "scaleSettings": {
          "pollingInterval": "PT1M",
          "scaleType": "Auto",
          "targetUtilizationPercentage": 50
        },
        "requestSettings": {
          "maxQueueWait": "PT1M",
          "requestTimeout": "PT1M",
          "maxConcurrentRequestsPerInstance": 5
        },
        "provisioningState": "Creating",
        "description": "string",
        "properties": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "appInsightsEnabled": true,
        "livenessProbe": {
          "failureThreshold": 50,
          "successThreshold": 50,
          "timeout": "PT1M",
          "period": "PT1M",
          "initialDelay": "PT1M"
        },
        "model": {
          "referenceType": "Id",
          "assetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/models/model123"
        },
        "codeConfiguration": {
          "codeId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/code123/versions/1",
          "scoringScript": "string"
        },
        "environmentId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/env123"
      }
    }
  ],
  "nextLink": "string"
}

定义

AutoScaleSettings
CodeConfiguration

评分代码资产的配置。

ContainerResourceRequirements

容器 (cpu 和内存) 的资源要求。

createdByType

创建资源的标识的类型。

DataPathAssetReference

通过数据存储中资产的路径引用资产。

DeploymentProvisioningState
EndpointComputeType

用于确定终结点计算类型的枚举。

ErrorAdditionalInfo

资源管理错误的其他信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdAssetReference

通过 ARM 资源 ID 引用资产。

K8sOnlineDeployment
ManagedOnlineDeployment
ManualScaleSettings
OnlineDeploymentTrackedResource
OnlineDeploymentTrackedResourceArmPaginatedResult

OnlineDeployment 实体的分页列表。

OnlineRequestSettings
OutputPathAssetReference

通过资产在作业输出中的路径引用资产。

ProbeSettings
ReferenceType

枚举以确定要用于资产的引用方法。

ResourceIdentity

与资源关联的服务标识。

ResourceIdentityAssignment

定义 ResourceIdentity 类型的值。

ScaleType
systemData

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

UserAssignedIdentityMeta

与资源关联的用户分配的标识。

AutoScaleSettings

Name Type Description
maxInstances
  • integer
minInstances
  • integer
pollingInterval
  • string

采用 ISO 8691 格式的轮询间隔。 仅支持精度低至秒的持续时间。

scaleType string:
  • Auto
targetUtilizationPercentage
  • integer

CodeConfiguration

评分代码资产的配置。

Name Type Description
codeId
  • string

代码资产的 ARM 资源 ID。

scoringScript
  • string

要在启动时执行的脚本。 例如 "score.py"

ContainerResourceRequirements

容器 (cpu 和内存) 的资源要求。

Name Type Description
cpu
  • number

容器要使用的最小 CPU 内核数。 详细信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

cpuLimit
  • number

容器允许使用的最大 CPU 核心数。 详细信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

fpga
  • integer

向容器公开的 FPGA PCIE 设备数。 必须是2的倍数。

gpu
  • integer

容器中 GPU 内核的数量。

memoryInGB
  • number

容器使用的最小内存量 (以 GB) 。 详细信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

memoryInGBLimit
  • number

允许容器使用的最大内存量 (以 GB) 。 详细信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

createdByType

创建资源的标识的类型。

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

DataPathAssetReference

通过数据存储中资产的路径引用资产。

Name Type Description
datastoreId
  • string

资产所在的数据存储的 ARM 资源 ID。

path
  • string

数据存储中文件/目录的路径。

referenceType string:
  • DataPath

指定资产引用的类型。

DeploymentProvisioningState

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

EndpointComputeType

用于确定终结点计算类型的枚举。

Name Type Description
AzureMLCompute
  • string
K8S
  • string
Managed
  • 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

Error 对象。

IdAssetReference

通过 ARM 资源 ID 引用资产。

Name Type Description
assetId
  • string

资产的 ARM 资源 ID。

referenceType string:
  • Id

指定资产引用的类型。

K8sOnlineDeployment

Name Type Description
appInsightsEnabled
  • boolean

如果为 true,则启用 Application Insights 日志记录。

codeConfiguration

终结点部署的代码配置。

containerResourceRequirements

容器 (cpu 和内存) 的资源要求。

description
  • string

终结点部署的说明。

endpointComputeType string:
  • K8S

终结点的计算类型。

environmentId
  • string

用于终结点部署的环境规范的 ARM 资源 ID。

environmentVariables
  • object

部署的环境变量配置。

livenessProbe
model AssetReferenceBase:

对终结点部署的模型资产的引用。

properties
  • object

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

provisioningState

终结点部署的预配状态。

requestSettings
scaleSettings OnlineScaleSettings:

ManagedOnlineDeployment

Name Type Description
appInsightsEnabled
  • boolean

如果为 true,则启用 Application Insights 日志记录。

codeConfiguration

终结点部署的代码配置。

description
  • string

终结点部署的说明。

endpointComputeType string:
  • Managed

终结点的计算类型。

environmentId
  • string

用于终结点部署的环境规范的 ARM 资源 ID。

environmentVariables
  • object

部署的环境变量配置。

instanceType
  • string
livenessProbe
model AssetReferenceBase:

对终结点部署的模型资产的引用。

properties
  • object

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

provisioningState

终结点部署的预配状态。

readinessProbe
requestSettings
scaleSettings OnlineScaleSettings:

ManualScaleSettings

Name Type Description
instanceCount
  • integer
maxInstances
  • integer
minInstances
  • integer
scaleType string:
  • Manual

OnlineDeploymentTrackedResource

Name Type Description
id
  • string

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

identity

与资源关联的服务标识。

kind
  • string
location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties OnlineDeployment:

实体的其他特性。

systemData

与资源提供程序关联的系统数据

tags
  • object

资源标记。

type
  • string

资源类型。 例如 "VirtualMachines/storageAccounts" 或 ""

OnlineDeploymentTrackedResourceArmPaginatedResult

OnlineDeployment 实体的分页列表。

Name Type Description
nextLink
  • string
value

类型为 OnlineDeployment 的对象的数组。

OnlineRequestSettings

Name Type Description
maxConcurrentRequestsPerInstance
  • integer
maxQueueWait
  • string

以 ISO 8601 格式的最大队列等待时间。 支持毫秒精度。

requestTimeout
  • string

采用 ISO 8601 格式的请求超时。 支持毫秒精度。

OutputPathAssetReference

通过资产在作业输出中的路径引用资产。

Name Type Description
jobId
  • string

作业的 ARM 资源 ID。

path
  • string

作业输出中文件/目录的路径。

referenceType string:
  • OutputPath

指定资产引用的类型。

ProbeSettings

Name Type Description
failureThreshold
  • integer

在返回不正常状态之前允许的失败次数。

initialDelay
  • string

ISO 8601 格式中第一个探测之前的延迟。

period
  • string

采用 ISO 8601 格式的探测之间的时间长度。

successThreshold
  • integer

在返回正常状态之前探测成功的次数。

timeout
  • string

采用 ISO 8601 格式的探测超时。

ReferenceType

枚举以确定要用于资产的引用方法。

Name Type Description
DataPath
  • string
Id
  • string
OutputPath
  • string

ResourceIdentity

与资源关联的服务标识。

Name Type Description
principalId
  • string

身份验证时使用的客户端 ID。

tenantId
  • string

此标识所在的 AAD 租户。

type

定义 ResourceIdentity 类型的值。

userAssignedIdentities

用户分配的标识的字典,密钥是 UAI 的 ARM 资源 ID。

ResourceIdentityAssignment

定义 ResourceIdentity 类型的值。

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

ScaleType

Name Type Description
Auto
  • string
Manual
  • string

systemData

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

Name Type Description
createdAt
  • string

(UTC) 创建资源的时间戳。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

UserAssignedIdentityMeta

与资源关联的用户分配的标识。

Name Type Description
clientId
  • string

称为 "应用程序 ID",它是由 Azure AD 生成的唯一标识符,该标识符在初始设置期间绑定到应用程序和服务主体。

principalId
  • string

托管标识的服务主体对象的对象 ID,该对象用于授予对 Azure 资源的基于角色的访问权限。