Job Schedule - Add
Hiermee voegt u een taakplanning toe aan het opgegeven account.
POST {batchUrl}/jobschedules?api-version=2023-11-01.18.0
POST {batchUrl}/jobschedules?timeout={timeout}&api-version=2023-11-01.18.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
De basis-URL voor alle Azure Batch serviceaanvragen. |
api-version
|
query | True |
string |
Client-API-versie. |
timeout
|
query |
integer int32 |
De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. |
Aanvraagkoptekst
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
De aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Of de server de client-request-id in het antwoord moet retourneren. |
|
ocp-date |
string date-time-rfc1123 |
Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept. |
Aanvraagbody
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
id | True |
string |
Een tekenreeks die de planning in het account uniek identificeert. |
jobSpecification | True |
De details van de taken die volgens deze planning moeten worden gemaakt. |
|
schedule | True |
De planning volgens welke Jobs worden gemaakt. |
|
displayName |
string |
De weergavenaam voor de planning. |
|
metadata |
Een lijst met naam-waardeparen die zijn gekoppeld aan de planning als metagegevens. |
Antwoorden
Name | Type | Description |
---|---|---|
201 Created |
De aanvraag voor de Batch-service is geslaagd. Headers
|
|
Other Status Codes |
De fout van de Batch-service. |
Beveiliging
azure_auth
Microsoft Entra OAuth 2.0-verificatiecodestroom
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Authorization
Type:
apiKey
In:
header
Voorbeelden
Add a basic Job |
Add a complex Job |
Add a basic JobSchedule
Sample Request
POST account.region.batch.azure.com/jobschedules?api-version=2023-11-01.18.0
{
"id": "jobScheduleId",
"schedule": {
"recurrenceInterval": "PT5M"
},
"jobSpecification": {
"poolInfo": {
"poolId": "poolId"
}
}
}
Sample Response
Add a complex JobScheduleAdd
Sample Request
POST account.region.batch.azure.com/jobschedules?api-version=2023-11-01.18.0
{
"id": "jobScheduleId",
"schedule": {
"doNotRunUntil": "2014-09-10T02:30:00.000Z",
"doNotRunAfter": "2014-09-10T06:30:00.000Z",
"startWindow": "PT1M",
"recurrenceInterval": "PT5M"
},
"jobSpecification": {
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "mytask1",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas",
"filePath": "test.txt"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": true,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "jobschedule",
"pool": {
"vmSize": "small",
"cloudServiceConfiguration": {
"osFamily": "4",
"osVersion": "*"
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
Sample Response
Definities
Name | Description |
---|---|
Access |
De Batch-resources waaraan het token toegang verleent. |
Application |
Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten. |
Authentication |
De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. |
Auto |
Hiermee geeft u kenmerken voor een tijdelijke 'automatische pool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden. |
Auto |
Het bereik voor de automatische gebruiker |
Auto |
Hiermee geeft u de parameters voor de automatische gebruiker die een taak uitvoert op de Batch-service. |
Azure |
Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse. |
Azure |
Informatie die wordt gebruikt om verbinding te maken met een Azure FileShare. |
Batch |
Een foutbericht ontvangen van de Azure Batch-service. |
Batch |
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie. |
Caching |
Het type caching dat moet worden ingeschakeld voor de schijf. |
Certificate |
Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool. |
Certificate |
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
Certificate |
Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat. |
CIFSMount |
Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem. |
Cloud |
De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform. |
Compute |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
Compute |
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt. |
Container |
De configuratie voor pools met container. |
Container |
Een privécontainerregister. |
Container |
De containertechnologie die moet worden gebruikt. |
Container |
De locatie van de werkmap van de containertaak. |
Data |
Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven koppelen en formatteren vanuit een virtuele machine om ze te kunnen gebruiken. |
Diff |
Hiermee geeft u de tijdelijke schijfplaatsing op voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep. |
Diff |
Hiermee geeft u de tijdelijke schijfinstellingen op voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM). |
Disk |
De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie. |
Disk |
De lijst met schijfdoelen batchservice wordt versleuteld op het rekenknooppunt. |
Dynamic |
Het bereik van dynamische vnet-toewijzing. |
Elevation |
Het hoogteniveau van de gebruiker. |
Environment |
Een omgevingsvariabele die moet worden ingesteld voor een taakproces. |
Error |
Een foutbericht ontvangen in een Azure Batch foutbericht. |
Http |
Een http-headernaam-waardepaar |
Image |
Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd. |
Inbound |
Het protocol van het eindpunt. |
Inbound |
Een inkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren. |
IPAddress |
Het inrichtingstype voor openbare IP-adressen voor de groep. |
Job |
De uitvoeringsbeperkingen voor een taak. |
Job |
Hiermee geeft u de details van een Taakbeheertaak op. |
Job |
De netwerkconfiguratie voor de taak. |
Job |
Een taak voor taakvoorbereiding die moet worden uitgevoerd vóór taken van de taak op een bepaald rekenknooppunt. |
Job |
Een taak voor taakrelease die moet worden uitgevoerd wanneer de taak is voltooid op een rekenknooppunt waarop de taak is uitgevoerd. |
Job |
Een taakplanning waarmee terugkerende taken kunnen worden uitgevoerd door op te geven wanneer taken moeten worden uitgevoerd en een specificatie die wordt gebruikt om elke taak te maken. |
Job |
Hiermee geeft u details op van de taken die volgens een planning moeten worden gemaakt. |
Linux |
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt. |
Login |
De aanmeldingsmodus voor de gebruiker |
Managed |
|
Metadata |
Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource. |
Mount |
Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld. |
Network |
De netwerkconfiguratie voor een pool. |
Network |
Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt. |
Network |
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag. |
NFSMount |
Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem. |
Node |
Bepaalt hoe een pool communiceert met de Batch-service. |
Node |
Configuratie van knooppuntplaatsing voor een pool. |
Node |
Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool. |
On |
De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben. |
On |
De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt. |
OSDisk |
Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM). |
Output |
Een specificatie voor het uploaden van bestanden van een Azure Batch-rekenknooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces. |
Output |
Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op. |
Output |
Het doel waarnaar een bestand moet worden geüpload. |
Output |
De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload. |
Output |
Details over een uploadbewerking voor uitvoerbestanden, waaronder onder welke voorwaarden het uploaden moet worden uitgevoerd. |
Pool |
De eindpuntconfiguratie voor een pool. |
Pool |
Hiermee geeft u op hoe een taak moet worden toegewezen aan een pool. |
Pool |
De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools. |
Pool |
Specificatie voor het maken van een nieuwe pool. |
Public |
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool. |
Resource |
Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt. |
Schedule |
De planning volgens welke taken worden gemaakt. Alle tijden worden vastgesteld in respectievelijk UTC en worden niet beïnvloed door zomertijd. |
Security |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
Security |
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. |
Service |
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën. |
Start |
Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt geïnstalleerd. |
Storage |
Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven. |
Task |
Uitvoeringsbeperkingen die moeten worden toegepast op een taak. |
Task |
De containerinstellingen voor een taak. |
Task |
Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten. |
Uefi |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. |
User |
Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt. |
User |
De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
Virtual |
De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur. |
VMExtension |
De configuratie voor extensies van virtuele machines. |
Windows |
Instellingen van het Windows-besturingssysteem die moeten worden toegepast op de virtuele machine. |
Windows |
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows Compute-knooppunt. |
AccessScope
De Batch-resources waaraan het token toegang verleent.
Name | Type | Description |
---|---|---|
job |
string |
Verleent toegang om alle bewerkingen uit te voeren op de taak die de taak bevat. |
ApplicationPackageReference
Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.
Name | Type | Description |
---|---|---|
applicationId |
string |
De id van de toepassing die moet worden geïmplementeerd. |
version |
string |
De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. |
AuthenticationTokenSettings
De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.
Name | Type | Description |
---|---|---|
access |
De Batch-resources waaraan het token toegang verleent. |
AutoPoolSpecification
Hiermee geeft u kenmerken voor een tijdelijke 'automatische pool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden.
Name | Type | Description |
---|---|---|
autoPoolIdPrefix |
string |
Een voorvoegsel dat moet worden toegevoegd aan de unieke id wanneer automatisch een pool wordt gemaakt. |
keepAlive |
boolean |
Of u een automatische pool in leven wilt houden nadat de levensduur is verlopen. |
pool |
De poolspecificatie voor de automatische pool. |
|
poolLifetimeOption |
De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools. |
AutoUserScope
Het bereik voor de automatische gebruiker
Name | Type | Description |
---|---|---|
pool |
string |
Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk rekenknooppunt in een pool. |
task |
string |
Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken. |
AutoUserSpecification
Hiermee geeft u de parameters voor de automatische gebruiker die een taak uitvoert op de Batch-service.
Name | Type | Description |
---|---|---|
elevationLevel |
Het hoogteniveau van de automatische gebruiker. |
|
scope |
Het bereik voor de automatische gebruiker |
AzureBlobFileSystemConfiguration
Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse.
Name | Type | Description |
---|---|---|
accountKey |
string |
De sleutel van het Azure Storage-account. |
accountName |
string |
De naam van het Azure Storage-account. |
blobfuseOptions |
string |
Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht. |
containerName |
string |
De Azure Blob Storage containernaam. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot containerName |
|
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
sasKey |
string |
Het AZURE Storage SAS-token. |
AzureFileShareConfiguration
Informatie die wordt gebruikt om verbinding te maken met een Azure FileShare.
Name | Type | Description |
---|---|---|
accountKey |
string |
De sleutel van het Azure Storage-account. |
accountName |
string |
De naam van het Azure Storage-account. |
azureFileUrl |
string |
De URL van Azure Files. |
mountOptions |
string |
Extra opdrachtregelopties om door te geven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
BatchError
Een foutbericht ontvangen van de Azure Batch-service.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
message |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
|
values |
Een verzameling sleutel-waardeparen met aanvullende informatie over de fout. |
BatchErrorDetail
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
Name | Type | Description |
---|---|---|
key |
string |
Een id die de betekenis van de eigenschap Value aangeeft. |
value |
string |
De aanvullende informatie die is opgenomen in de foutreactie. |
CachingType
Het type caching dat moet worden ingeschakeld voor de schijf.
Name | Type | Description |
---|---|---|
none |
string |
De cachemodus voor de schijf is niet ingeschakeld. |
readonly |
string |
De cachemodus voor de schijf is alleen-lezen. |
readwrite |
string |
De cachemodus voor de schijf is lezen en schrijven. |
CertificateReference
Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
storeLocation |
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
|
storeName |
string |
De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
thumbprint |
string |
De vingerafdruk van het certificaat. |
thumbprintAlgorithm |
string |
Het algoritme waaraan de vingerafdruk is gekoppeld. Dit moet sha1 zijn. |
visibility |
Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat. |
CertificateStoreLocation
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
Name | Type | Description |
---|---|---|
currentuser |
string |
Certificaten moeten worden geïnstalleerd in het currentuser-certificaatarchief. |
localmachine |
string |
Certificaten moeten worden geïnstalleerd in het LocalMachine-certificaatarchief. |
CertificateVisibility
Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.
Name | Type | Description |
---|---|---|
remoteuser |
string |
Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers op afstand toegang hebben tot het rekenknooppunt. |
starttask |
string |
Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de StartTask wordt uitgevoerd. Houd er rekening mee dat als AutoUser-bereik pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak. |
task |
string |
Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd. |
CIFSMountConfiguration
Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht. |
password |
string |
Het wachtwoord dat moet worden gebruikt voor verificatie met het CIFS-bestandssysteem. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem dat moet worden gekoppeld. |
username |
string |
De gebruiker die moet worden gebruikt voor verificatie met het CIFS-bestandssysteem. |
CloudServiceConfiguration
De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform.
Name | Type | Description |
---|---|---|
osFamily |
string |
De Azure-gastbesturingssysteemfamilie die moet worden geïnstalleerd op de virtuele machines in de pool. |
osVersion |
string |
De versie van het Azure-gastbesturingssystemen die moet worden geïnstalleerd op de virtuele machines in de pool. |
ComputeNodeFillType
Hoe taken worden verdeeld over rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
pack |
string |
Er moeten zoveel mogelijk taken (taskSlotsPerNode) worden toegewezen aan elk rekenknooppunt in de pool voordat taken worden toegewezen aan het volgende rekenknooppunt in de pool. |
spread |
string |
Taken moeten gelijkmatig worden toegewezen aan alle rekenknooppunten in de pool. |
ComputeNodeIdentityReference
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
Name | Type | Description |
---|---|---|
resourceId |
string |
De ARM-resource-id van de door de gebruiker toegewezen identiteit. |
ContainerConfiguration
De configuratie voor pools met container.
Name | Type | Description |
---|---|---|
containerImageNames |
string[] |
De verzameling containerinstallatiekopieën. |
containerRegistries |
Aanvullende privéregisters waaruit containers kunnen worden opgehaald. |
|
type |
De te gebruiken containertechnologie. |
ContainerRegistry
Een privécontainerregister.
Name | Type | Description |
---|---|---|
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van gebruikersnaam en wachtwoord. |
|
password |
string |
Het wachtwoord om u aan te melden bij de registerserver. |
registryServer |
string |
De register-URL. |
username |
string |
De gebruikersnaam om u aan te melden bij de registerserver. |
ContainerType
De containertechnologie die moet worden gebruikt.
Name | Type | Description |
---|---|---|
criCompatible |
string |
Er wordt een op CRI gebaseerde technologie gebruikt om de containers te starten. |
dockerCompatible |
string |
Er wordt een docker-compatibele containertechnologie gebruikt om de containers te starten. |
ContainerWorkingDirectory
De locatie van de werkmap van de containertaak.
Name | Type | Description |
---|---|---|
containerImageDefault |
string |
Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Deze map bevat niet de bronbestanden die door Batch zijn gedownload. |
taskWorkingDirectory |
string |
Gebruik de standaardwerkmap taak van de Batch-service, die de taakbronbestanden bevat die door Batch worden gevuld. |
DataDisk
Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven koppelen en formatteren vanuit een virtuele machine om ze te kunnen gebruiken.
Name | Type | Description |
---|---|---|
caching |
Het type caching dat moet worden ingeschakeld voor de gegevensschijven. |
|
diskSizeGB |
integer |
De initiële schijfgrootte in gigabytes. |
lun |
integer |
Het logische eenheidsnummer. |
storageAccountType |
Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf. |
DiffDiskPlacement
Hiermee geeft u de tijdelijke schijfplaatsing op voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep.
Name | Type | Description |
---|---|---|
CacheDisk |
string |
De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache. |
DiffDiskSettings
Hiermee geeft u de tijdelijke schijfinstellingen op voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).
Name | Type | Description |
---|---|---|
placement |
Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep. |
DiskEncryptionConfiguration
De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie.
Name | Type | Description |
---|---|---|
targets |
De lijst met schijfdoelen Batch Service wordt versleuteld op het rekenknooppunt. |
DiskEncryptionTarget
De lijst met schijfdoelen batchservice wordt versleuteld op het rekenknooppunt.
Name | Type | Description |
---|---|---|
osdisk |
string |
De besturingssysteemschijf op het rekenknooppunt is versleuteld. |
temporarydisk |
string |
De tijdelijke schijf op het rekenknooppunt is versleuteld. Op Linux is deze versleuteling van toepassing op andere partities (zoals partities op gekoppelde gegevensschijven) wanneer versleuteling plaatsvindt tijdens het opstarten. |
DynamicVNetAssignmentScope
Het bereik van dynamische vnet-toewijzing.
Name | Type | Description |
---|---|---|
job |
string |
Dynamische VNet-toewijzing wordt per taak uitgevoerd. |
none |
string |
Er is geen dynamische VNet-toewijzing ingeschakeld. |
ElevationLevel
Het hoogteniveau van de gebruiker.
Name | Type | Description |
---|---|---|
admin |
string |
De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen. |
nonadmin |
string |
De gebruiker is een standaardgebruiker zonder verhoogde toegang. |
EnvironmentSetting
Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de omgevingsvariabele. |
value |
string |
De waarde van de omgevingsvariabele. |
ErrorMessage
Een foutbericht ontvangen in een Azure Batch foutbericht.
Name | Type | Description |
---|---|---|
lang |
string |
De taalcode van het foutbericht |
value |
string |
De tekst van het bericht. |
HttpHeader
Een http-headernaam-waardepaar
Name | Type | Description |
---|---|---|
name |
string |
De hoofdlettergevoelige naam van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden |
value |
string |
De waarde van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden |
ImageReference
Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd.
Name | Type | Description |
---|---|---|
exactVersion |
string |
De specifieke versie van de platforminstallatiekopieën of marketplace-installatiekopieën die worden gebruikt om het knooppunt te maken. Dit alleen-lezenveld verschilt alleen van 'versie' als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt, 'meest recente' was. |
offer |
string |
Het aanbiedingstype van de Azure Virtual Machines Marketplace-installatiekopieën. |
publisher |
string |
De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën. |
sku |
string |
De SKU van de Azure Virtual Machines Marketplace-installatiekopieën. |
version |
string |
De versie van de Azure Virtual Machines Marketplace-installatiekopieën. |
virtualMachineImageId |
string |
De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Rekenknooppunten in de pool worden gemaakt met behulp van deze installatiekopieën-id. Dit heeft de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} om altijd de meest recente versie van de installatiekopie te gebruiken. |
InboundEndpointProtocol
Het protocol van het eindpunt.
Name | Type | Description |
---|---|---|
tcp |
string |
Gebruik TCP voor het eindpunt. |
udp |
string |
Gebruik UDP voor het eindpunt. |
InboundNATPool
Een inkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren.
Name | Type | Description |
---|---|---|
backendPort |
integer |
Het poortnummer op het rekenknooppunt. |
frontendPortRangeEnd |
integer |
Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt om inkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. |
frontendPortRangeStart |
integer |
Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt om inkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. |
name |
string |
De naam van het eindpunt. |
networkSecurityGroupRules |
Een lijst met regels voor netwerkbeveiligingsgroepen die worden toegepast op het eindpunt. |
|
protocol |
Het protocol van het eindpunt. |
IPAddressProvisioningType
Het inrichtingstype voor openbare IP-adressen voor de groep.
Name | Type | Description |
---|---|---|
batchmanaged |
string |
Er wordt een openbaar IP-adres gemaakt en beheerd door Batch. Er kunnen meerdere openbare IP-adressen zijn, afhankelijk van de grootte van de pool. |
nopublicipaddresses |
string |
Er wordt geen openbaar IP-adres gemaakt. |
usermanaged |
string |
Openbare IP-adressen worden geleverd door de gebruiker en worden gebruikt om de rekenknooppunten in te richten. |
JobConstraints
De uitvoeringsbeperkingen voor een taak.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
Het maximum aantal keren dat elke taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw als de afsluitcode een andere is dan nul. |
maxWallClockTime |
string |
De maximaal verstreken tijd die de taak mag uitvoeren, gemeten vanaf het moment dat de taak wordt gemaakt. |
JobManagerTask
Hiermee geeft u de details van een Taakbeheertaak op.
Name | Type | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Of de Taakbeheertaak kan worden uitgevoerd op een rekenknooppunt met een spot-/lage prioriteit. |
applicationPackageReferences |
Een lijst met toepassingspakketten die door de Batch-service worden geïmplementeerd op het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. |
|
authenticationTokenSettings |
De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. |
|
commandLine |
string |
De opdrachtregel van de taak Job Manager. |
constraints |
Beperkingen die van toepassing zijn op de taak Job Manager. |
|
containerSettings |
De instellingen voor de container waaronder de taak Taak jobbeheer wordt uitgevoerd. |
|
displayName |
string |
De weergavenaam van de taak Job Manager. |
environmentSettings |
Een lijst met omgevingsvariabele-instellingen voor de taak Jobbeheer. |
|
id |
string |
Een tekenreeks die de taak Job Manager in de taak uniek identificeert. |
killJobOnCompletion |
boolean |
Hiermee wordt aangegeven of het voltooien van de Taakbeheertaak aangeeft dat de volledige taak is voltooid. |
outputFiles |
Een lijst met bestanden die door de Batch-service worden geüpload vanaf het rekenknooppunt nadat de opdrachtregel is uitgevoerd. |
|
requiredSlots |
integer |
Het aantal planningssites dat de taak nodig heeft om uit te voeren. |
resourceFiles |
Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. |
|
runExclusive |
boolean |
Hiermee wordt aangegeven of voor taakbeheer exclusief gebruik is vereist van het rekenknooppunt waarop deze wordt uitgevoerd. |
userIdentity |
De gebruikersidentiteit waaronder de taak Job Manager wordt uitgevoerd. |
JobNetworkConfiguration
De netwerkconfiguratie voor de taak.
Name | Type | Description |
---|---|---|
subnetId |
string |
De ARM-resource-id van het subnet van het virtuele netwerk waaraan rekenknooppunten die taken uitvoeren vanuit de taak, worden samengevoegd voor de duur van de taak. Dit werkt alleen met een VirtualMachineConfiguration-pool. |
JobPreparationTask
Een taak voor taakvoorbereiding die moet worden uitgevoerd vóór taken van de taak op een bepaald rekenknooppunt.
Name | Type | Description |
---|---|---|
commandLine |
string |
De opdrachtregel van de taakvoorbereidingstaak. |
constraints |
Beperkingen die van toepassing zijn op de taakvoorbereidingstaak. |
|
containerSettings |
De instellingen voor de container waaronder de taakvoorbereidingstaak wordt uitgevoerd. |
|
environmentSettings |
Een lijst met omgevingsvariabeleinstellingen voor de taak voor taakvoorbereiding. |
|
id |
string |
Een tekenreeks die de taakvoorbereidingstaak in de taak uniek identificeert. |
rerunOnNodeRebootAfterSuccess |
boolean |
Of de Batch-service de taakvoorbereidingstaak opnieuw moet uitvoeren nadat een rekenknooppunt opnieuw is opgestart. |
resourceFiles |
Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. |
|
userIdentity |
De gebruikersidentiteit waaronder de taak voor het voorbereiden van de taak wordt uitgevoerd. |
|
waitForSuccess |
boolean |
Of de Batch-service moet wachten totdat de taakvoorbereidingstaak is voltooid voordat andere taken van de taak op het rekenknooppunt worden gepland. Een taak voor taakvoorbereiding is voltooid als deze wordt afgesloten met afsluitcode 0. |
JobReleaseTask
Een taak voor taakrelease die moet worden uitgevoerd wanneer de taak is voltooid op een rekenknooppunt waarop de taak is uitgevoerd.
Name | Type | Description |
---|---|---|
commandLine |
string |
De opdrachtregel van de taakreleasetaak. |
containerSettings |
De instellingen voor de container waaronder de taak wordt uitgevoerd. |
|
environmentSettings |
Een lijst met omgevingsvariabele-instellingen voor de taak releasetaak. |
|
id |
string |
Een tekenreeks die de taak releasetaak in de taak uniek identificeert. |
maxWallClockTime |
string |
De maximaal verstreken tijd die de taak mag worden uitgevoerd op een bepaald rekenknooppunt, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet wordt voltooid, wordt deze door de Batch-service beëindigd. De standaardwaarde is 15 minuten. U mag geen time-out opgeven die langer is dan 15 minuten. Als u dit doet, weigert de Batch-service dit met een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag). |
resourceFiles |
Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers. |
|
retentionTime |
string |
De minimale tijd voor het bewaren van de taakmap voor de taakreleasetaak op het rekenknooppunt. Na deze tijd kan de Batch-service de taakmap en alle inhoud ervan verwijderen. |
userIdentity |
De gebruikersidentiteit waaronder de Taak Release-taak wordt uitgevoerd. |
JobScheduleAddParameter
Een taakplanning waarmee terugkerende taken kunnen worden uitgevoerd door op te geven wanneer taken moeten worden uitgevoerd en een specificatie die wordt gebruikt om elke taak te maken.
Name | Type | Description |
---|---|---|
displayName |
string |
De weergavenaam voor de planning. |
id |
string |
Een tekenreeks die de planning binnen het account uniek identificeert. |
jobSpecification |
De details van de taken die volgens deze planning moeten worden gemaakt. |
|
metadata |
Een lijst met naam-waardeparen die zijn gekoppeld aan de planning als metagegevens. |
|
schedule |
De planning volgens welke taken worden gemaakt. |
JobSpecification
Hiermee geeft u details op van de taken die volgens een planning moeten worden gemaakt.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Of taken in deze taak kunnen worden overgeslagen door andere taken met hoge prioriteit |
|
commonEnvironmentSettings |
Een lijst met algemene instellingen voor omgevingsvariabelen. Deze omgevingsvariabelen worden ingesteld voor alle taken in taken die onder deze planning zijn gemaakt (inclusief jobbeheer, taakvoorbereiding en taakreleasetaken). |
||
constraints |
De uitvoeringsbeperkingen voor taken die volgens deze planning zijn gemaakt. |
||
displayName |
string |
De weergavenaam voor taken die onder deze planning zijn gemaakt. |
|
jobManagerTask |
De details van een Job Manager-taak die moet worden gestart wanneer een taak onder deze planning wordt gestart. |
||
jobPreparationTask |
De taak voor taakvoorbereiding voor taken die onder deze planning zijn gemaakt. |
||
jobReleaseTask |
De jobreleasetaak voor taken die onder deze planning zijn gemaakt. |
||
maxParallelTasks |
integer |
-1 |
Het maximum aantal taken dat parallel voor de taak kan worden uitgevoerd. |
metadata |
Een lijst met naam-waardeparen die zijn gekoppeld aan elke taak die onder dit schema als metagegevens is gemaakt. |
||
networkConfiguration |
De netwerkconfiguratie voor de taak. |
||
onAllTasksComplete |
De actie die de Batch-service moet uitvoeren wanneer alle taken in een taak die onder dit schema zijn gemaakt, de status Voltooid hebben. |
||
onTaskFailure |
De actie die de Batch-service moet uitvoeren wanneer een taak mislukt in een taak die onder deze planning is gemaakt. Een taak wordt beschouwd als mislukt als deze is mislukt als deze een failureInfo heeft. Een failureInfo wordt ingesteld als de taak wordt voltooid met een afsluitcode die niet nul is nadat het aantal nieuwe pogingen is uitgeput, of als er een fout is opgetreden bij het starten van de taak, bijvoorbeeld vanwege een fout bij het downloaden van een resourcebestand. |
||
poolInfo |
De pool waarop de Batch-service de taken van taken uitvoert die onder deze planning zijn gemaakt. |
||
priority |
integer |
De prioriteit van taken die onder deze planning zijn gemaakt. |
|
usesTaskDependencies |
boolean |
Of taken in de taak afhankelijkheden van elkaar kunnen definiëren. De standaardwaarde is false. |
LinuxUserConfiguration
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt.
Name | Type | Description |
---|---|---|
gid |
integer |
De groeps-id voor het gebruikersaccount. |
sshPrivateKey |
string |
De persoonlijke SSH-sleutel voor het gebruikersaccount. |
uid |
integer |
De gebruikers-id van het gebruikersaccount. |
LoginMode
De aanmeldingsmodus voor de gebruiker
Name | Type | Description |
---|---|---|
batch |
string |
De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De modus batchaanmelding wordt aanbevolen voor langdurige parallelle processen. |
interactive |
string |
De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld voor Windows VirtualMachineConfiguration Pools. Als deze optie wordt gebruikt met een verhoogde gebruikersidentiteit in een Windows VirtualMachineConfiguration-pool, wordt de gebruikerssessie niet verhoogd, tenzij de toepassing die wordt uitgevoerd door de taakopdrachtregel is geconfigureerd om altijd beheerdersbevoegdheden of om altijd maximale bevoegdheden te vereisen. |
ManagedDisk
Name | Type | Description |
---|---|---|
storageAccountType |
Het opslagaccounttype voor de beheerde schijf. |
MetadataItem
Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.
Name | Type | Description |
---|---|---|
name |
string |
De naam van het metagegevensitem. |
value |
string |
De waarde van het metagegevensitem. |
MountConfiguration
Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
De Azure Storage-container die moet worden gekoppeld met behulp van blob FUSE op elk knooppunt. |
|
azureFileShareConfiguration |
De Azure-bestandsshare die aan elk knooppunt moet worden gekoppeld. |
|
cifsMountConfiguration |
Het CIFS/SMB-bestandssysteem dat aan elk knooppunt moet worden gekoppeld. |
|
nfsMountConfiguration |
Het NFS-bestandssysteem dat aan elk knooppunt moet worden gekoppeld. |
NetworkConfiguration
De netwerkconfiguratie voor een pool.
Name | Type | Description |
---|---|---|
dynamicVNetAssignmentScope |
Het bereik van dynamische vnet-toewijzing. |
|
enableAcceleratedNetworking |
boolean |
Of deze pool versneld netwerken moet inschakelen. |
endpointConfiguration |
De configuratie voor eindpunten op rekenknooppunten in de Batch-pool. |
|
publicIPAddressConfiguration |
De configuratie van het openbare IP-adres voor rekenknooppunten in de Batch-pool. |
|
subnetId |
string |
De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden toegevoegd. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.
Name | Type | Description |
---|---|---|
access |
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag. |
|
priority |
integer |
De prioriteit voor deze regel. |
sourceAddressPrefix |
string |
Het bronadresvoorvoegsel of de tag die overeenkomt met de regel. |
sourcePortRanges |
string[] |
De bronpoortbereiken die overeenkomen met de regel. |
NetworkSecurityGroupRuleAccess
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.
Name | Type | Description |
---|---|---|
allow |
string |
Toegang toestaan. |
deny |
string |
Toegang weigeren. |
NFSMountConfiguration
Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem dat moet worden gekoppeld. |
NodeCommunicationMode
Bepaalt hoe een pool communiceert met de Batch-service.
Name | Type | Description |
---|---|---|
classic |
string |
Knooppunten die de klassieke communicatiemodus gebruiken, vereisen binnenkomende TCP-communicatie op poorten 29876 en 29877 van batchnodemanagement. Servicetag {region} en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. {region}' servicetags. |
default |
string |
De communicatiemodus van het knooppunt wordt automatisch ingesteld door de Batch-service. |
simplified |
string |
Knooppunten die gebruikmaken van de vereenvoudigde communicatiemodus vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen open binnenkomende poorten vereist. |
NodePlacementConfiguration
Configuratie van knooppuntplaatsing voor een pool.
Name | Type | Description |
---|---|---|
policy |
Type beleid voor knooppuntplaatsing in Batch-pools. |
NodePlacementPolicyType
Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.
Name | Type | Description |
---|---|---|
regional |
string |
Alle knooppunten in de pool worden toegewezen in dezelfde regio. |
zonal |
string |
Knooppunten in de pool worden verdeeld over verschillende beschikbaarheidszones met best effort balancing. |
OnAllTasksComplete
De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben.
Name | Type | Description |
---|---|---|
noaction |
string |
Geen actie uitvoeren. De taak blijft actief, tenzij deze op een andere wijze wordt beëindigd of uitgeschakeld. |
terminatejob |
string |
Beëindig de taak. De terminateReason van de taak is ingesteld op 'AllTasksComplete'. |
OnTaskFailure
De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt.
Name | Type | Description |
---|---|---|
noaction |
string |
Geen actie uitvoeren. De taak blijft actief, tenzij deze op een andere wijze wordt beëindigd of uitgeschakeld. |
performexitoptionsjobaction |
string |
Voer de actie uit die is gekoppeld aan de voorwaarde Taak afsluiten in de verzameling exitConditions van de taak. (Dit kan er nog steeds toe leiden dat er geen actie wordt ondernomen, als dat is wat de taak opgeeft.) |
OSDisk
Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).
Name | Type | Description |
---|---|---|
caching |
Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag. |
|
diskSizeGB |
integer |
De initiële schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf. |
ephemeralOSDiskSettings |
Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM). |
|
managedDisk |
De parameters van de beheerde schijf. |
|
writeAcceleratorEnabled |
boolean |
Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf. |
OutputFile
Een specificatie voor het uploaden van bestanden van een Azure Batch-rekenknooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.
Name | Type | Description |
---|---|---|
destination |
Het doel voor de uitvoerbestanden. |
|
filePattern |
string |
Een patroon dat aangeeft welk bestand(en) moet(en) worden geüpload. |
uploadOptions |
Aanvullende opties voor de uploadbewerking, waaronder onder welke voorwaarden de upload moet worden uitgevoerd. |
OutputFileBlobContainerDestination
Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op.
Name | Type | Description |
---|---|---|
containerUrl |
string |
De URL van de container in Azure Blob Storage waarnaar de bestanden moeten worden geüpload. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door containerUrl |
|
path |
string |
De doel-blob of virtuele map in de Azure Storage-container. |
uploadHeaders |
Een lijst met naam-waardeparen voor headers die moeten worden gebruikt bij het uploaden van uitvoerbestanden |
OutputFileDestination
Het doel waarnaar een bestand moet worden geüpload.
Name | Type | Description |
---|---|---|
container |
Een locatie in Azure Blob Storage waarnaar bestanden worden geüpload. |
OutputFileUploadCondition
De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload.
Name | Type | Description |
---|---|---|
taskcompletion |
string |
Upload de bestanden nadat het taakproces is afgesloten, ongeacht de afsluitcode. |
taskfailure |
string |
Upload de bestanden pas nadat het taakproces is afgesloten met een andere afsluitcode dan nul. |
tasksuccess |
string |
Upload de bestanden pas nadat het taakproces is afgesloten met de afsluitcode 0. |
OutputFileUploadOptions
Details over een uploadbewerking voor uitvoerbestanden, waaronder onder welke voorwaarden het uploaden moet worden uitgevoerd.
Name | Type | Description |
---|---|---|
uploadCondition |
De voorwaarden waaronder het taakuitvoerbestand of de set bestanden moet worden geüpload. |
PoolEndpointConfiguration
De eindpuntconfiguratie voor een pool.
Name | Type | Description |
---|---|---|
inboundNATPools |
Een lijst met binnenkomende NAT-pools die kunnen worden gebruikt om specifieke poorten op een afzonderlijk rekenknooppunt extern aan te pakken. |
PoolInformation
Hiermee geeft u op hoe een taak moet worden toegewezen aan een pool.
Name | Type | Description |
---|---|---|
autoPoolSpecification |
Kenmerken voor een tijdelijke 'autopool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden. |
|
poolId |
string |
De id van een bestaande pool. Alle taken van de taak worden uitgevoerd op de opgegeven pool. |
PoolLifetimeOption
De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools.
Name | Type | Description |
---|---|---|
job |
string |
De pool bestaat voor de levensduur van de taak waaraan deze is toegewezen. De Batch-service maakt de pool wanneer deze de taak maakt. Als de optie 'taak' wordt toegepast op een taakplanning, maakt de Batch-service een nieuwe automatische pool voor elke taak die volgens de planning wordt gemaakt. |
jobschedule |
string |
De pool bestaat voor de levensduur van de taakplanning. De Batch-service maakt de pool wanneer de eerste taak in de planning wordt gemaakt. U kunt deze optie alleen toepassen op taakplanningen, niet op taken. |
PoolSpecification
Specificatie voor het maken van een nieuwe pool.
Name | Type | Description |
---|---|---|
applicationLicenses |
string[] |
De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool. |
applicationPackageReferences |
De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. |
|
autoScaleEvaluationInterval |
string |
Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast op basis van de formule voor automatische schaalaanpassing. |
autoScaleFormula |
string |
De formule voor het gewenste aantal rekenknooppunten in de pool. |
certificateReferences |
Een lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie . |
|
cloudServiceConfiguration |
De cloudserviceconfiguratie voor de pool. |
|
displayName |
string |
De weergavenaam voor de pool. |
enableAutoScale |
boolean |
Of de poolgrootte automatisch moet worden aangepast in de loop van de tijd. |
enableInterNodeCommunication |
boolean |
Of de pool directe communicatie tussen rekenknooppunten toestaat. |
metadata |
Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. |
|
mountConfiguration |
Een lijst met bestandssystemen die aan elk knooppunt in de pool moeten worden gekoppeld. |
|
networkConfiguration |
De netwerkconfiguratie voor de pool. |
|
resizeTimeout |
string |
De time-out voor de toewijzing van rekenknooppunten aan de pool. |
resourceTags |
object |
De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool. |
startTask |
Een taak die moet worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt opgestart. |
|
targetDedicatedNodes |
integer |
Het gewenste aantal toegewezen rekenknooppunten in de pool. |
targetLowPriorityNodes |
integer |
Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool. |
targetNodeCommunicationMode |
De gewenste knooppuntcommunicatiemodus voor de pool. |
|
taskSchedulingPolicy |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
|
taskSlotsPerNode |
integer |
Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. |
userAccounts |
De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool. |
|
virtualMachineConfiguration |
De configuratie van de virtuele machine voor de pool. |
|
vmSize |
string |
De grootte van de virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. |
PublicIPAddressConfiguration
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.
Name | Type | Description |
---|---|---|
ipAddressIds |
string[] |
De lijst met openbare IP-adressen die door de Batch-service worden gebruikt bij het inrichten van rekenknooppunten. |
provision |
Het inrichtingstype voor openbare IP-adressen voor de groep. |
ResourceFile
Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.
Name | Type | Description |
---|---|---|
autoStorageContainerName |
string |
De naam van de opslagcontainer in het automatische opslagaccount. |
blobPrefix |
string |
Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de naam begint met het opgegeven voorvoegsel, worden gedownload. |
fileMode |
string |
Het kenmerk bestandsmachtigingsmodus in octale indeling. |
filePath |
string |
De locatie op het rekenknooppunt waarnaar het bestand(en) moet worden gedownload, ten opzichte van de werkmap van de taak. |
httpUrl |
string |
De URL van het bestand dat u wilt downloaden. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door storageContainerUrl of httpUrl |
|
storageContainerUrl |
string |
De URL van de blobcontainer in Azure Blob Storage. |
Schedule
De planning volgens welke taken worden gemaakt. Alle tijden worden vastgesteld in respectievelijk UTC en worden niet beïnvloed door zomertijd.
Name | Type | Description |
---|---|---|
doNotRunAfter |
string |
Een tijd waarna er geen taak wordt gemaakt onder deze taakplanning. De planning wordt verplaatst naar de voltooide status zodra deze deadline voorbij is en er geen actieve taak onder deze taakplanning is. |
doNotRunUntil |
string |
Het vroegste tijdstip waarop een taak kan worden gemaakt onder deze taakplanning. |
recurrenceInterval |
string |
Het tijdsinterval tussen de begintijden van twee opeenvolgende taken onder de taakplanning. Een taakplanning kan op elk gewenst moment maximaal één actieve taak bevatten. |
startWindow |
string |
Het tijdsinterval, beginnend vanaf het tijdstip waarop volgens de planning een taak moet worden gemaakt, waarbinnen een taak moet worden gemaakt. |
SecurityProfile
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hiermee schakelt u de versleuteling in voor alle schijven, inclusief de resource-/tijdelijke schijf op de host zelf. |
securityType |
Hiermee geeft u het Beveiligingstype van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. |
|
uefiSettings |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij het maken van de virtuele machine. |
SecurityTypes
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.
Name | Type | Description |
---|---|---|
trustedLaunch |
string |
Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken. |
ServiceArtifactReference
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën.
Name | Type | Description |
---|---|---|
id |
string |
De serviceartefactreferentie-id van ServiceArtifactReference |
StartTask
Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt geïnstalleerd.
Name | Type | Description |
---|---|---|
commandLine |
string |
De opdrachtregel van de StartTask. |
containerSettings |
De instellingen voor de container waaronder StartTask wordt uitgevoerd. |
|
environmentSettings |
Een lijst met omgevingsvariabeleinstellingen voor de StartTask. |
|
maxTaskRetryCount |
integer |
Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. |
resourceFiles |
Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers. |
|
userIdentity |
De gebruikersidentiteit waaronder de StartTask wordt uitgevoerd. |
|
waitForSuccess |
boolean |
Of de Batch-service moet wachten tot de StartTask is voltooid (dat wil gezegd, afsluiten met afsluitcode 0) voordat taken op het rekenknooppunt worden gepland. |
StorageAccountType
Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven.
Name | Type | Description |
---|---|---|
premium_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van premium lokaal redundante opslag. |
standard_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet standaard lokaal redundante opslag gebruiken. |
standardssd_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van lokaal redundante standaard-SSD-opslag. |
TaskConstraints
Uitvoeringsbeperkingen die moeten worden toegepast op een taak.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
Het maximum aantal keren dat de taak opnieuw kan worden uitgevoerd. De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode een andere is dan nul. |
maxWallClockTime |
string |
De maximaal verstreken tijd die de taak mag uitvoeren, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet wordt voltooid, wordt deze door de Batch-service beëindigd. |
retentionTime |
string |
De minimale tijd voor het bewaren van de taakmap op het rekenknooppunt waar het is uitgevoerd, vanaf het moment dat de uitvoering is voltooid. Na deze tijd kan de Batch-service de taakmap en alle inhoud ervan verwijderen. |
TaskContainerSettings
De containerinstellingen voor een taak.
Name | Type | Description |
---|---|---|
containerRunOptions |
string |
Aanvullende opties voor de opdracht container maken. |
imageName |
string |
De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. |
registry |
Het persoonlijke register dat de containerinstallatiekopieën bevat. |
|
workingDirectory |
De locatie van de werkmap van de containertaak. |
TaskSchedulingPolicy
Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.
Name | Type | Description |
---|---|---|
nodeFillType |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
UefiSettings
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine.
Name | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine. |
vTpmEnabled |
boolean |
Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine. |
UserAccount
Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt.
Name | Type | Description |
---|---|---|
elevationLevel |
Het uitbreidingsniveau van het gebruikersaccount. |
|
linuxUserConfiguration |
De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount. |
|
name |
string |
De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten met een maximale lengte van 20. |
password |
string |
Het wachtwoord voor het gebruikersaccount. |
windowsUserConfiguration |
De Windows-specifieke gebruikersconfiguratie voor het gebruikersaccount. |
UserIdentity
De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
Name | Type | Description |
---|---|---|
autoUser |
De automatische gebruiker waaronder de taak wordt uitgevoerd. |
|
username |
string |
De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
VirtualMachineConfiguration
De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.
Name | Type | Description |
---|---|---|
containerConfiguration |
De containerconfiguratie voor de pool. |
|
dataDisks |
Data |
De configuratie voor gegevensschijven die zijn gekoppeld aan de rekenknooppunten in de pool. |
diskEncryptionConfiguration |
De schijfversleutelingsconfiguratie voor de pool. |
|
extensions |
De extensie van de virtuele machine voor de pool. |
|
imageReference |
Een verwijzing naar de Azure Virtual Machines Marketplace-installatiekopieën of de aangepaste vm-installatiekopieën die moeten worden gebruikt. |
|
licenseType |
string |
Het type on-premises licentie dat moet worden gebruikt bij het implementeren van het besturingssysteem. Windows_Server: de on-premises licentie is voor Windows Server. Windows_Client: de on-premises licentie is voor Windows Client. |
nodeAgentSKUId |
string |
De SKU van de Batch Compute Node-agent die moet worden ingericht op rekenknooppunten in de pool. |
nodePlacementConfiguration |
De configuratie van de knooppuntplaatsing voor de pool. |
|
osDisk |
Instellingen voor de besturingssysteemschijf van de virtuele machine. |
|
securityProfile |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
|
serviceArtifactReference |
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën. |
|
windowsConfiguration |
Windows-besturingssysteeminstellingen op de virtuele machine. |
VMExtension
De configuratie voor extensies van virtuele machines.
Name | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie is geïmplementeerd, worden secundaire versies echter niet bijgewerkt, tenzij opnieuw geïmplementeerd, zelfs als deze eigenschap is ingesteld op true. |
enableAutomaticUpgrade |
boolean |
Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is. |
name |
string |
De naam van de extensie van de virtuele machine. |
protectedSettings |
object |
De extensie kan protectedSettings of protectedSettingsFromKeyVault bevatten of helemaal geen beveiligde instellingen bevatten. |
provisionAfterExtensions |
string[] |
De verzameling extensienamen. |
publisher |
string |
De naam van de uitgever van de extensie-handler. |
settings |
object |
Met JSON opgemaakte openbare instellingen voor de extensie. |
type |
string |
Het type van de extensie. |
typeHandlerVersion |
string |
De versie van scripthandler. |
WindowsConfiguration
Instellingen van het Windows-besturingssysteem die moeten worden toegepast op de virtuele machine.
Name | Type | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Of automatische updates zijn ingeschakeld op de virtuele machine. |
WindowsUserConfiguration
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows Compute-knooppunt.
Name | Type | Description |
---|---|---|
loginMode |
De aanmeldingsmodus voor de gebruiker |