@azure/arm-batch package

類別

BatchManagementClient

介面

ActivateApplicationPackageParameters

啟用應用程式封裝的參數。

Application

包含 Batch 帳戶中應用程式的相關信息。

ApplicationCreateOptionalParams

選用參數。

ApplicationDeleteOptionalParams

選用參數。

ApplicationGetOptionalParams

選用參數。

ApplicationListNextOptionalParams

選用參數。

ApplicationListOptionalParams

選用參數。

ApplicationOperations

表示 ApplicationOperations 的介面。

ApplicationPackage

應用程式套件,表示特定版本的應用程式。

ApplicationPackageActivateOptionalParams

選用參數。

ApplicationPackageCreateOptionalParams

選用參數。

ApplicationPackageDeleteOptionalParams

選用參數。

ApplicationPackageGetOptionalParams

選用參數。

ApplicationPackageListNextOptionalParams

選用參數。

ApplicationPackageListOptionalParams

選用參數。

ApplicationPackageOperations

表示 ApplicationPackageOperations 的介面。

ApplicationPackageReference

連結到批次帳戶內的應用程式套件

ApplicationUpdateOptionalParams

選用參數。

AutoScaleRun

集區自動調整公式執行的結果和錯誤。

AutoScaleRunError

自動調整集區時所發生的錯誤。

AutoScaleSettings

集區的自動調整設定。

AutoStorageBaseProperties

與自動記憶體帳戶相關的屬性。

AutoStorageProperties

包含與 Batch 帳戶相關聯的自動記憶體帳戶相關信息。

AutoUserSpecification

指定在 Batch 服務上執行工作的自動用戶參數。

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

AzureBlobFileSystemConfiguration

用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。

AzureFileShareConfiguration

用來連線到 Azure Fileshare 的資訊。

BatchAccount

包含 Azure Batch 帳戶的相關信息。

BatchAccountCreateHeaders

定義BatchAccount_create作業的標頭。

BatchAccountCreateOptionalParams

選用參數。

BatchAccountCreateParameters

提供給建立作業的參數。

BatchAccountDeleteHeaders

定義BatchAccount_delete作業的標頭。

BatchAccountDeleteOptionalParams

選用參數。

BatchAccountGetDetectorOptionalParams

選用參數。

BatchAccountGetKeysOptionalParams

選用參數。

BatchAccountGetOptionalParams

選用參數。

BatchAccountIdentity

如果已設定,Batch 帳戶的身分識別。 當使用者將 『Microsoft.KeyVault』 指定為其 Batch 帳戶加密組態,或選取為自動記憶體驗證模式時 ManagedIdentity ,就會使用此功能。

BatchAccountKeys

一組 Azure Batch 帳戶金鑰。

BatchAccountListByResourceGroupNextOptionalParams

選用參數。

BatchAccountListByResourceGroupOptionalParams

選用參數。

BatchAccountListDetectorsNextOptionalParams

選用參數。

BatchAccountListDetectorsOptionalParams

選用參數。

BatchAccountListNextOptionalParams

選用參數。

BatchAccountListOptionalParams

選用參數。

BatchAccountListOutboundNetworkDependenciesEndpointsNextOptionalParams

選用參數。

BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams

選用參數。

BatchAccountListResult

List 作業所傳回的值。

BatchAccountOperations

表示 BatchAccountOperations 的介面。

BatchAccountRegenerateKeyOptionalParams

選用參數。

BatchAccountRegenerateKeyParameters

提供給 RegenerateKey 作業的參數。

BatchAccountSynchronizeAutoStorageKeysOptionalParams

選用參數。

BatchAccountUpdateOptionalParams

選用參數。

BatchAccountUpdateParameters

更新 Azure Batch 帳戶的參數。

BatchLocationQuota

與特定訂用帳戶的 Batch 區域相關聯的配額。

BatchManagementClientOptionalParams

選用參數。

BatchPoolIdentity

如果已設定,Batch 集區的身分識別。 如果在更新現有集區期間更新集區身分識別,只有集區壓縮為0之後所建立的新 VM 才會有更新的身分識別

Certificate

包含憑證的相關信息。

CertificateBaseProperties

基底憑證屬性。

CertificateCancelDeletionHeaders

定義Certificate_cancelDeletion作業的標頭。

CertificateCancelDeletionOptionalParams

選用參數。

CertificateCreateHeaders

定義Certificate_create作業的標頭。

CertificateCreateOptionalParams

選用參數。

CertificateCreateOrUpdateParameters

包含憑證的相關信息。

CertificateCreateOrUpdateProperties

建立作業的憑證屬性

CertificateDeleteHeaders

定義Certificate_delete作業的標頭。

CertificateDeleteOptionalParams

選用參數。

CertificateGetHeaders

定義Certificate_get作業的標頭。

CertificateGetOptionalParams

選用參數。

CertificateListByBatchAccountNextOptionalParams

選用參數。

CertificateListByBatchAccountOptionalParams

選用參數。

CertificateOperations

代表 CertificateOperations 的介面。

CertificateProperties

憑證屬性。

CertificateReference

警告:此物件已被取代,將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能

CertificateUpdateHeaders

定義Certificate_update作業的標頭。

CertificateUpdateOptionalParams

選用參數。

CheckNameAvailabilityParameters

檢查名稱可用性要求的參數。

CheckNameAvailabilityResult

CheckNameAvailability 作業回應。

CifsMountConfiguration

用來連線到 CIFS 檔案系統的資訊。

CloudError

Batch 服務的錯誤回應。

CloudErrorBody

Batch 服務的錯誤回應。

CloudServiceConfiguration

以 Azure 雲端服務 平台為基礎的集區中節點的組態。

ComputeNodeIdentityReference

與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。

ContainerConfiguration

容器啟用集區的組態。

ContainerRegistry

私人容器登錄。

DataDisk

集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的資料磁碟時,您必須在 VM 內掛接並格式化磁碟,才能使用這些磁碟。

DeleteCertificateError

Batch 服務的錯誤回應。

DeploymentConfiguration

部署組態屬性。

DetectorListResult

List 作業傳回的值。

DetectorResponse

包含偵測器的資訊。

DiffDiskSettings

指定虛擬機所使用作業系統磁碟的暫時磁碟設定。

DiskEncryptionConfiguration

套用在集區中計算節點上的磁碟加密組態。 使用虛擬機映像或 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密設定。

EncryptionProperties

設定客戶數據在 Batch 帳戶內加密的方式。 根據預設,帳戶會使用 Microsoft 受控金鑰進行加密。 如需其他控制,可以改用客戶管理的密鑰。

EndpointAccessProfile

Batch 端點的網路存取配置檔。

EndpointDependency

用來存取相依性之功能變數名稱和連線詳細數據。

EndpointDetail

Batch 服務與端點之間連線的詳細數據。

EnvironmentSetting

要設定於工作進程的環境變數。

FixedScaleSettings

已修正集區的調整設定。

IPRule

篩選用戶端 IP 位址的規則。

ImageReference

Azure 虛擬機器 Marketplace 映射或自定義虛擬機的 Azure 映像資源參考。 若要取得 Azure Batch 所驗證的所有 imageReferences 清單,請參閱「列出支援的節點代理程式 SKU」作業。

InboundNatPool

輸入 NAT 集區,可用來尋址 Batch 集區外部計算節點上的特定埠。

KeyVaultProperties

使用 Microsoft.KeyVault 的加密金鑰Source 時的 KeyVault 組態。

KeyVaultReference

識別與 Batch 帳戶相關聯的 Azure 金鑰保存庫。

LinuxUserConfiguration

用來在Linux節點上建立用戶帳戶的屬性。

ListApplicationPackagesResult

執行清單應用程式封裝的結果。

ListApplicationsResult

執行清單應用程式的結果。

ListCertificatesResult

List 作業傳回的值。

ListPoolsResult

List 作業傳回的值。

ListPrivateEndpointConnectionsResult

List 作業傳回的值。

ListPrivateLinkResourcesResult

List 作業傳回的值。

Location

代表位置的介面。

LocationCheckNameAvailabilityOptionalParams

選用參數。

LocationGetQuotasOptionalParams

選用參數。

LocationListSupportedCloudServiceSkusNextOptionalParams

選用參數。

LocationListSupportedCloudServiceSkusOptionalParams

選用參數。

LocationListSupportedVirtualMachineSkusNextOptionalParams

選用參數。

LocationListSupportedVirtualMachineSkusOptionalParams

選用參數。

ManagedDisk
MetadataItem

Batch 服務不會將任何意義指派給此元數據;它僅供使用者程式代碼使用。

MountConfiguration

要在每個節點上掛接的文件系統。

NFSMountConfiguration

用來連線到 NFS 檔案系統的資訊。

NetworkConfiguration

集區的網路組態。

NetworkProfile

Batch 帳戶的網路配置檔,其中包含每個端點的網路規則設定。

NetworkSecurityGroupRule

要套用至輸入端點的網路安全組規則。

NodePlacementConfiguration

Batch 服務用來布建節點的配置組態。

OSDisk

虛擬機操作系統磁碟的設定。

Operation

REST API 作業

OperationDisplay

描述作業的物件。

OperationListResult

列出 REST API 作業的要求結果。 它包含作業清單和 URL nextLink,以取得下一組結果。

Operations

表示作業的介面。

OperationsListNextOptionalParams

選用參數。

OperationsListOptionalParams

選用參數。

OutboundEnvironmentEndpoint

Batch 服務需要輸出存取之相同服務的相關端點集合。

OutboundEnvironmentEndpointCollection

List 作業傳回的值。

Pool

包含集區的相關信息。

PoolCreateHeaders

定義Pool_create作業的標頭。

PoolCreateOptionalParams

選用參數。

PoolDeleteHeaders

定義Pool_delete作業的標頭。

PoolDeleteOptionalParams

選用參數。

PoolDisableAutoScaleHeaders

定義Pool_disableAutoScale作業的標頭。

PoolDisableAutoScaleOptionalParams

選用參數。

PoolEndpointConfiguration

集區的端點組態。

PoolGetHeaders

定義Pool_get作業的標頭。

PoolGetOptionalParams

選用參數。

PoolListByBatchAccountNextOptionalParams

選用參數。

PoolListByBatchAccountOptionalParams

選用參數。

PoolOperations

代表PoolOperations的介面。

PoolStopResizeHeaders

定義Pool_stopResize作業的標頭。

PoolStopResizeOptionalParams

選用參數。

PoolUpdateHeaders

定義Pool_update作業的標頭。

PoolUpdateOptionalParams

選用參數。

PrivateEndpoint

私人端點連線的私人端點。

PrivateEndpointConnection

包含私人鏈接資源的相關信息。

PrivateEndpointConnectionDeleteHeaders

定義PrivateEndpointConnection_delete作業的標頭。

PrivateEndpointConnectionDeleteOptionalParams

選用參數。

PrivateEndpointConnectionGetOptionalParams

選用參數。

PrivateEndpointConnectionListByBatchAccountNextOptionalParams

選用參數。

PrivateEndpointConnectionListByBatchAccountOptionalParams

選用參數。

PrivateEndpointConnectionOperations

代表 PrivateEndpointConnectionOperations 的介面。

PrivateEndpointConnectionUpdateHeaders

定義PrivateEndpointConnection_update作業的標頭。

PrivateEndpointConnectionUpdateOptionalParams

選用參數。

PrivateLinkResource

包含私人鏈接資源的相關信息。

PrivateLinkResourceGetOptionalParams

選用參數。

PrivateLinkResourceListByBatchAccountNextOptionalParams

選用參數。

PrivateLinkResourceListByBatchAccountOptionalParams

選用參數。

PrivateLinkResourceOperations

代表 PrivateLinkResourceOperations 的介面。

PrivateLinkServiceConnectionState

私人端點連線的私人連結服務連線狀態

ProxyResource

Azure 資源的定義。

PublicIPAddressConfiguration

集區網路設定的公用IP位址組態。

ResizeError

調整集區大小時發生的錯誤。

ResizeOperationStatus

描述目前作業 (集區 AllocationState 是否重設大小) 或先前完成的作業,如果 AllocationState 為穩定) ,則 (。

Resource

Azure 資源的定義。

ResourceFile

要下載至計算節點的單一檔案或多個檔案。

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

ScaleSettings

定義集區所需的大小。 這可以是 'fixedScale',其中指定了要求的 targetDedicatedNodes,或定義定期重新評估的公式的 'autoScale'。 如果未指定此屬性,集區將會有固定小數字數,且具有 0 targetDedicatedNodes。

SecurityProfile

指定虛擬機或虛擬機擴展集的安全性配置檔設定。

ServiceArtifactReference

指定使用「最新」映像版本時,用來為擴展集中的所有虛擬機設定相同映射版本的服務成品參考標識符。

SkuCapability

SKU 功能,例如核心數目。

StartTask

在某些情況下,即使節點未重新啟動,仍可能會重新執行啟動工作。 因此,啟動工作應該具有等冪性,並在執行中的設定已完成時正常結束。 請特別小心,以避免啟動工作從啟動工作目錄建立中斷程式或安裝/啟動服務,因為這樣會封鎖 Batch 無法重新執行啟動工作。

SupportedSku

描述 Batch 支援的 SKU。

SupportedSkusResult

批次清單支援的 SKU 作業回應。

TaskContainerSettings

工作的容器設定。

TaskSchedulingPolicy

指定工作應如何分散到計算節點。

UefiSettings

指定安全性設定,例如建立虛擬機時所使用的安全開機和 vTPM。

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

UserAccount

用來在 Azure Batch 節點上建立用戶的屬性。

UserAssignedIdentities

相關聯的使用者身分識別清單。

UserIdentity

指定userName或 autoUser 屬性,但不能同時指定兩者。

VMExtension

虛擬機延伸模組的組態。

VirtualMachineConfiguration

以 Azure 虛擬機器 基礎結構為基礎的集區中計算節點的組態。

VirtualMachineFamilyCoreQuota

VM 系列及其 Batch 帳戶的相關核心配額。

WindowsConfiguration

要套用至虛擬機的 Windows 作業系統設定。

WindowsUserConfiguration

用來在 Windows 節點上建立用戶帳戶的屬性。

類型別名

AccountKeyType

定義 AccountKeyType 的值。

AllocationState

定義 AllocationState 的值。

ApplicationCreateResponse

包含建立作業的響應數據。

ApplicationGetResponse

包含取得作業的回應數據。

ApplicationListNextResponse

包含 listNext 作業的響應數據。

ApplicationListResponse

包含清單作業的回應數據。

ApplicationPackageActivateResponse

包含啟動作業的響應數據。

ApplicationPackageCreateResponse

包含建立作業的響應數據。

ApplicationPackageGetResponse

包含取得作業的回應數據。

ApplicationPackageListNextResponse

包含 listNext 作業的響應數據。

ApplicationPackageListResponse

包含清單作業的回應數據。

ApplicationUpdateResponse

包含更新作業的回應數據。

AuthenticationMode

定義 AuthenticationMode 的值。

AutoStorageAuthenticationMode

定義 AutoStorageAuthenticationMode 的值。

AutoUserScope

定義 AutoUserScope 的值。

BatchAccountCreateResponse

包含建立作業的響應數據。

BatchAccountGetDetectorResponse

包含 getDetector 作業的響應數據。

BatchAccountGetKeysResponse

包含 getKeys 作業的響應數據。

BatchAccountGetResponse

包含取得作業的回應數據。

BatchAccountListByResourceGroupNextResponse

包含 listByResourceGroupNext 作業的響應數據。

BatchAccountListByResourceGroupResponse

包含 listByResourceGroup 作業的響應數據。

BatchAccountListDetectorsNextResponse

包含 listDetectorsNext 作業的響應數據。

BatchAccountListDetectorsResponse

包含 listDetectors 作業的響應數據。

BatchAccountListNextResponse

包含 listNext 作業的響應數據。

BatchAccountListOutboundNetworkDependenciesEndpointsNextResponse

包含 listOutboundNetworkDependenciesEndpointsNext 作業的響應數據。

BatchAccountListOutboundNetworkDependenciesEndpointsResponse

包含 listOutboundNetworkDependenciesEndpoints 作業的響應數據。

BatchAccountListResponse

包含清單作業的回應數據。

BatchAccountRegenerateKeyResponse

包含 regenerateKey 作業的響應數據。

BatchAccountUpdateResponse

包含更新作業的回應數據。

CachingType

定義 CachingType 的值。

CertificateCancelDeletionResponse

包含 cancelDeletion 作業的響應數據。

CertificateCreateResponse

包含建立作業的響應數據。

CertificateFormat

定義 CertificateFormat 的值。

CertificateGetResponse

包含取得作業的回應數據。

CertificateListByBatchAccountNextResponse

包含 listByBatchAccountNext 作業的響應數據。

CertificateListByBatchAccountResponse

包含 listByBatchAccount 作業的響應數據。

CertificateProvisioningState

定義 CertificateProvisioningState 的值。

CertificateStoreLocation

定義 CertificateStoreLocation 的值。

CertificateUpdateResponse

包含更新作業的回應數據。

CertificateVisibility

定義 CertificateVisibility 的值。

ComputeNodeDeallocationOption

定義 ComputeNodeDeallocationOption 的值。

ComputeNodeFillType

定義 ComputeNodeFillType 的值。

ContainerType

定義 ContainerType 的值。
KnownContainerType 可以與 ContainerType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

DockerCompatible:D ocker 相容的容器技術將用來啟動容器。
CriCompatible:CRI 型技術將用來啟動容器。

ContainerWorkingDirectory

定義 ContainerWorkingDirectory 的值。

DiskEncryptionTarget

定義 DiskEncryptionTarget 的值。

DynamicVNetAssignmentScope

定義 DynamicVNetAssignmentScope 的值。

ElevationLevel

定義 ElevationLevel 的值。

EndpointAccessDefaultAction

定義 EndpointAccessDefaultAction 的值。

IPAddressProvisioningType

定義IPAddressProvisioningType的值。

InboundEndpointProtocol

定義 InboundEndpointProtocol 的值。

InterNodeCommunicationState

定義 InterNodeCommunicationState 的值。

KeySource

定義 KeySource 的值。

LocationCheckNameAvailabilityResponse

包含 checkNameAvailability 作業的響應數據。

LocationGetQuotasResponse

包含 getQuotas 作業的響應數據。

LocationListSupportedCloudServiceSkusNextResponse

包含 listSupportedCloudServiceSkusNext 作業的響應數據。

LocationListSupportedCloudServiceSkusResponse

包含 listSupportedCloudServiceSkus 作業的響應數據。

LocationListSupportedVirtualMachineSkusNextResponse

包含 listSupportedVirtualMachineSkusNext 作業的響應數據。

LocationListSupportedVirtualMachineSkusResponse

包含 listSupportedVirtualMachineSkus 作業的響應數據。

LoginMode

定義 LoginMode 的值。

NameAvailabilityReason

定義 NameAvailabilityReason 的值。

NetworkSecurityGroupRuleAccess

定義 NetworkSecurityGroupRuleAccess 的值。

NodeCommunicationMode

定義 NodeCommunicationMode 的值。

NodePlacementPolicyType

定義 NodePlacementPolicyType 的值。

OperationsListNextResponse

包含 listNext 作業的響應數據。

OperationsListResponse

包含清單作業的回應數據。

PackageState

定義 PackageState 的值。

PoolAllocationMode

定義 PoolAllocationMode 的值。

PoolCreateResponse

包含建立作業的響應數據。

PoolDisableAutoScaleResponse

包含 disableAutoScale 作業的響應數據。

PoolGetResponse

包含取得作業的回應數據。

PoolIdentityType

定義 PoolIdentityType 的值。

PoolListByBatchAccountNextResponse

包含 listByBatchAccountNext 作業的響應數據。

PoolListByBatchAccountResponse

包含 listByBatchAccount 作業的響應數據。

PoolProvisioningState

定義 PoolProvisioningState 的值。

PoolStopResizeResponse

包含 stopResize 作業的響應數據。

PoolUpdateResponse

包含更新作業的回應數據。

PrivateEndpointConnectionDeleteResponse

包含刪除作業的回應數據。

PrivateEndpointConnectionGetResponse

包含取得作業的回應數據。

PrivateEndpointConnectionListByBatchAccountNextResponse

包含 listByBatchAccountNext 作業的響應數據。

PrivateEndpointConnectionListByBatchAccountResponse

包含 listByBatchAccount 作業的響應數據。

PrivateEndpointConnectionProvisioningState

定義 PrivateEndpointConnectionProvisioningState 的值。

PrivateEndpointConnectionUpdateResponse

包含更新作業的回應數據。

PrivateLinkResourceGetResponse

包含取得作業的回應數據。

PrivateLinkResourceListByBatchAccountNextResponse

包含 listByBatchAccountNext 作業的響應數據。

PrivateLinkResourceListByBatchAccountResponse

包含 listByBatchAccount 作業的響應數據。

PrivateLinkServiceConnectionStatus

定義 PrivateLinkServiceConnectionStatus 的值。

ProvisioningState

定義 ProvisioningState 的值。

PublicNetworkAccessType

定義 PublicNetworkAccessType 的值。

ResourceIdentityType

定義 ResourceIdentityType 的值。

StorageAccountType

定義 StorageAccountType 的值。

UpgradeMode

定義UpgradeMode的值。

列舉

KnownContainerType

服務接受的 ContainerType 已知值。

函數

getContinuationToken(unknown)

假設反覆運算器所產生的byPage最後.value一個,傳回一個接續令牌,可用來開始從該點稍後分頁。

函式詳細資料

getContinuationToken(unknown)

假設反覆運算器所產生的byPage最後.value一個,傳回一個接續令牌,可用來開始從該點稍後分頁。

function getContinuationToken(page: unknown): string | undefined

參數

page

unknown

從反覆運算器存取 value IteratorResult byPage 的物件。

傳回

string | undefined

後續呼叫期間可以傳遞至 byPage () 的接續令牌。