Sdílet prostřednictvím


Batch Deployments - List

Vypíše nasazení odvození služby Batch v pracovním prostoru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpointName
path True

string

Název koncového bodu

resourceGroupName
path True

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

subscriptionId
path True

string

ID cílového předplatného.

workspaceName
path True

string

Název pracovního prostoru Azure Machine Learning

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

$orderBy
query

string

Řazení seznamu

$skip
query

string

Token pokračování pro stránkování

$top
query

integer

int32

Začátek seznamu

Odpovědi

Name Typ Description
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Úspěch

Other Status Codes

ErrorResponse

Chyba

Příklady

List Workspace Batch Deployment.

Ukázkový požadavek

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

Ukázková odpověď

{
  "value": [
    {
      "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": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": 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
      }
    }
  ],
  "nextLink": "string"
}

Definice

Name Description
BatchDeployment

Nastavení odvození služby Batch pro každé nasazení

BatchDeploymentConfigurationType

Výčtové typy vlastností pro dávkové nasazení.

BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult

Stránkovaný seznam entit BatchDeployment.

BatchLoggingLevel

Protokolování podrobností pro dávkové odvozování Zvýšení pořadí podrobností pro protokolování je: Upozornění, Informace a Ladění. Výchozí hodnota je Informace.

BatchOutputAction

Výčet k určení způsobu zpracování výstupu dávkového odvozování

BatchPipelineComponentDeploymentConfiguration

Vlastnosti pro nasazení komponenty kanálu Batch

BatchRetrySettings

Nastavení opakování pro operaci dávkového odvozování

CodeConfiguration

Konfigurace pro bodovací prostředek kódu

createdByType

Typ identity, která prostředek vytvořila.

DataPathAssetReference

Odkaz na prostředek prostřednictvím jeho cesty v úložišti dat.

DeploymentProvisioningState

Možné hodnoty pro DeploymentProvisioningState.

DeploymentResourceConfiguration
ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

IdAssetReference

Odkaz na prostředek prostřednictvím ID prostředku ARM.

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

OutputPathAssetReference

Odkaz na prostředek prostřednictvím jeho cesty ve výstupu úlohy.

ReferenceType

Výčet určující, která referenční metoda se má použít pro prostředek.

Sku

Definice modelu prostředků představující skladovou položku

SkuTier

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

BatchDeployment

Nastavení odvození služby Batch pro každé nasazení

Name Typ Default value Description
codeConfiguration

CodeConfiguration

Konfigurace kódu pro nasazení koncového bodu

compute

string

Cílový výpočetní objekt pro operaci dávkového odvozování

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

Vlastnosti relevantní pro různé typy nasazení

description

string

Popis nasazení koncového bodu

environmentId

string

ID prostředku ARM nebo AssetId specifikace prostředí pro nasazení koncového bodu

environmentVariables

object

Konfigurace proměnných prostředí pro nasazení

errorThreshold

integer

-1

Prahová hodnota chyby, pokud počet chyb pro celý vstup překročí tuto hodnotu, přeruší se odvozování dávky. Rozsah je [-1, int. MaxValue]. U FileDataset je tato hodnota počet selhání souborů. Pro TabularDataset je tato hodnota počet selhání záznamů. Pokud je nastavená hodnota -1 (dolní mez), budou všechna selhání během dávkového odvozu ignorována.

loggingLevel

BatchLoggingLevel

Info

Úroveň protokolování pro operaci odvozování dávek

maxConcurrencyPerInstance

integer

1

Určuje maximální počet paralelismu na instanci.

miniBatchSize

integer

10

Velikost minidávkové dávky předané každému vyvolání dávky U FileDataset se jedná o počet souborů na minidávku. U TabularDataset se jedná o velikost záznamů v bajtech na minidávku.

model AssetReferenceBase:

Odkaz na prostředek modelu pro nasazení koncového bodu

outputAction

BatchOutputAction

AppendRow

Určuje, jak bude výstup uspořádán.

outputFileName

string

predictions.csv

Přizpůsobený název výstupního souboru pro append_row výstupní akci

properties

object

Slovník vlastností Vlastnosti lze přidat, ale ne odebrat nebo změnit.

provisioningState

DeploymentProvisioningState

Stav zřizování pro nasazení koncového bodu

resources

DeploymentResourceConfiguration

Označuje konfiguraci výpočetních prostředků pro úlohu. Pokud není k dispozici, nastaví se výchozí hodnoty definované v ResourceConfiguration.

retrySettings

BatchRetrySettings

Zopakujte nastavení pro operaci odvozování dávky. Pokud není zadaný, použije se výchozí nastavení definované ve službě BatchRetrySettings.

BatchDeploymentConfigurationType

Výčtové typy vlastností pro dávkové nasazení.

Name Typ Description
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

kind

string

Metadata používaná portálem, nástroji atd. k vykreslení různých prostředí uživatelského rozhraní pro prostředky stejného typu.

location

string

Geografické umístění, ve kterém se nachází zdroj

name

string

Název prostředku

properties

BatchDeployment

[Povinné] Další atributy entity.

sku

Sku

Podrobnosti skladové položky vyžadované pro kontrakt ARM pro automatické škálování

systemData

systemData

Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy

tags

object

Značky prostředků

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BatchDeploymentTrackedResourceArmPaginatedResult

Stránkovaný seznam entit BatchDeployment.

Name Typ Description
nextLink

string

Odkaz na další stránku objektů BatchDeployment. Pokud je hodnota null, nejsou k dispozici žádné další stránky.

value

BatchDeploymentTrackedResource[]

Pole objektů typu BatchDeployment.

BatchLoggingLevel

Protokolování podrobností pro dávkové odvozování Zvýšení pořadí podrobností pro protokolování je: Upozornění, Informace a Ladění. Výchozí hodnota je Informace.

Name Typ Description
Debug

string

Info

string

Warning

string

BatchOutputAction

Výčet k určení způsobu zpracování výstupu dávkového odvozování

Name Typ Description
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

Vlastnosti pro nasazení komponenty kanálu Batch

Name Typ Description
componentId

IdAssetReference

ID ARM komponenty, která se má spustit.

deploymentConfigurationType string:

PipelineComponent

[Povinné] Typ nasazení

description

string

Popis, který se použije pro úlohu.

settings

object

Nastavení doby běhu pro úlohu kanálu

tags

object

Značky, které se použijí pro úlohu.

BatchRetrySettings

Nastavení opakování pro operaci dávkového odvozování

Name Typ Default value Description
maxRetries

integer

3

Maximální počet opakování pro minidávku

timeout

string

PT30S

Časový limit vyvolání pro minidávku ve formátu ISO 8601.

CodeConfiguration

Konfigurace pro bodovací prostředek kódu

Name Typ Description
codeId

string

ID prostředku ARM prostředku kódu

scoringScript

string

[Povinné] Skript, který se má spustit při spuštění. Např. "score.py"

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

Odkaz na prostředek prostřednictvím jeho cesty v úložišti dat.

Name Typ Description
datastoreId

string

ID prostředku ARM úložiště dat, ve kterém se prostředek nachází.

path

string

Cesta k souboru nebo adresáři v úložišti dat.

referenceType string:

DataPath

[Povinné] Určuje typ odkazu na prostředek.

DeploymentProvisioningState

Možné hodnoty pro DeploymentProvisioningState.

Name Typ Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

Name Typ Default value Description
instanceCount

integer

1

Volitelný počet instancí nebo uzlů používaných cílovým výpočetním objektem.

instanceType

string

Volitelný typ virtuálního počítače, který je podporovaný cílovým výpočetním objektem.

properties

object

Taška s dalšími vlastnostmi.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

IdAssetReference

Odkaz na prostředek prostřednictvím ID prostředku ARM.

Name Typ Description
assetId

string

[Povinné] ID prostředku ARM prostředku

referenceType string:

Id

[Povinné] Určuje typ odkazu na prostředek.

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Name Typ Description
principalId

string

ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

tenantId

string

ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

type

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

identity User-Assigned
Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

Odkaz na prostředek prostřednictvím jeho cesty ve výstupu úlohy.

Name Typ Description
jobId

string

ID prostředku ARM úlohy

path

string

Cesta k souboru nebo adresáři ve výstupu úlohy.

referenceType string:

OutputPath

[Povinné] Určuje typ odkazu na prostředek.

ReferenceType

Výčet určující, která referenční metoda se má použít pro prostředek.

Name Typ Description
DataPath

string

Id

string

OutputPath

string

Sku

Definice modelu prostředků představující skladovou položku

Name Typ Description
capacity

integer

Pokud skladová položka podporuje horizontální navýšení/snížení kapacity, měla by být zahrnuta celá čísla kapacity. Pokud není pro prostředek možné horizontální navýšení kapacity nebo jeho snížení kapacity, může se tento parametr vynechat.

family

string

Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.

name

string

Název skladové položky. Ex - P3. Obvykle se jedná o písmeno+číslo.

size

string

Velikost skladové položky. Pokud je pole název kombinací vrstvy a jiné hodnoty, jedná se o samostatný kód.

tier

SkuTier

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

SkuTier

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

Name Typ Description
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Name Typ Description
clientId

string

ID klienta přiřazené identity.

principalId

string

ID objektu zabezpečení přiřazené identity.