Online Endpoints - List

參考

Service:: Machine Learning

API Version:: 2024-04-01

列出在線端點。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
workspaceName	path	True	string	Azure Machine Learning 工作區的名稱。 Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	用於此作業的 API 版本。
$skip	query		string	分頁的接續令牌。
computeType	query		EndpointComputeType	要篩選的 EndpointComputeType。
count	query		integer int32	在結果頁面中要擷取的端點數目。
name	query		string	端點的名稱。
orderBy	query		OrderString	排序回應的選項。
properties	query		string	一組屬性，用來篩選傳回的模型。它是屬性索引鍵和/或 properties key=value 範例：propKey1，propKey2，propKey3=value3 的逗號分隔字符串。
tags	query		string	一組標記，用來篩選傳回的模型。它是標記索引鍵或tags key=value的逗號分隔字串。範例：tagKey1，tagKey2，tagKey3=value3 。

回應

名稱	類型	Description
200 OK	OnlineEndpointTrackedResourceArmPaginatedResult	Success
Other Status Codes	ErrorResponse	錯誤

範例

List Workspace Online Endpoint.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints?api-version=2024-04-01&name=string&count=1&computeType=Managed&tags=string&properties=string&orderBy=CreatedAtDesc

Sample Response

Status code:: 200

{
  "value": [
    {
      "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
      }
    }
  ],
  "nextLink": "string"
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
EndpointAuthKeys	端點驗證的金鑰。
EndpointAuthMode	用來判斷端點驗證模式的列舉。
EndpointComputeType	用來判斷端點計算類型的列舉。
EndpointProvisioningState	端點布建的狀態。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ManagedServiceIdentity	受控服務識別 (系統指派和/或使用者指派的身分識別)
ManagedServiceIdentityType	(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。
OnlineEndpoint	在線端點設定
OnlineEndpointTrackedResource
OnlineEndpointTrackedResourceArmPaginatedResult	OnlineEndpoint 實體的編頁清單。
OrderString
PublicNetworkAccessType	用來判斷 PublicNetworkAccess 為 Enabled 或 Disabled 的列舉。
Sku	代表 SKU 的資源模型定義
SkuTier	如果服務有一個以上的層級，但在PUT上則不需要此欄位，才能由資源提供者實作。
systemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentity	使用者指派的身分識別屬性

createdByType

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

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndpointAuthKeys

端點驗證的金鑰。

名稱	類型	Description
primaryKey	string	主鍵。
secondaryKey	string	次要金鑰。

EndpointAuthMode

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

名稱	類型	Description
AADToken	string
AMLToken	string
Key	string

EndpointComputeType

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

名稱	類型	Description
AzureMLCompute	string
Kubernetes	string
Managed	string

EndpointProvisioningState

端點布建的狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ManagedServiceIdentity

受控服務識別 (系統指派和/或使用者指派的身分識別)

名稱	類型	Description
principalId	string	系統指派之身分識別的服務主體標識符。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ManagedServiceIdentityType	(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 身分識別與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是要求中 ({}) 的空白物件。

ManagedServiceIdentityType

(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OnlineEndpoint

在線端點設定

名稱	類型	預設值	Description
authMode	EndpointAuthMode		[必要]使用 'Key' 進行密鑰型驗證，並使用 'AMLToken' 進行 Azure Machine Learning 令牌型驗證。 'Key' 不會過期，但 'AMLToken' 會過期。
compute	string		如果計算存在，則為其 ARM 資源識別碼。選用
description	string		推斷端點的描述。
keys	EndpointAuthKeys		EndpointAuthKeys 一開始在端點上設定。這個屬性一律會以 Null 傳回。必須使用 ListKeys API 來擷取 AuthKey 值。
mirrorTraffic	object		要鏡像到每個部署的流量百分比，而不需使用傳回的評分。流量值必須加總到 u，50。
properties	object		屬性字典。您可以新增屬性，但無法移除或改變。
provisioningState	EndpointProvisioningState		端點的布建狀態。
publicNetworkAccess	PublicNetworkAccessType	Enabled	針對啟用 Private Link 時應允許公用存取的端點，設定為 [已啟用]。
scoringUri	string		端點 URI。
swaggerUri	string		端點 Swagger URI。
traffic	object		從端點轉移至每個部署的流量百分比。流量值必須加總到 100。

OnlineEndpointTrackedResource

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /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	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

OnlineEndpointTrackedResourceArmPaginatedResult

OnlineEndpoint 實體的編頁清單。

名稱	類型	Description
nextLink	string	OnlineEndpoint 物件下一頁的連結。如果為 null，則沒有任何其他頁面。
value	OnlineEndpointTrackedResource[]	OnlineEndpoint 類型的物件陣列。

OrderString

名稱	類型	Description
CreatedAtAsc	string
CreatedAtDesc	string
UpdatedAtAsc	string
UpdatedAtDesc	string

PublicNetworkAccessType

用來判斷 PublicNetworkAccess 為 Enabled 或 Disabled 的列舉。

名稱	類型	Description
Disabled	string
Enabled	string

Sku

代表 SKU 的資源模型定義

名稱	類型	Description
capacity	integer	如果 SKU 支援相應放大/縮小，則應該包含容量整數。如果資源無法相應放大/縮小，可能會省略此專案。
family	string	如果服務有不同的硬體世代，則針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱。例如 - P3。通常是字母+數位碼
size	string	SKU 大小。當名稱欄位是階層和其他一些值的組合時，這會是獨立程序代碼。
tier	SkuTier	如果服務有一個以上的層級，但在PUT上則不需要此欄位，才能由資源提供者實作。

SkuTier

如果服務有一個以上的層級，但在PUT上則不需要此欄位，才能由資源提供者實作。

名稱	類型	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserAssignedIdentity

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string	指派之身分識別的用戶端標識碼。
principalId	string	指派之身分識別的主體標識碼。