Omgevingsvariabelen van Azure Batch Runtime
De Azure Batch-service stelt de volgende omgevingsvariabelen in op rekenknooppunten. U kunt naar deze omgevingsvariabelen verwijzen in taakopdrachtregels en in de programma's en scripts die worden uitgevoerd door de opdrachtregels.
Zie Omgevingsinstellingen voor taken voor meer informatie over het gebruik van omgevingsvariabelen met Batch.
Zichtbaarheid van omgevingsvariabelen
Deze omgevingsvariabelen zijn alleen zichtbaar in de context van de taakgebruiker. Dit is het gebruikersaccount op het knooppunt waaronder een taak wordt uitgevoerd. U ziet deze variabelen niet wanneer u extern verbinding maakt met een rekenknooppunt via Remote Desktop Protocol (RDP) of Secure Shell (SSH) en omgevingsvariabelen weergeeft. Dit komt doordat het gebruikersaccount dat voor de externe verbinding wordt gebruikt, niet hetzelfde is als het account dat door de taak wordt gebruikt.
Als u de huidige waarde van een omgevingsvariabele wilt ophalen, start u cmd.exe
op een Windows-rekenknooppunt of /bin/sh
op een Linux-knooppunt:
cmd /c set <ENV_VARIABLE_NAME>
/bin/sh -c "printenv <ENV_VARIABLE_NAME>"
Opdrachtregeluitbreiding van omgevingsvariabelen
De opdrachtregels die door taken op rekenknooppunten worden uitgevoerd, worden niet uitgevoerd onder een shell. Dit betekent dat deze opdrachtregels geen systeemeigen shellfuncties kunnen gebruiken, zoals uitbreiding van omgevingsvariabelen (inclusief de PATH
). Als u dergelijke functies wilt gebruiken, moet u de shell aanroepen op de opdrachtregel. Start cmd.exe
bijvoorbeeld op Windows-rekenknooppunten of /bin/sh
op Linux-knooppunten:
cmd /c MyTaskApplication.exe %MY_ENV_VAR%
/bin/sh -c "MyTaskApplication $MY_ENV_VAR"
Omgevingsvariabelen
Notitie
AZ_BATCH_AUTHENTICATION_TOKEN
wordt afgeschaft en wordt buiten gebruik gesteld op 30 september 2024. Zie de aankondiging voor details en alternatieve implementatie.
Variabelenaam | Omschrijving | Beschikbaarheid | voorbeeld |
---|---|---|---|
AZ_BATCH_ACCOUNT_NAME | De naam van het Batch-account waartoe de taak behoort. | Alle taken. | mybatchaccount |
AZ_BATCH_ACCOUNT_URL | De URL van het Batch-account. | Alle taken. | https://myaccount.westus.batch.azure.com |
AZ_BATCH_APP_PACKAGE | Een voorvoegsel van alle omgevingsvariabelen van het app-pakket. Als de toepassing 'FOO' versie 1 bijvoorbeeld is geïnstalleerd op een pool, wordt de omgevingsvariabele AZ_BATCH_APP_PACKAGE_FOO_1 (op Linux) of AZ_BATCH_APP_PACKAGE_FOO#1 (in Windows). AZ_BATCH_APP_PACKAGE_FOO_1 verwijst naar de locatie waar het pakket is gedownload (een map). Wanneer u de standaardversie van het app-pakket gebruikt, gebruikt u de omgevingsvariabele AZ_BATCH_APP_PACKAGE zonder de versienummers. Als in Linux en de naam van het toepassingspakket 'Agent-linux-x64' is en de versie 1.1.46.0 is, is de omgevingsnaam eigenlijk: AZ_BATCH_APP_PACKAGE_agent_linux_x64_1_1_46_0, met onderstrepingstekens en kleine letters. Zie De geïnstalleerde toepassingen uitvoeren voor meer informatie. | Elke taak met een gekoppeld app-pakket. Ook beschikbaar voor alle taken als het knooppunt zelf toepassingspakketten heeft. | AZ_BATCH_APP_PACKAGE_FOO_1 (Linux) of AZ_BATCH_APP_PACKAGE_FOO#1 (Windows) |
AZ_BATCH_AUTHENTICATION_TOKEN | Een verificatietoken dat toegang verleent tot een beperkte set Batch-servicebewerkingen. Deze omgevingsvariabele is alleen aanwezig als het authenticationToken Instellingen worden ingesteld wanneer de taak wordt toegevoegd. De tokenwaarde wordt gebruikt in de Batch-API's als referenties voor het maken van een Batch-client, zoals in de .NET API BatchClient.Open(). Het token biedt geen ondersteuning voor privénetwerken. | Alle taken. | OAuth2-toegangstoken |
AZ_BATCH_CERTIFICATES_DIR | Een map in de werkmap van de taak waarin certificaten worden opgeslagen voor Linux-rekenknooppunten. Deze omgevingsvariabele is niet van toepassing op Windows-rekenknooppunten. | Alle taken. | /mnt/batch/tasks/workitems/batchjob001/job-1/task001/certs |
AZ_BATCH_HOST_LIST | De lijst met knooppunten die zijn toegewezen aan een taak met meerdere exemplaren in de indeling nodeIP,nodeIP . |
Primaire en subtaken met meerdere exemplaren. | 10.0.0.4,10.0.0.5 |
AZ_BATCH_IS_CURRENT_NODE_MASTER | Hiermee geeft u op of het huidige knooppunt het hoofdknooppunt is voor een taak met meerdere exemplaren. Mogelijke waarden zijn true en false . |
Primaire en subtaken met meerdere exemplaren. | true |
AZ_BATCH_JOB_ID | De ID van de job waartoe de taak behoort. | Alle taken behalve begintaak. | batchjob001 |
AZ_BATCH_JOB_PREP_DIR | Het volledige pad van de taakmap voor taakvoorbereiding op het knooppunt. | Alle taken behalve begintaak en taakvoorbereidingstaak. Alleen beschikbaar als de taak is geconfigureerd met een taakvoorbereidingstaak. | C:\user\tasks\workitems\jobprepreleasesamplejob\job-1\jobpreparation |
AZ_BATCH_JOB_PREP_WORKING_DIR | Het volledige pad van de werkmap van de taakvoorbereidingstaak op het knooppunt. | Alle taken behalve begintaak en taakvoorbereidingstaak. Alleen beschikbaar als de taak is geconfigureerd met een taakvoorbereidingstaak. | C:\user\tasks\workitems\jobprepreleasesamplejob\job-1\jobpreparation\wd |
AZ_BATCH_MASTER_NODE | Het IP-adres en de poort van het rekenknooppunt waarop de primaire taak van een taak met meerdere exemplaren wordt uitgevoerd. Gebruik de poort die hier is opgegeven voor MPI- of NCCL-communicatie niet. Deze is gereserveerd voor de Azure Batch-service. Gebruik in plaats daarvan de variabele MASTER_PORT door deze in te stellen met een waarde die wordt doorgegeven via het opdrachtregelargument (poort 6105 is een goede standaardoptie) of door de waarde AML-sets te gebruiken als dit het geval is. | Primaire en subtaken met meerdere exemplaren. | 10.0.0.4:6000 |
AZ_BATCH_NODE_ID | De id van het knooppunt waaraan de taak is toegewezen. | Alle taken. | tvm-1219235766_3-20160919t172711z |
AZ_BATCH_NODE_IS_DEDICATED | Als true , het huidige knooppunt is een toegewezen knooppunt. Als false het een Azure Spot-knooppunt is. |
Alle taken. | true |
AZ_BATCH_NODE_LIST | De lijst met knooppunten die zijn toegewezen aan een taak met meerdere exemplaren in de indeling nodeIP;nodeIP . |
Primaire en subtaken met meerdere exemplaren. | 10.0.0.4;10.0.0.5 |
AZ_BATCH_NODE_MOUNTS_DIR | Het volledige pad van de koppellocatie van het bestandssysteem op knooppuntniveau waar alle koppelmappen zich bevinden. Windows-bestandsshares gebruiken een stationsletter, dus voor Windows maakt het koppelstation deel uit van apparaten en stations. | Alle taken, waaronder de begintaak, hebben toegang tot de gebruiker, aangezien de gebruiker op de hoogte is van de koppelingsmachtigingen voor de gekoppelde map. | In Ubuntu is de locatie bijvoorbeeld: /mnt/batch/tasks/fsmounts |
AZ_BATCH_NODE_ROOT_DIR | Het volledige pad van de hoofdmap van alle Batch-mappen op het knooppunt. | Alle taken. | C:\user\tasks |
AZ_BATCH_NODE_SHARED_DIR | Het volledige pad van de gedeelde map op het knooppunt. Alle taken die op een knooppunt worden uitgevoerd, hebben lees-/schrijftoegang tot deze map. Taken die worden uitgevoerd op andere knooppunten hebben geen externe toegang tot deze map (het is geen 'gedeelde' netwerkmap). | Alle taken. | C:\user\tasks\shared |
AZ_BATCH_NODE_STARTUP_DIR | Het volledige pad van de begintaakmap op het knooppunt. | Alle taken. | C:\user\tasks\startup |
AZ_BATCH_POOL_ID | De ID van de pool waarin de taak wordt uitgevoerd. | Alle taken. | batchpool001 |
AZ_BATCH_TASK_DIR | Het volledige pad van de taakmap op het knooppunt. Deze map bevat de stdout.txt en stderr.txt voor de taak en de AZ_BATCH_TASK_WORKING_DIR. |
Alle taken. | C:\user\tasks\workitems\batchjob001\job-1\task001 |
AZ_BATCH_TASK_ID | De id van de huidige taak. | Alle taken behalve begintaak. | task001 |
AZ_BATCH_TASK_SHARED_DIR | Een mappad dat identiek is voor de primaire taak en elke subtaak van een taak met meerdere exemplaren. Het pad bestaat op elk knooppunt waarop de taak met meerdere exemplaren wordt uitgevoerd en is toegankelijk voor de taakopdrachten die op dat knooppunt worden uitgevoerd (zowel de coördinatieopdracht als de toepassingsopdracht. Subtaken of een primaire taak die wordt uitgevoerd op andere knooppunten hebben geen externe toegang tot deze map (dit is geen gedeelde netwerkmap). | Primaire en subtaken met meerdere exemplaren. | C:\user\tasks\workitems\multiinstancesamplejob\job-1\multiinstancesampletask |
AZ_BATCH_TASK_WORKING_DIR | Het volledige pad van de werkmap van de taak op het knooppunt. De taak die momenteel wordt uitgevoerd, heeft lees-/schrijftoegang tot deze map. | Alle taken. | C:\user\tasks\workitems\batchjob001\job-1\task001\wd |
AZ_BATCH_TASK_RESERVED_EPHEMERAL_DISK_SPACE_BYTES | De huidige drempelwaarde voor schijfruimte waarop de virtuele machine wordt gemarkeerd als DiskFull . |
Alle taken. | 1000000 |
CCP_NODES | De lijst met knooppunten en het aantal kernen per knooppunt dat is toegewezen aan een taak met meerdere exemplaren. Knooppunten en kernen worden vermeld in de indeling numNodes<space>node1IP<space>node1Cores<space> node2IP<space>node2Cores<space> ... , waarbij het aantal knooppunten wordt gevolgd door een of meer IP-adressen van knooppunten en het aantal kernen voor elk knooppunt. |
Primaire en subtaken met meerdere exemplaren. | 2 10.0.0.4 1 10.0.0.5 1 |
Volgende stappen
- Meer informatie over het gebruik van omgevingsvariabelen met Batch.
- Meer informatie over bestanden en mappen in Batch
- Meer informatie over taken met meerdere exemplaren.