Batch Deployments - List

Başvuru

Service:: Machine Learning

API Version:: 2024-04-01

Çalışma alanında Batch çıkarım dağıtımlarını Listeler.

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

With optional parameters:

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}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpointName	path	True	string	Uç nokta adı
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
workspaceName	path	True	string	Azure Machine Learning çalışma alanının adı. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
$orderBy	query		string	Listenin sırası.
$skip	query		string	Sayfalandırma için devamlılık belirteci.
$top	query		integer int32	Listenin başı.

Yanıtlar

Name	Tür	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Başarılı
Other Status Codes	ErrorResponse	Hata

Örnekler

List 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?api-version=2024-04-01&$orderBy=string&$top=1

Sample Response

Status code:: 200

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

Tanımlar

Name	Description
BatchDeployment	Dağıtım başına toplu çıkarım ayarları.
BatchDeploymentConfigurationType	Toplu dağıtımlar için numaralandırılmış özellik türleri.
BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult	BatchDeployment varlıklarının sayfalandırılmış listesi.
BatchLoggingLevel	Toplu çıkarım için günlük ayrıntısı. Günlüğe kaydetme için ayrıntı sırasını artırma: Uyarı, Bilgi ve Hata Ayıklama. Varsayılan değer Bilgi'dir.
BatchOutputAction	Toplu çıkarım işleminin çıkışı nasıl işleyeceğini belirlemek için sabit listesi
BatchPipelineComponentDeploymentConfiguration	Batch İşlem Hattı Bileşeni Dağıtımı özellikleri.
BatchRetrySettings	Toplu çıkarım işlemi için ayarları yeniden deneyin.
CodeConfiguration	Puanlama kodu varlığı için yapılandırma.
createdByType	Kaynağı oluşturan kimliğin türü.
DataPathAssetReference	Veri deposundaki yolu aracılığıyla bir varlığa başvuru.
DeploymentProvisioningState	DeploymentProvisioningState için olası değerler.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
IdAssetReference	ARM kaynak kimliği aracılığıyla bir varlığa başvuru.
ManagedServiceIdentity	Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler)
ManagedServiceIdentityType	Yönetilen hizmet kimliğinin türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
OutputPathAssetReference	bir iş çıkışındaki yolu aracılığıyla bir varlığa başvuru.
ReferenceType	Bir varlık için hangi başvuru yönteminin kullanılacağını belirlemek için sabit listesi.
Sku	SKU'yu temsil eden kaynak modeli tanımı
SkuTier	Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserAssignedIdentity	Kullanıcı tarafından atanan kimlik özellikleri

BatchDeployment

Dağıtım başına toplu çıkarım ayarları.

Name	Tür	Varsayılan değer	Description
codeConfiguration	CodeConfiguration		Uç nokta dağıtımı için kod yapılandırması.
compute	string		Toplu çıkarım işlemi için işlem hedefi.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Farklı dağıtım türleriyle ilgili özellikler.
description	string		Uç nokta dağıtımının açıklaması.
environmentId	string		Uç nokta dağıtımı için ortam belirtiminin ARM kaynak kimliği veya AssetId değeri.
environmentVariables	object		Dağıtım için ortam değişkenleri yapılandırması.
errorThreshold	integer	-1	Hata eşiği, girişin tamamı için hata sayısı bu değerin üzerine çıkarsa toplu çıkarım durdurulacaktır. Aralık [-1, int. MaxValue]. FileDataset için bu değer, dosya hatalarının sayısıdır. TabularDataset için bu değer kayıt hatalarının sayısıdır. -1 (alt sınır) olarak ayarlanırsa, toplu çıkarım sırasındaki tüm hatalar yoksayılır.
loggingLevel	BatchLoggingLevel	Info	Toplu çıkarım işlemi için günlüğe kaydetme düzeyi.
maxConcurrencyPerInstance	integer	1	Örnek başına en fazla paralellik sayısını gösterir.
miniBatchSize	integer	10	Her toplu çağrıya geçirilen mini toplu iş boyutu. FileDataset için bu, mini toplu iş başına dosya sayısıdır. TabularDataset için bu, mini toplu iş başına bayt cinsinden kayıtların boyutudur.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Uç nokta dağıtımı için model varlığına başvuru.
outputAction	BatchOutputAction	AppendRow	Çıkışın nasıl düzenileceğini gösterir.
outputFileName	string	predictions.csv	append_row çıktı eylemi için özelleştirilmiş çıktı dosyası adı.
properties	object		Özellik sözlüğü. Özellikler eklenebilir, ancak kaldırılamaz veya değiştirilemez.
provisioningState	DeploymentProvisioningState		Uç nokta dağıtımı için sağlama durumu.
resources	DeploymentResourceConfiguration		İş için işlem yapılandırmasını gösterir. Sağlanmazsa, varsayılan olarak ResourceConfiguration'da tanımlanan varsayılan değerlere ayarlanır.
retrySettings	BatchRetrySettings		Toplu çıkarım işlemi için Ayarları yeniden deneyin. Sağlanmazsa, BatchRetrySettings'te tanımlanan varsayılan değerleri varsayılan olarak ayarlar.

BatchDeploymentConfigurationType

Toplu dağıtımlar için numaralandırılmış özellik türleri.

Name	Tür	Description
Model	string
PipelineComponent	string

BatchDeploymentTrackedResource

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler)
kind	string	Portal/araçlar/vb. tarafından aynı türdeki kaynaklar için farklı UX deneyimlerini işlemek için kullanılan meta veriler.
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties	BatchDeployment	[Gerekli] Varlığın ek öznitelikleri.
sku	Sku	Otomatik Ölçeklendirme için ARM sözleşmesi için gereken SKU ayrıntıları.
systemData	systemData	Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BatchDeploymentTrackedResourceArmPaginatedResult

BatchDeployment varlıklarının sayfalandırılmış listesi.

Name	Tür	Description
nextLink	string	BatchDeployment nesnelerinin sonraki sayfasının bağlantısı. Null ise, başka sayfa yoktur.
value	BatchDeploymentTrackedResource[]	BatchDeployment türünde bir nesne dizisi.

BatchLoggingLevel

Toplu çıkarım için günlük ayrıntısı. Günlüğe kaydetme için ayrıntı sırasını artırma: Uyarı, Bilgi ve Hata Ayıklama. Varsayılan değer Bilgi'dir.

Name	Tür	Description
Debug	string
Info	string
Warning	string

BatchOutputAction

Toplu çıkarım işleminin çıkışı nasıl işleyeceğini belirlemek için sabit listesi

Name	Tür	Description
AppendRow	string
SummaryOnly	string

BatchPipelineComponentDeploymentConfiguration

Batch İşlem Hattı Bileşeni Dağıtımı özellikleri.

Name	Tür	Description
componentId	IdAssetReference	Çalıştırılacak bileşenin ARM kimliği.
deploymentConfigurationType	string: PipelineComponent	[Gerekli] Dağıtımın türü
description	string	İşe uygulanacak açıklama.
settings	object	İşlem hattı işi için çalışma zamanı ayarları.
tags	object	İşe uygulanacak etiketler.

BatchRetrySettings

Toplu çıkarım işlemi için ayarları yeniden deneyin.

Name	Tür	Varsayılan değer	Description
maxRetries	integer	3	Mini toplu iş için en fazla yeniden deneme sayısı
timeout	string	PT30S	ISO 8601 biçiminde bir mini toplu iş için çağırma zaman aşımı.

CodeConfiguration

Puanlama kodu varlığı için yapılandırma.

Name	Tür	Description
codeId	string	Kod varlığının ARM kaynak kimliği.
scoringScript	string	[Gerekli] Başlangıçta yürütülecek betik. Örneğin "score.py"

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataPathAssetReference

Veri deposundaki yolu aracılığıyla bir varlığa başvuru.

Name	Tür	Description
datastoreId	string	Varlığın bulunduğu veri deposunun ARM kaynak kimliği.
path	string	Veri deposundaki dosyanın/dizinin yolu.
referenceType	string: DataPath	[Gerekli] Varlık başvurusunun türünü belirtir.

DeploymentProvisioningState

DeploymentProvisioningState için olası değerler.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Scaling	string
Succeeded	string
Updating	string

DeploymentResourceConfiguration

Name	Tür	Varsayılan değer	Description
instanceCount	integer	1	İşlem hedefi tarafından kullanılan isteğe bağlı örnek veya düğüm sayısı.
instanceType	string		İşlem hedefi tarafından desteklenen isteğe bağlı VM türü.
properties	object		Ek özellikler çantası.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

IdAssetReference

ARM kaynak kimliği aracılığıyla bir varlığa başvuru.

Name	Tür	Description
assetId	string	[Gerekli] Varlığın ARM kaynak kimliği.
referenceType	string: Id	[Gerekli] Varlık başvurusunun türünü belirtir.

ManagedServiceIdentity

Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler)

Name	Tür	Description
principalId	string	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	ManagedServiceIdentityType	Yönetilen hizmet kimliğinin türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
userAssignedIdentities	<string, UserAssignedIdentity>	kimlikleri User-Assigned Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir.

ManagedServiceIdentityType

Yönetilen hizmet kimliğinin türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OutputPathAssetReference

bir iş çıkışındaki yolu aracılığıyla bir varlığa başvuru.

Name	Tür	Description
jobId	string	İşin ARM kaynak kimliği.
path	string	İş çıktısında dosyanın/dizinin yolu.
referenceType	string: OutputPath	[Gerekli] Varlık başvurusunun türünü belirtir.

ReferenceType

Bir varlık için hangi başvuru yönteminin kullanılacağını belirlemek için sabit listesi.

Name	Tür	Description
DataPath	string
Id	string
OutputPath	string

Sku

SKU'yu temsil eden kaynak modeli tanımı

Name	Tür	Description
capacity	integer	SKU ölçeği genişletmeyi/daraltma işlemini destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir.
family	string	Hizmetin aynı SKU için farklı nesil donanımları varsa, bu burada yakalanabilir.
name	string	SKU'nun adı. Ex - P3. Bu genellikle letter+number kodudur
size	string	SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olur.
tier	SkuTier	Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

SkuTier

Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

Name	Tür	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserAssignedIdentity

Kullanıcı tarafından atanan kimlik özellikleri

Name	Tür	Description
clientId	string	Atanan kimliğin istemci kimliği.
principalId	string	Atanan kimliğin asıl kimliği.