Batch-Management REST-API-Versionsmanagement

Die von der Batch Management REST API bereitgestellten Operationen können mehrere Versionen zur Abwärtskompatibilität haben, da sich die API im Laufe der Zeit weiterentwickelt. Sie müssen angeben, welche Version einer Operation Sie verwenden möchten, wenn sie aufgerufen wird, indem Sie die Version mit Ihrem REST-Aufruf bereitstellen. Wenn Ihre Anwendung eine ältere Version einer Operation aufruft, können Sie wählen, ob Sie die ältere Version weiterhin aufrufen oder Ihren Code ändern, um eine neuere Version aufzurufen. Wenn die Version nicht angegeben ist oder eine falsche Version angegeben wird, wird ein Fehler zurückgegeben.

Um anzugeben, welche Version einer Operation verwendet werden soll, setzen Sie den API-Version-Abfrageparameter . Die Version entspricht dem Format YYYY-MM-DD.

Neueste Version: 01.06.2025

• Job-Level FIFO

  • Neue Schrift hinzugefügt JobDefaultOrder .
  • Erweitert TaskSchedulingPolicy mit einer neuen jobDefaultOrder Immobilie, um die FIFO-Planung auf Jobniveau zu unterstützen.

• CMK-Unterstützung bei Pools

  • Hinzugefügt DiskCustomerManagedKey für kundenverwaltete Schlüsselunterstützung (CMK) bei Pools.
  • Erweitert DiskEncryptionConfiguration mit einer neuen customerManagedKey Immobilie.
  • Erweitert ManagedDisk mit einer neuen diskEncryptionSet Immobilie.
  • Hinzugefügt DiskEncryptionSetParameters zum Referenzieren von Festplattenverschlüsselungssätzen.

• IPv6-Unterstützung bei Pools

  • Neue Schrift hinzugefügt IPFamily .
  • Erweitert PublicIPAddressConfiguration mit neuen ipFamilies und ipTags Immobilien.

• Unterstützung für Metadaten-Sicherheitsprotokolle in Pools

  • Hinzugefügt HostEndpointSettings und HostEndpointSettingsModeTypes.
  • ProxyAgentSettings wurde hinzugefügt.
  • Erweitert SecurityProfile mit einer neuen proxyAgentSettings Eigenschaft für die Unterstützung von Metadaten-Sicherheitsprotokollen.

• IP-Tag-Unterstützung

  • Neue Schrift hinzugefügt IPTag .
  • Erweitert PublicIPAddressConfiguration mit neuer ipTags Eigenschaft für IP-Tag-Unterstützung.

• [Zerbrechen] Entfernte Unterstützung für Zertifikate:

  • Entfernte Zertifikats-APIs: Certificate_ListByBatchAccount, Certificate_Get, , Certificate_Create, Certificate_Update, Certificate_Deleteund Certificate_CancelDeletion.
  • Entfernte Zertifikatsmodelle: Certificate, , , CertificateBaseProperties, CertificateCreateOrUpdateProperties, CertificateProperties, CertificateFormat, CertificateProvisioningStateCertificateVisibilityCertificateReferenceCertificateStoreLocationund .DeleteCertificateErrorCertificateCreateOrUpdateParameters
  • Eigentum aus dem Pool entfernt certificates .

• [Zerbrechen] Modell und Eigenschaften targetNodeCommunicationMode sowie currentNodeCommunicationMode aus dem Pool entferntNodeCommunicationMode.

• [Zerbrechen] Eigentum aus dem Pool entfernt applicationLicenses .

• [Zerbrechen] Entfernt storageAccountType aus DataDisk. Verwenden Sie stattdessen ManagedDisk.storageAccountType.

• [Zerbrechen] Aus dem Pool entfernt resourceTags .

Frühere Versionen

Frühere Versionen umfassen:

• 2024-07-01
• 2024-02-01
• 2023-11-01
• 2023-05-01
• 2022-10-01
• 2022-06-01
• 2022-01-01
• 2021-06-01
• 2021-01-01
• 2020-09-01
• 2020-05-01
• 2020-03-01
• 2019-08-01
• 2019-04-01
• 2018-12-01
• 2017-09-01
• 2017-05-01
• 2017-01-01
• 2015-12-01

Version: 01.07.2024

• Unterstützung für Network Security Perimeter (NSP) hinzugefügt:

  • Operation hinzugefügt NetworkSecurityPerimeter_ListConfigurations , um alle NSP-Konfigurationen in einem Batch-Konto aufzulisten.
  • Operation hinzugefügt NetworkSecurityPerimeter_GetConfiguration , um eine spezifische NSP-Konfiguration zu erhalten.
  • Operation hinzugefügt NetworkSecurityPerimeter_ReconcileConfiguration , um eine NSP-Konfiguration abzugleichen.
  • Mehrwert SecuredByPerimeter für PublicNetworkAccessType Enum.

• Vertrauliche VM-Unterstützung hinzugefügt:

  • Modell mit einer securityEncryptionType Eigenschaft hinzugefügtVMDiskSecurityProfile.
  • Eigenschaft zu hinzugefügtsecurityProfile.ManagedDisk
  • Hinzugefügt confidentialVM als neuer Wert für SecurityTypes Enum.

• Hinzugefügte Unterstützung für Shared Gallery und Community Gallery Bildreferenzen:

  • Hinzugefügte sharedGalleryImageId und communityGalleryImageId Eigenschaften zu ImageReference.

• Container-Bind-Mount-Unterstützung für Aufgaben hinzugefügt:

  • Modell mit source und isReadOnly Eigenschaften hinzugefügtContainerHostBatchBindMountEntry.
  • Hinzugefügtes Enum mit den Werten ContainerHostDataPathShared, Startup, VfsMounts, Task, JobPrepund Applications.
  • Eigenschaft zu hinzugefügtcontainerHostBatchBindMounts.TaskContainerSettings

• [Zerbrechen] Entfernte Unterstützung für Cloud Service Configuration Pool:

  • Modell entfernt CloudServiceConfiguration .
  • cloudServiceConfiguration Eigenschaft entfernt aus DeploymentConfiguration.
  • Operation entfernt Location_ListSupportedCloudServiceSkus .

Version: 01.02.2024

• Hinzugefügte Unterstützung für Betriebssystem-Upgrade-Richtlinien für VM-Pools:

  • Hinzugefügtes UpgradePolicy Modell mit den Eigenschaften mode, automaticOSUpgradePolicy, und rollingUpgradePolicy.
  • Hinzugefügtes AutomaticOSUpgradePolicy Modell mit den Eigenschaften disableAutomaticRollback, enableAutomaticOSUpgrade, useRollingUpgradePolicy, und osRollingUpgradeDeferral.
  • Hinzugefügtes RollingUpgradePolicy Modell mit den Eigenschaften enableCrossZoneUpgrade, maxBatchInstancePercent, , maxUnhealthyUpgradedInstancePercentmaxUnhealthyInstancePercent, pauseTimeBetweenBatches, prioritizeUnhealthyInstances, und rollbackFailedInstancesOnPolicyBreach.
  • Pool-Property wurde hinzugefügt upgradePolicy .
  • Hinzugefügtes Enum mit den Werten UpgradeModeautomatic, manual, und rolling.

• Eigenschaft zu hinzugefügtbatchSupportEndOfLife.SupportedSku

Version: 01.11.2023

• Hinzugefügte Unterstützung für Trusted Launch / Sicherheitsprofile für VM-Pools:

  • Hinzugefügtes SecurityProfile Modell mit den Eigenschaften encryptionAtHost, securityType, und uefiSettings.
  • Hinzugefügtes UefiSettings Modell mit Eigenschaften secureBootEnabled und vTpmEnabled.
  • Enum mit Werten trustedLaunchhinzugefügtSecurityTypes.
  • Eigenschaft zu hinzugefügtsecurityProfile.VirtualMachineConfiguration

• Zusätzliche Unterstützung für Serviceartefakte-Referenzen für Skalierungssätze:

  • Modell mit einer erforderlichen id Eigenschaft hinzugefügtServiceArtifactReference.
  • Eigenschaft zu hinzugefügtserviceArtifactReference.VirtualMachineConfiguration

• Erweiterte OS-Festplattenkonfiguration:

  • Modell mit einer storageAccountType Eigenschaft hinzugefügtManagedDisk.
  • Hinzugefügte caching, diskSizeGB, managedDisk, und writeAcceleratorEnabled Eigenschaften zu OSDisk.

• Hinzugefügt StandardSSD_LRS als neuer Wert für StorageAccountType.

• Property zu Pool hinzugefügt resourceTags , damit benutzerdefinierte Tags auf die Azure-Ressourcen übertragen werden können. Gilt nur, wenn poolAllocationModeUserSubscriptionist.

Version: 01.05.2023

• Boolesche Eigenschaft enableAcceleratedNetworking wurde hinzugefügt.NetworkConfiguration

  • Diese Eigenschaft bestimmt, ob dieser Pool beeiltes Netzwerken ermöglichen sollte, wobei der Standardwert als falsch gilt.
  • Ob diese Funktion aktiviert werden kann, hängt auch davon ab, ob eine Betriebssystem-/VM-Instanz unterstützt wird, was mit der AcceleratedNetworking Policy übereinstimmen sollte.

• Boolesche Eigenschaft enableAutomaticUpgrade wurde hinzugefügt.VMExtension

  • Diese Eigenschaft bestimmt, ob die Erweiterung automatisch aktualisiert werden sollte, falls eine neuere Version der Erweiterung verfügbar ist.

• Die Eigenschaft type von ContainerConfiguration jetzt unterstützt zwei Werte: DockerCompatible und CriCompatible.

Version: 01.10.2022

• Enum mit den Werten NodeCommunicationModeDefault, Classic, hinzugefügt und Simplified um zu bestimmen, wie ein Pool mit dem Batch-Service kommuniziert.
• currentNodeCommunicationMode Hinzugefügte Eigenschaft zu Pool, um auf den aktuellen Stand des Pool-Kommunikationsmodus zu verweisen.
• Dem Pool wurde eine Eigenschaft hinzugefügt targetNodeCommunicationMode , um auf den gewünschten Knotenkommunikationsmodus für den Pool zu verweisen.

Version: 01.06.2022

• Operation hinzugefügt PrivateEndpointConnection_Delete , um eine private Endpunktverbindung zu löschen.
• allowedAuthenticationModes Hinzufügen von Eigenschaften BatchAccountCreateProperties zu und BatchAccountUpdateProperties zur Steuerung der Authentifizierungsmodi.
• Hinzugefügt TaskAuthenticationToken als neuer Wert für AuthenticationMode Enum.

Version: 01.01.2022

• Operation hinzugefügt Location_ListSupportedVirtualMachineSkus , um unterstützte VM-SKUs an einem bestimmten Ort aufzulisten.
• Hinzugefügtes SupportedSku Modell mit den Eigenschaften name, familyName, und capabilities.
• Neues Modell hinzugefügt SupportedSkusResult .
• Neues Modell hinzugefügt SkuCapability .

Version: 01.06.2021

• Hinzugefügte Möglichkeit, benutzerdefinierte verwaltete Identitäten zuzuweisen BatchPoolIdentity.
• Property wurde identityReference hinzugefügt, AzureBlobFileSystemConfigurationContainerRegistry, , und ResourceFile um den Zugriff auf Ressourcen über eine verwaltete Identität zu unterstützen.
• VM-Erweiterungsunterstützung hinzugefügt:
  • Eigenschaft zu hinzugefügtextensions.VirtualMachineConfiguration
  • Neues Modell hinzugefügt VMExtension .
• Die Möglichkeit hinzugefügt, Verfügbarkeitszonen mit einer neuen Eigenschaft nodePlacementConfiguration auf VirtualMachineConfigurationzu spezifizieren.
  • Modell mit einer policy Eigenschaft hinzugefügtNodePlacementConfiguration.
  • Enum mit den Werten Regional und ZonalhinzugefügtNodePlacementPolicyType.
• Hinzugefügte osDiskVirtualMachineConfiguration Eigenschaft mit ephemeraler OS-Festplatten-Unterstützung über DiffDiskSettings.

Version: 01.01.2021

• Zusätzliche Möglichkeit, Kundendaten mit kundenverwalteten Schlüsseln zu verschlüsseln:
  • Modell mit keySource und keyVaultPropertieshinzugefügtEncryptionProperties.
  • Hinzugefügte KeySource Enum.
  • Neues Modell hinzugefügt KeyVaultProperties .
  • Attribute zu BatchAccountCreateProperties und BatchAccountPropertieshinzugefügtencryption.
• Modell wurde hinzugefügtBatchAccountIdentity, das , UserAssigned, und None Identitätstypen unterstütztSystemAssigned.
• Attribute zu BatchAccountCreateParameters und BatchAccountUpdateParametershinzugefügtidentity.
• Eigenschaft zu hinzugefügtallowedAuthenticationModes.BatchAccountProperties
• Operation hinzugefügt ListOutboundNetworkDependenciesEndpoints , um Endpunkte aufzulisten, die ein Batch-Compute-Knoten aufrufen kann.

Version: 01.09.2020

• Property zu Pool hinzugefügt taskSlotsPerNode , wodurch das feste Task-pro-Node-Verhalten ersetzt wurde.
• Hinzugefügt BatchAccountProperties.publicNetworkAccess , um den öffentlichen Netzwerkzugang zu kontrollieren.
• Hinzugefügtes NetworkProfile Modell zur Steuerung der Netzwerkzugriffsregeln pro Endpunkt.

Version: 01.05.2020

• Private Link-Unterstützung hinzugefügt:

  • Zusätzliche PrivateEndpointConnection_ListByBatchAccount Operation.
  • Zusätzliche PrivateEndpointConnection_Get Operation.
  • Zusätzliche PrivateEndpointConnection_Update Operation.
  • Zusätzliche PrivateLinkResource_ListByBatchAccount Operation.
  • Zusätzliche PrivateLinkResource_Get Operation.
  • Fügte , , , und PrivateLinkServiceConnectionState Models hinzuPrivateEndpointConnection. PrivateLinkResourcePrivateEndpoint

• Eigenschaft zu hinzugefügtpublicNetworkAccess.BatchAccountCreateProperties

Version: 01.03.2020

• Zusätzliche Möglichkeit, Compute-Node-Festplattenlaufwerke mit der DiskEncryptionConfiguration Eigenschaft zu VirtualMachineConfigurationverschlüsseln.
• Ein Modell wurde hinzugefügt PublicIPAddressConfiguration , um NetworkConfiguration Pools ohne öffentliche IPs zu unterstützen.
  • Hinzugefügtes Enum mit den Werten IPAddressProvisioningTypeBatchManaged, UserManaged, und NoPublicIPAddresses.
  • Eigenschaft zu hinzugefügtipAddressIds.PublicIPAddressConfiguration

Version: 01.08.2019

• Zusätzliche Möglichkeit, eine Sammlung öffentlicher IPs NetworkConfiguration über die publicIPs Eigenschaft anzugeben.
• Zusätzliche Möglichkeit, entfernte Dateisysteme auf jedem Knoten eines Pools zu mounten durch:MountConfiguration
  • Fügte , , , und AzureFileShareConfiguration Models hinzuAzureBlobFileSystemConfiguration. CIFSMountConfigurationNFSMountConfiguration
  • Pool-Property wurde hinzugefügt mountConfiguration .

Version: 01.04.2019

• Operation hinzugefügt Location_CheckNameAvailability , um zu prüfen, ob ein Batch-Kontoname verfügbar ist.
• Hinzugefügte CheckNameAvailabilityParameters und CheckNameAvailabilityResult Modelle.
• Zusätzliche DetectorResponse Unterstützung:
  • Zusätzliche BatchAccount_ListDetectors Operation.
  • Zusätzliche BatchAccount_GetDetector Operation.

Version: 01.12.2018

• Hinzugefügte containerConfiguration Eigenschaft VirtualMachineConfiguration für containerfähige Pools.
  • Neues Modell hinzugefügt ContainerConfiguration .
  • Neues Modell hinzugefügt ContainerRegistry .
  • Neues Modell hinzugefügt TaskContainerSettings .
• Ich habe Pool eine Eigenschaft mit voller StartTask Modellunterstützung hinzugefügtstartTask.
• dataDisks Hinzugefügte Eigenschaft VirtualMachineConfiguration zum Anhängen von Datenfestplatten.
• Für Azure Hybrid Use Benefit wurde eine Eigenschaft VirtualMachineConfiguration hinzugefügtlicenseType.
• Enum mit den Werten StorageKeys und BatchAccountManagedIdentityhinzugefügtAutoStorageAuthenticationMode.
• Eigenschaft zu hinzugefügtnodeIdentityReference.AutoStorageBaseProperties
• Modell mit , endpointConfiguration, und dynamicVnetAssignmentScope Eigenschaften hinzugefügtNetworkConfiguration.subnetId
• Hinzugefügte PoolEndpointConfiguration Modelle InboundNatPool zur Spezifikation von eingehenden Endpunkten.

Version: 01.09.2017

• Zusätzliche Unterstützung für das Poolmanagement über ARM:
  • Hinzugefügte Pool_ListByBatchAccount, Pool_Get, Pool_Create, Pool_Update, Operationen Pool_Delete .
  • Hinzugefügt Pool_DisableAutoScale und Pool_StopResize Operationen.
  • Hinzugefügtes Pool Ressourcenmodell mit umfassenden Pool-Eigenschaften.
• Zusätzliche Zertifikatsverwaltung über ARM:
  • Hinzugefügte Certificate_ListByBatchAccount, Certificate_Get, Certificate_Create, Certificate_Update, Certificate_Delete, Operationen Certificate_CancelDeletion .
• Hinzugefügte Anwendungs- und ApplicationPackage-Verwaltung:
  • Hinzugefügte Application_List, Application_Get, Application_Create, Application_Update, Operationen Application_Delete .
  • Hinzugefügte ApplicationPackage_List, ApplicationPackage_Get, ApplicationPackage_Create, ApplicationPackage_Delete, Operationen ApplicationPackage_Activate .
• Ein Modell für die IaaS-VM-basierte Poolkonfiguration wurde hinzugefügt VirtualMachineConfiguration .
• Modell mit FixedScaleSettings und AutoScaleSettings zur Kontrolle der Poolgröße hinzugefügtScaleSettings.

Version: 01.05.2017

• Hinzugefügtes KeyVaultReference Modell für die Integration von Azure Key Vault mit Batch-Konten.
• Mit und Modi wurden Eigenschaften hinzugefügt poolAllocationModeBatchServiceBatchAccountCreateProperties.UserSubscription
• Hinzugefügte dedicatedCoreQuotaPerVMFamily und dedicatedCoreQuotaPerVMFamilyEnforced Eigenschaften zu BatchAccountProperties.
• Eigenschaft zu hinzugefügtlowPriorityCoreQuota.BatchAccountProperties

Version: 01.01.2017

• Unterstützung für benutzerzugewiesene Speicherkonten über automatische Speicherkonfiguration hinzugefügt.
• Eigenschaft zu hinzugefügtstorageAccountId.AutoStorageBaseProperties
• Modell mit lastKeySync Eigenschaft hinzugefügtAutoStorageProperties.
• Zusätzliche BatchAccount_SynchronizeAutoStorageKeys Operation.

Version: 01.12.2015

Dies ist die Erstversion der Batch Management REST API. Es bietet folgende Kernfunktionen:

• Batch-Kontoverwaltung:
  • BatchAccount_Create - Erstellt ein neues Batch-Konto mit festgelegten Parametern.
  • BatchAccount_Update - Aktualisiert die Eigenschaften eines bestehenden Batch-Kontos.
  • BatchAccount_Delete - Löscht das angegebene Batch-Konto.
  • BatchAccount_Get - Erhält Informationen über das angegebene Batch-Konto.
  • BatchAccount_List - Listet alle Batch-Konten unter einem Abonnement auf.
  • BatchAccount_ListByResourceGroup - Listet alle Batch-Konten unter einer Ressourcengruppe auf.
  • BatchAccount_GetKeys - Erhält die Kontoschlüssel für das angegebene Batch-Konto.
  • BatchAccount_RegenerateKey - Regeneriert den angegebenen Kontoschlüssel für das Batch-Konto.
• Standortbetrieb:
  • Location_GetQuotas - Erhält die Batch-Service-Quoten für das angegebene Abonnement am angegebenen Standort.
• Betrieb:
  • Operations_List - Listet verfügbare Operationen für den Batch-Anbieter auf.