Online Endpoints - List

列出線上端點。

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

URI 參數

Name In Required Type Description
resourceGroupName
path True
  • string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True
  • string

目標訂用帳戶的識別碼。

workspaceName
path True
  • string

Azure Machine Learning 工作區的名稱。

api-version
query True
  • string

要用於此作業的 API 版本。

$skip
query
  • string

分頁的接續 token。

computeType
query

要依篩選的 EndpointComputeType。

count
query
  • integer
int32

要在結果頁面中取出的端點數目。

name
query
  • string

端點的名稱。

orderBy
query

排序回應的選項。

properties
query
  • string

用來篩選傳回模型的一組屬性。 它是以逗號分隔的屬性索引鍵和/或屬性索引鍵 = 值範例: propKey1、propKey2、propKey3 = value3。

tags
query
  • string

用來篩選傳回模型的一組標記。 它是標記索引鍵或標記索引鍵 = 值的逗點分隔字串。 範例: tagKey1、tagKey2、tagKey3 = value3。

回應

Name Type Description
200 OK

Success

Other Status Codes

錯誤

範例

List Online Endpoint.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/onlineEndpoints?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",
      "name": "testEndpoint",
      "type": "Microsoft.MachineLearningServices/workspaces/onlineEndpoints",
      "properties": {
        "provisioningState": "Creating",
        "description": "string",
        "properties": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "traffic": {
          "myDeployment1": 0,
          "myDeployment2": 1
        },
        "scoringUri": "string",
        "swaggerUri": "string",
        "target": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/compute123",
        "authMode": "AMLToken"
      }
    }
  ],
  "nextLink": "string"
}

定義

createdByType

建立資源的身分識別類型。

EndpointAuthKeys

端點驗證的金鑰。

EndpointAuthMode

用以判斷端點驗證模式的列舉。

EndpointComputeType

列舉來判斷端點計算類型。

EndpointProvisioningState

端點布建的狀態。

ErrorAdditionalInfo

資源管理錯誤的其他資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

錯誤回應

OnlineEndpoint

線上端點設定

OnlineEndpointTrackedResource
OnlineEndpointTrackedResourceArmPaginatedResult

OnlineEndpoint 實體的分頁清單。

OrderString
ResourceIdentity

與資源相關聯的服務身分識別。

ResourceIdentityAssignment

定義 ResourceIdentity 類型的值。

systemData

與資源建立和上次修改相關的中繼資料。

UserAssignedIdentityMeta

與資源相關聯的使用者指派身分識別。

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

EndpointComputeType

列舉來判斷端點計算類型。

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

Error 物件。

OnlineEndpoint

線上端點設定

Name Type Description
authMode

推斷端點驗證模式類型

description
  • string

推斷端點的描述。

keys

EndpointAuthKeys,一開始會在端點上設定。 此屬性一律會以 null 傳回。 您必須使用 ListKeys API 來取出 AuthKey 值。

properties
  • object

屬性字典。 您可以新增或不移除或變更屬性。

provisioningState

端點布建的狀態。

scoringUri
  • string

端點 URI。

swaggerUri
  • string

端點 Swagger URI。

target
  • string

計算的 ARM 資源識別碼(如果有的話)。 選用

traffic
  • object

流量將如何路由傳送至整個部署的流量規則。

OnlineEndpointTrackedResource

Name Type Description
id
  • string

資源的完整資源識別碼。 例如-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

與資源相關聯的服務身分識別。

kind
  • string
location
  • string

資源所在的地理位置

name
  • string

資源的名稱

properties

實體的其他屬性。

systemData

與資源提供者相關聯的系統資料

tags
  • object

資源標籤。

type
  • string

資源類型。 例如 "Microsoft. Compute/virtualMachines" 或 "Microsoft. Storage/storageAccounts"

OnlineEndpointTrackedResourceArmPaginatedResult

OnlineEndpoint 實體的分頁清單。

Name Type Description
nextLink
  • string
value

OnlineEndpoint 類型的物件陣列。

OrderString

Name Type Description
CreatedAtAsc
  • string
CreatedAtDesc
  • string
UpdatedAtAsc
  • string
UpdatedAtDesc
  • string

ResourceIdentity

與資源相關聯的服務身分識別。

Name Type Description
principalId
  • string

驗證時使用的用戶端識別碼。

tenantId
  • string

此身分識別所在的 AAD 租使用者。

type

定義 ResourceIdentity 類型的值。

userAssignedIdentities

使用者指派身分識別的字典,金鑰是 UAI 的 ARM 資源識別碼。

ResourceIdentityAssignment

定義 ResourceIdentity 類型的值。

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

systemData

與資源建立和上次修改相關的中繼資料。

Name Type Description
createdAt
  • string

(UTC) 的資源建立時間戳記。

createdBy
  • string

建立資源的身分識別。

createdByType

建立資源的身分識別類型。

lastModifiedAt
  • string

上次修改資源的時間戳記 (UTC)

lastModifiedBy
  • string

上次修改資源的身分識別。

lastModifiedByType

上次修改資源的身分識別類型。

UserAssignedIdentityMeta

與資源相關聯的使用者指派身分識別。

Name Type Description
clientId
  • string

也稱為應用程式識別碼,Azure AD 所產生的唯一識別碼,會在其初始布建期間系結至應用程式和服務主體。

principalId
  • string

受控識別之服務主體物件的物件識別碼,可用來將角色型存取授與 Azure 資源。