Batch Deployments - Get

Referencia

Service:: Machine Learning

API Version:: 2024-04-01

Lekéri a kötegelt következtetés üzembe helyezését azonosító alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
deploymentName	path	True	string	A Batch üzemelő példányainak azonosítója.
endpointName	path	True	string	Végpont neve
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ó.

Válaszok

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

Példák

Get Workspace Batch Deployment.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments/testDeploymentName?api-version=2024-04-01

Sample Response

Status code:: 200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "codeConfiguration": {
      "codeId": "string",
      "scoringScript": "string"
    },
    "environmentId": "string",
    "environmentVariables": {
      "string": "string"
    },
    "compute": "string",
    "errorThreshold": 1,
    "retrySettings": {
      "maxRetries": 1,
      "timeout": "PT5M"
    },
    "miniBatchSize": 1,
    "loggingLevel": "Info",
    "model": {
      "referenceType": "Id",
      "assetId": "string"
    },
    "maxConcurrencyPerInstance": 1,
    "outputAction": "SummaryOnly",
    "outputFileName": "string",
    "resources": {
      "instanceCount": 1,
      "instanceType": "string",
      "properties": {
        "string": {
          "843c2bb4-e5f1-4267-98c8-ba22a99dbb00": null
        }
      }
    },
    "provisioningState": "Creating"
  },
  "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
  }
}

Definíciók

Name	Description
BatchDeployment	Batch-következtetési beállítások üzemelő példányonként.
BatchDeploymentConfigurationType	A kötegtelepítések enumerált tulajdonságtípusai.
BatchDeploymentTrackedResource
BatchLoggingLevel	Napló részletessége kötegelt következtetéshez. A naplózás részletességi sorrendjének növelése: Figyelmeztetés, Információ és Hibakeresés. Az alapértelmezett érték az Információ.
BatchOutputAction	Enumerálás annak meghatározásához, hogy a kötegelt következtetés hogyan kezeli a kimenetet
BatchPipelineComponentDeploymentConfiguration	Batch Pipeline-összetevő üzembe helyezésének tulajdonságai.
BatchRetrySettings	Kötegelt következtetési művelet beállításainak újrapróbálása.
CodeConfiguration	Pontozókód-objektum konfigurációja.
createdByType	Az erőforrást létrehozó identitás típusa.
DataPathAssetReference	Hivatkozás egy adategységre az adattárban lévő elérési útján keresztül.
DeploymentProvisioningState	A DeploymentProvisioningState lehetséges értékei.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
IdAssetReference	Hivatkozás egy objektumra az ARM-erőforrás-azonosítóján keresztül.
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).
OutputPathAssetReference	Hivatkozás egy objektumra a feladat kimenetében lévő elérési útján keresztül.
ReferenceType	Enumerálás az objektumhoz használandó referenciametódus meghatározásához.
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

BatchDeployment

Batch-következtetési beállítások üzemelő példányonként.

Name	Típus	Alapértelmezett érték	Description
codeConfiguration	CodeConfiguration		Kódkonfiguráció a végpont üzembe helyezéséhez.
compute	string		Számítási cél kötegelt következtetési művelethez.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		A különböző üzembehelyezési típusokhoz kapcsolódó tulajdonságok.
description	string		A végpont üzembe helyezésének leírása.
environmentId	string		A végpont üzembe helyezésének környezeti specifikációjának ARM-erőforrás-azonosítója vagy AssetId azonosítója.
environmentVariables	object		Környezeti változók konfigurálása az üzembe helyezéshez.
errorThreshold	integer	-1	Hibaküszöb, ha a teljes bemenet hibaszáma meghaladja ezt az értéket, a kötegkövetkeztetés megszakad. A tartomány [-1, int. MaxValue]. A FileDataset esetében ez az érték a fájlhibák száma. A TabularDataset esetében ez az érték a rekordhibák száma. Ha -1 (az alsó határ) értékre van állítva, a kötegkövetkezési hibák figyelmen kívül lesznek hagyva.
loggingLevel	BatchLoggingLevel	Info	Naplózási szint a kötegelt következtetési művelethez.
maxConcurrencyPerInstance	integer	1	A párhuzamosság példányonkénti maximális számát jelzi.
miniBatchSize	integer	10	Az egyes köteghívások számára átadott mini köteg mérete. A FileDataset esetében ez a fájlok száma minikötegenként. A TabularDataset esetében ez a rekordok mérete bájtban, minikötegenként.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Hivatkozás a végpont üzembe helyezéséhez használt modellobjektumra.
outputAction	BatchOutputAction	AppendRow	A kimenet rendszerezését jelzi.
outputFileName	string	predictions.csv	A kimeneti művelethez testre szabott kimeneti fájlnév append_row.
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	DeploymentProvisioningState		A végpont üzembe helyezésének kiépítési állapota.
resources	DeploymentResourceConfiguration		A feladat számítási konfigurációját jelzi. Ha nincs megadva, alapértelmezés szerint a ResourceConfigurationban meghatározott alapértelmezett értékek lesznek megadva.
retrySettings	BatchRetrySettings		Próbálkozzon újra a kötegelt következtetési művelet beállításaival. Ha nincs megadva, alapértelmezés szerint a BatchRetrySettingsban meghatározott alapértelmezett értékek lesznek megadva.

BatchDeploymentConfigurationType

A kötegtelepítések enumerált tulajdonságtípusai.

Name	Típus	Description
Model	string
PipelineComponent	string

BatchDeploymentTrackedResource

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	BatchDeployment	[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"

BatchLoggingLevel

Napló részletessége kötegelt következtetéshez. A naplózás részletességi sorrendjének növelése: Figyelmeztetés, Információ és Hibakeresés. Az alapértelmezett érték az Információ.

Name	Típus	Description
Debug	string
Info	string
Warning	string

BatchOutputAction

Enumerálás annak meghatározásához, hogy a kötegelt következtetés hogyan kezeli a kimenetet

Name	Típus	Description
AppendRow	string
SummaryOnly	string

BatchPipelineComponentDeploymentConfiguration

Batch Pipeline-összetevő üzembe helyezésének tulajdonságai.

Name	Típus	Description
componentId	IdAssetReference	A futtatni kívánt összetevő ARM-azonosítója.
deploymentConfigurationType	string: PipelineComponent	[Kötelező] Az üzembe helyezés típusa
description	string	A feladatra alkalmazott leírás.
settings	object	A folyamatfeladat futásidejű beállításai.
tags	object	A feladatra alkalmazott címkék.

BatchRetrySettings

Kötegelt következtetési művelet beállításainak újrapróbálása.

Name	Típus	Alapértelmezett érték	Description
maxRetries	integer	3	Minimális kötegek újrapróbálkozásainak maximális száma
timeout	string	PT30S	Egy mini köteg meghívási időtúllépése ISO 8601 formátumban.

CodeConfiguration

Pontozókód-objektum konfigurációja.

Name	Típus	Description
codeId	string	A kódobjektum ARM-erőforrás-azonosítója.
scoringScript	string	[Kötelező] Az indításkor végrehajtandó szkript. például: "score.py"

createdByType

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

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

DataPathAssetReference

Hivatkozás egy adategységre az adattárban lévő elérési útján keresztül.

Name	Típus	Description
datastoreId	string	Annak az adattárnak az ARM-erőforrás-azonosítója, ahol az adategység található.
path	string	Az adattárban található fájl/könyvtár elérési útja.
referenceType	string: DataPath	[Kötelező] Megadja az eszközhivatkozás típusát.

DeploymentProvisioningState

A DeploymentProvisioningState lehetséges értékei.

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

DeploymentResourceConfiguration

Name	Típus	Alapértelmezett érték	Description
instanceCount	integer	1	A számítási cél által használt példányok vagy csomópontok opcionális száma.
instanceType	string		A számítási cél által támogatott virtuális gép választható típusa.
properties	object		További tulajdonságok táska.

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.

IdAssetReference

Hivatkozás egy objektumra az ARM-erőforrás-azonosítóján keresztül.

Name	Típus	Description
assetId	string	[Kötelező] Az objektum ARM-erőforrás-azonosítója.
referenceType	string: Id	[Kötelező] Megadja az eszközhivatkozás típusát.

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

OutputPathAssetReference

Hivatkozás egy objektumra a feladat kimenetében lévő elérési útján keresztül.

Name	Típus	Description
jobId	string	A feladat ARM-erőforrás-azonosítója.
path	string	A feladat kimenetében lévő fájl/könyvtár elérési útja.
referenceType	string: OutputPath	[Kötelező] Megadja az eszközhivatkozás típusát.

ReferenceType

Enumerálás az objektumhoz használandó referenciametódus meghatározásához.

Name	Típus	Description
DataPath	string
Id	string
OutputPath	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