Online Endpoints - List

Referencia

Service:: Machine Learning

API Version:: 2024-04-01

Online végpontok listázása.

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-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
workspaceName	path	True	string	Az Azure Machine Learning-munkaterület neve. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	A művelethez használandó API-verzió.
$skip	query		string	Folytatási jogkivonat a tördeléshez.
computeType	query		EndpointComputeType	EndpointComputeType, amely alapján szűrni kell.
count	query		integer int32	Az eredményoldalon lekérendő végpontok száma.
name	query		string	A végpont neve.
orderBy	query		OrderString	A válasz megrendelésének lehetősége.
properties	query		string	A visszaadott modellek szűrésére szolgáló tulajdonságok halmaza. Ez a tulajdonságkulcs és/vagy a properties key=value vesszővel tagolt sztringje, például: propKey1,propKey2,propKey3=value3 .
tags	query		string	Címkék készlete, amelyekkel szűrni lehet a visszaadott modelleket. Ez a címkekulcs vagy a tags key=value vesszővel tagolt sztringje. Példa: tagKey1,tagKey2,tagKey3=value3 .

Válaszok

Name	Típus	Description
200 OK	OnlineEndpointTrackedResourceArmPaginatedResult	Siker
Other Status Codes	ErrorResponse	Hiba

Példák

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
EndpointAuthKeys	Végponthitelesítés kulcsai.
EndpointAuthMode	Enumerálás a végponthitelesítési mód meghatározásához.
EndpointComputeType	Enumerálás a végpont számítási típusának meghatározásához.
EndpointProvisioningState	A végpontkiépítés állapota.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
ManagedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa (ahol a SystemAssigned és a UserAssigned típus egyaránt engedélyezett).
OnlineEndpoint	Online végpont konfigurálása
OnlineEndpointTrackedResource
OnlineEndpointTrackedResourceArmPaginatedResult	Az OnlineEndpoint-entitások lapszámozott listája.
OrderString
PublicNetworkAccessType	Enumerálás annak megállapításához, hogy a PublicNetworkAccess engedélyezve vagy letiltva van-e.
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitás tulajdonságai

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndpointAuthKeys

Végponthitelesítés kulcsai.

Name	Típus	Description
primaryKey	string	Az elsődleges kulcs.
secondaryKey	string	A másodlagos kulcs.

EndpointAuthMode

Enumerálás a végponthitelesítési mód meghatározásához.

Name	Típus	Description
AADToken	string
AMLToken	string
Key	string

EndpointComputeType

Enumerálás a végpont számítási típusának meghatározásához.

Name	Típus	Description
AzureMLCompute	string
Kubernetes	string
Managed	string

EndpointProvisioningState

A végpontkiépítés állapota.

Name	Típus	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ManagedServiceIdentity

Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)

Name	Típus	Description
principalId	string	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ManagedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa (ahol a SystemAssigned és a UserAssigned típus egyaránt engedélyezett).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned-identitások Az erőforráshoz társított felhasználó által hozzárendelt identitások halmaza. A userAssignedIdentities szótárkulcsok ARM-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótárértékek üres objektumok ({}) lehetnek a kérésekben.

ManagedServiceIdentityType

A felügyeltszolgáltatás-identitás típusa (ahol a SystemAssigned és a UserAssigned típus egyaránt engedélyezett).

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OnlineEndpoint

Online végpont konfigurálása

Name	Típus	Alapértelmezett érték	Description
authMode	EndpointAuthMode		[Kötelező] Kulcsalapú hitelesítéshez használja a "Kulcs" és az "AMLToken" lehetőséget az Azure Machine Learning tokenalapú hitelesítéséhez. A kulcs nem jár le, de az "AMLToken" igen.
compute	string		Ha létezik, a számítás ARM-erőforrás-azonosítója. választható
description	string		A következtetési végpont leírása.
keys	EndpointAuthKeys		EndpointAuthKeys a végponton való kezdeti beállításhoz. Ezt a tulajdonságot a rendszer mindig null értékként adja vissza. Az AuthKey értékeket a ListKeys API használatával kell lekérni.
mirrorTraffic	object		Az egyes üzemelő példányok felé tükrözendő forgalom százalékos aránya a visszaadott pontozás használata nélkül. A forgalmi értékeknek a lehető legnagyobb 50 értéket kell összeadnia.
properties	object		Tulajdonságszótár. A tulajdonságok hozzáadhatók, de nem távolíthatók el és nem módosíthatók.
provisioningState	EndpointProvisioningState		A végpont kiépítési állapota.
publicNetworkAccess	PublicNetworkAccessType	Enabled	Állítsa "Engedélyezve" értékre olyan végpontok esetében, amelyeknek engedélyeznie kell a nyilvános hozzáférést, ha Private Link engedélyezve van.
scoringUri	string		Végpont URI-ja.
swaggerUri	string		Végpont Swagger URI-ja.
traffic	object		A végpont és az egyes üzemelő példányok közötti forgalom százalékos aránya. A forgalmi értékeknek 100-nak kell összeadnia.

OnlineEndpointTrackedResource

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
kind	string	A portál/eszközök/stb. által az azonos típusú erőforrások különböző felhasználói felületi élményeinek megjelenítéséhez használt metaadatok.
location	string	A földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties	OnlineEndpoint	[Kötelező] Az entitás további attribútumai.
sku	Sku	Az automatikus skálázáshoz szükséges ARM-szerződés termékváltozatának részletei.
systemData	systemData	Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatokat.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

OnlineEndpointTrackedResourceArmPaginatedResult

Az OnlineEndpoint-entitások lapszámozott listája.

Name	Típus	Description
nextLink	string	Az OnlineEndpoint-objektumok következő lapjára mutató hivatkozás. Ha null, nincsenek további lapok.
value	OnlineEndpointTrackedResource[]	OnlineEndpoint típusú objektumok tömbje.

OrderString

Name	Típus	Description
CreatedAtAsc	string
CreatedAtDesc	string
UpdatedAtAsc	string
UpdatedAtDesc	string

PublicNetworkAccessType

Enumerálás annak megállapításához, hogy a PublicNetworkAccess engedélyezve vagy letiltva van-e.

Name	Típus	Description
Disabled	string
Enabled	string

Sku

A termékváltozatot képviselő erőforrásmodell-definíció

Name	Típus	Description
capacity	integer	Ha a termékváltozat támogatja a fel- és leskálázást, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforráshoz nem lehet vertikális felskálázást/beskálázást végezni, ez kihagyható.
family	string	Ha a szolgáltatás eltérő hardvergenerációval rendelkezik ugyanahhoz a termékváltozathoz, akkor az itt rögzíthető.
name	string	A termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuTier

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Name	Típus	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Felhasználó által hozzárendelt identitás tulajdonságai

Name	Típus	Description
clientId	string	A hozzárendelt identitás ügyfél-azonosítója.
principalId	string	A hozzárendelt identitás egyszerű azonosítója.

Share via