Freigeben über


Batch Account - Create

Erstellt ein neues Batchkonto mit den angegebenen Parametern. Vorhandene Konten können nicht mit dieser API aktualisiert werden und sollten stattdessen mit der API für das Updatebatchkonto aktualisiert werden.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2024-07-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-z0-9]+$

Ein Name für das Batchkonto, das innerhalb der Region eindeutig sein muss. Batchkontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben verwenden. Dieser Name wird als Teil des DNS-Namens verwendet, der für den Zugriff auf den Batchdienst in der Region verwendet wird, in der das Konto erstellt wird. Beispiel: http://accountname.region.batch.azure.com/.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die das Batchkonto enthält.

subscriptionId
path True

string

Die Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-0000000000000)

api-version
query True

string

Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Die Region, in der das Konto erstellt werden soll.

identity

BatchAccountIdentity

Die Identität des Batchkontos.

properties.allowedAuthenticationModes

AuthenticationMode[]

Liste der zulässigen Authentifizierungsmodi für das Batchkonto, das zur Authentifizierung mit der Datenebene verwendet werden kann. Dies wirkt sich nicht auf die Authentifizierung mit der Steuerebene aus.

properties.autoStorage

AutoStorageBaseProperties

Die Eigenschaften im Zusammenhang mit dem automatischen Speicherkonto.

properties.encryption

EncryptionProperties

Die Verschlüsselungskonfiguration für das Batchkonto.
Konfiguriert, wie Kundendaten innerhalb des Batchkontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein vom Kunden verwalteter Schlüssel verwendet werden.

properties.keyVaultReference

KeyVaultReference

Ein Verweis auf den Azure Key Vault, der dem Batchkonto zugeordnet ist.

properties.networkProfile

NetworkProfile

Netzwerkprofil für Batchkonto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.
Das Netzwerkprofil wird nur wirksam, wenn publicNetworkAccess aktiviert ist.

properties.poolAllocationMode

PoolAllocationMode

Der Zuordnungsmodus, der zum Erstellen von Pools im Batchkonto verwendet werden soll.
Der Poolzuweisungsmodus wirkt sich auch darauf aus, wie Clients sich bei der Batchdienst-API authentifizieren können. Wenn der Modus BatchService ist, können Clients sich mit Zugriffstasten oder Microsoft Entra-ID authentifizieren. Wenn der Modus "UserSubscription" lautet, müssen Clients die Microsoft Entra-ID verwenden. Der Standardwert ist BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Zugriff auf das Azure Batch-Konto.
Wenn nicht angegeben, ist der Standardwert "aktiviert".

tags

object

Die vom Benutzer angegebenen Tags, die dem Konto zugeordnet sind.

Antworten

Name Typ Beschreibung
200 OK

BatchAccount

Der Vorgang war erfolgreich. Die Antwort enthält die Batchkontoentität.

202 Accepted

Der Vorgang wird asynchron abgeschlossen.

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

BatchAccountCreate_BYOS
BatchAccountCreate_Default
BatchAccountCreate_SystemAssignedIdentity
BatchAccountCreate_UserAssignedIdentity
PrivateBatchAccountCreate

BatchAccountCreate_BYOS

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-07-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "poolAllocationMode": "UserSubscription",
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    }
  }
}

Beispiel für eine Antwort

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_Default

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-07-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  }
}

Beispiel für eine Antwort

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_SystemAssignedIdentity

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-07-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Beispiel für eine Antwort

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_UserAssignedIdentity

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-07-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}

Beispiel für eine Antwort

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      }
    }
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountCreate

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-07-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  }
}

Beispiel für eine Antwort

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definitionen

Name Beschreibung
AuthenticationMode

Der Authentifizierungsmodus für das Batchkonto.

AutoStorageAuthenticationMode

Der Authentifizierungsmodus, den der Batchdienst zum Verwalten des automatischen Speicherkontos verwendet.

AutoStorageBaseProperties

Die Eigenschaften im Zusammenhang mit dem automatischen Speicherkonto.

AutoStorageProperties

Enthält Informationen zum automatischen Speicherkonto, das einem Batchkonto zugeordnet ist.

BatchAccount

Enthält Informationen zu einem Azure Batch-Konto.

BatchAccountCreateParameters

Parameter, die für den Create-Vorgang bereitgestellt werden.

BatchAccountIdentity

Die Identität des Batchkontos, falls konfiguriert. Dies wird verwendet, wenn der Benutzer "Microsoft.KeyVault" als Verschlüsselungskonfiguration des Batchkontos angibt oder wenn ManagedIdentity als Authentifizierungsmodus für den automatischen Speicher ausgewählt wird.

CloudError

Eine Fehlerantwort des Batchdiensts.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

EncryptionProperties

Konfiguriert, wie Kundendaten innerhalb des Batchkontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein vom Kunden verwalteter Schlüssel verwendet werden.

EndpointAccessDefaultAction

Die Standardaktion, wenn keine IPRule-Übereinstimmung vorhanden ist.

EndpointAccessProfile

Netzwerkzugriffsprofil für Batchendpunkt.

IPRule

Regel zum Filtern der Client-IP-Adresse.

IPRuleAction

Aktion, wenn client-IP-Adresse abgeglichen wird.

KeySource

Typ der Schlüsselquelle.

KeyVaultProperties

KeyVault-Konfiguration bei Verwendung einer Verschlüsselungs-KeySource von Microsoft.KeyVault.

KeyVaultReference

Identifiziert den Azure Key Vault, der einem Batchkonto zugeordnet ist.

NetworkProfile

Netzwerkprofil für Batchkonto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.

PoolAllocationMode

Der Zuordnungsmodus zum Erstellen von Pools im Batchkonto.

PrivateEndpoint

Der private Endpunkt der privaten Endpunktverbindung.

PrivateEndpointConnection

Enthält Informationen zu einer privaten Verknüpfungsressource.

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der privaten Endpunktverbindung.

PrivateLinkServiceConnectionState

Der Verbindungsstatus des privaten Verknüpfungsdiensts der privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Der Status der Privaten Batch-Endpunktverbindung

ProvisioningState

Der bereitgestellte Status der Ressource

PublicNetworkAccessType

Der Netzwerkzugriffstyp für die Ressourcen im Batchkonto.

ResourceIdentityType

Der Identitätstyp, der für das Batchkonto verwendet wird.

UserAssignedIdentities

Die Liste der zugeordneten Benutzeridentitäten.

VirtualMachineFamilyCoreQuota

Eine VM-Familie und das zugehörige Kernkontingent für das Batchkonto.

AuthenticationMode

Der Authentifizierungsmodus für das Batchkonto.

Wert Beschreibung
AAD

Der Authentifizierungsmodus mithilfe der Microsoft Entra-ID.

SharedKey

Der Authentifizierungsmodus mit freigegebenen Schlüsseln.

TaskAuthenticationToken

Der Authentifizierungsmodus mit Aufgabenauthentifizierungstoken.

AutoStorageAuthenticationMode

Der Authentifizierungsmodus, den der Batchdienst zum Verwalten des automatischen Speicherkontos verwendet.

Wert Beschreibung
BatchAccountManagedIdentity

Der Batchdienst authentifiziert Anforderungen an den automatischen Speicher mithilfe der verwalteten Identität, die dem Batchkonto zugewiesen ist.

StorageKeys

Der Batchdienst authentifiziert Anforderungen an den automatischen Speicher mithilfe von Speicherkontoschlüsseln.

AutoStorageBaseProperties

Die Eigenschaften im Zusammenhang mit dem automatischen Speicherkonto.

Name Typ Standardwert Beschreibung
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Der Authentifizierungsmodus, den der Batchdienst zum Verwalten des automatischen Speicherkontos verwendet.

nodeIdentityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die Computeknoten für den Zugriff auf den automatischen Speicher verwenden.
Die hier referenzierte Identität muss Pools zugewiesen werden, die Über Computeknoten verfügen, die Zugriff auf den automatischen Speicher benötigen.

storageAccountId

string (arm-id)

Die Ressourcen-ID des Speicherkontos, das für das automatische Speicherkonto verwendet werden soll.

AutoStorageProperties

Enthält Informationen zum automatischen Speicherkonto, das einem Batchkonto zugeordnet ist.

Name Typ Standardwert Beschreibung
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Der Authentifizierungsmodus, den der Batchdienst zum Verwalten des automatischen Speicherkontos verwendet.

lastKeySync

string (date-time)

Die UTC-Zeit, zu der Speicherschlüssel zuletzt mit dem Batchkonto synchronisiert wurden.

nodeIdentityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die Computeknoten für den Zugriff auf den automatischen Speicher verwenden.
Die hier referenzierte Identität muss Pools zugewiesen werden, die Über Computeknoten verfügen, die Zugriff auf den automatischen Speicher benötigen.

storageAccountId

string (arm-id)

Die Ressourcen-ID des Speicherkontos, das für das automatische Speicherkonto verwendet werden soll.

BatchAccount

Enthält Informationen zu einem Azure Batch-Konto.

Name Typ Standardwert Beschreibung
id

string

Die ID der Ressource.

identity

BatchAccountIdentity

Die Identität des Batchkontos.

location

string

Der Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.accountEndpoint

string

Der Kontoendpunkt, der für die Interaktion mit dem Batchdienst verwendet wird.

properties.activeJobAndJobScheduleQuota

integer (int32)

Das aktive Auftrags- und Auftragsplanungskontingent für das Batchkonto.

properties.allowedAuthenticationModes

AuthenticationMode[]

Liste der zulässigen Authentifizierungsmodi für das Batchkonto, das zur Authentifizierung mit der Datenebene verwendet werden kann. Dies wirkt sich nicht auf die Authentifizierung mit der Steuerebene aus.

properties.autoStorage

AutoStorageProperties

Die Eigenschaften und der Status eines automatischen Speicherkontos, das dem Batchkonto zugeordnet ist.
Enthält Informationen zum automatischen Speicherkonto, das einem Batchkonto zugeordnet ist.

properties.dedicatedCoreQuota

integer (int32)

Das dedizierte Kernkontingent für das Batchkonto.
Bei Konten mit PoolAllocationMode, die auf UserSubscription festgelegt sind, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Eine Liste des dedizierten Kernkontingents pro Familie virtueller Computer für das Batchkonto. Bei Konten mit PoolAllocationMode, die auf UserSubscription festgelegt sind, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

Ein Wert, der angibt, ob Kernkontingente pro Familie virtueller Computer für dieses Konto erzwungen werden
Wenn diese Kennzeichnung "true" ist, wird das dedizierte Kernkontingent sowohl über die dedizierteCoreQuotaPerVMFamily- als auch die dedicatedCoreQuota-Eigenschaft des Kontos erzwungen. Wenn dieses Kennzeichen falsch ist, wird das dedizierte Kernkontingent nur über die dedizierteCoreQuota-Eigenschaft auf dem Konto erzwungen und berücksichtigt keine Familie virtueller Computer.

properties.encryption

EncryptionProperties

Die Verschlüsselungskonfiguration für das Batchkonto.
Konfiguriert, wie Kundendaten innerhalb des Batchkontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein vom Kunden verwalteter Schlüssel verwendet werden.

properties.keyVaultReference

KeyVaultReference

Ein Verweis auf den Azure Key Vault, der dem Batchkonto zugeordnet ist.
Identifiziert den Azure Key Vault, der einem Batchkonto zugeordnet ist.

properties.lowPriorityCoreQuota

integer (int32)

Das Spot/Low-Priority-Kernkontingent für das Batchkonto.
Bei Konten mit PoolAllocationMode, die auf UserSubscription festgelegt sind, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.

properties.networkProfile

NetworkProfile

Netzwerkprofil für Batchkonto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.
Das Netzwerkprofil wird nur wirksam, wenn publicNetworkAccess aktiviert ist.

properties.nodeManagementEndpoint

string

Der Endpunkt, der vom Computeknoten zum Herstellen einer Verbindung mit dem Batchknotenverwaltungsdienst verwendet wird.

properties.poolAllocationMode

PoolAllocationMode

Der Zuordnungsmodus, der zum Erstellen von Pools im Batchkonto verwendet werden soll.
Der Zuordnungsmodus zum Erstellen von Pools im Batchkonto.

properties.poolQuota

integer (int32)

Das Poolkontingent für das Batchkonto.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste der privaten Endpunktverbindungen, die dem Batchkonto zugeordnet sind

properties.provisioningState

ProvisioningState

Der bereitgestellte Status der Ressource

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Der Netzwerkschnittstellentyp für den Zugriff auf Azure Batch-Dienst- und Batchkontovorgänge.
Wenn nicht angegeben, ist der Standardwert "aktiviert".

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

BatchAccountCreateParameters

Parameter, die für den Create-Vorgang bereitgestellt werden.

Name Typ Standardwert Beschreibung
identity

BatchAccountIdentity

Die Identität des Batchkontos.

location

string

Die Region, in der das Konto erstellt werden soll.

properties.allowedAuthenticationModes

AuthenticationMode[]

Liste der zulässigen Authentifizierungsmodi für das Batchkonto, das zur Authentifizierung mit der Datenebene verwendet werden kann. Dies wirkt sich nicht auf die Authentifizierung mit der Steuerebene aus.

properties.autoStorage

AutoStorageBaseProperties

Die Eigenschaften im Zusammenhang mit dem automatischen Speicherkonto.

properties.encryption

EncryptionProperties

Die Verschlüsselungskonfiguration für das Batchkonto.
Konfiguriert, wie Kundendaten innerhalb des Batchkontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein vom Kunden verwalteter Schlüssel verwendet werden.

properties.keyVaultReference

KeyVaultReference

Ein Verweis auf den Azure Key Vault, der dem Batchkonto zugeordnet ist.

properties.networkProfile

NetworkProfile

Netzwerkprofil für Batchkonto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.
Das Netzwerkprofil wird nur wirksam, wenn publicNetworkAccess aktiviert ist.

properties.poolAllocationMode

PoolAllocationMode

Der Zuordnungsmodus, der zum Erstellen von Pools im Batchkonto verwendet werden soll.
Der Poolzuweisungsmodus wirkt sich auch darauf aus, wie Clients sich bei der Batchdienst-API authentifizieren können. Wenn der Modus BatchService ist, können Clients sich mit Zugriffstasten oder Microsoft Entra-ID authentifizieren. Wenn der Modus "UserSubscription" lautet, müssen Clients die Microsoft Entra-ID verwenden. Der Standardwert ist BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Der Netzwerkzugriffstyp für den Zugriff auf das Azure Batch-Konto.
Wenn nicht angegeben, ist der Standardwert "aktiviert".

tags

object

Die vom Benutzer angegebenen Tags, die dem Konto zugeordnet sind.

BatchAccountIdentity

Die Identität des Batchkontos, falls konfiguriert. Dies wird verwendet, wenn der Benutzer "Microsoft.KeyVault" als Verschlüsselungskonfiguration des Batchkontos angibt oder wenn ManagedIdentity als Authentifizierungsmodus für den automatischen Speicher ausgewählt wird.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID des Batchkontos. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.

tenantId

string

Die Mandanten-ID, die dem Batchkonto zugeordnet ist. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.

type

ResourceIdentityType

Der Identitätstyp, der für das Batchkonto verwendet wird.

userAssignedIdentities

<string,  UserAssignedIdentities>

Die Liste der Benutzeridentitäten, die dem Batchkonto zugeordnet sind.

CloudError

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Der Textkörper der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

Name Typ Beschreibung
resourceId

string

Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität.

EncryptionProperties

Konfiguriert, wie Kundendaten innerhalb des Batchkontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein vom Kunden verwalteter Schlüssel verwendet werden.

Name Typ Beschreibung
keySource

KeySource

Typ der Schlüsselquelle.

keyVaultProperties

KeyVaultProperties

Weitere Details bei Verwendung von Microsoft.KeyVault

EndpointAccessDefaultAction

Die Standardaktion, wenn keine IPRule-Übereinstimmung vorhanden ist.

Wert Beschreibung
Allow

Clientzugriff zulassen.

Deny

Den Clientzugriff verweigern.

EndpointAccessProfile

Netzwerkzugriffsprofil für Batchendpunkt.

Name Typ Beschreibung
defaultAction

EndpointAccessDefaultAction

Die Standardaktion, wenn keine IPRule-Übereinstimmung vorhanden ist.
Standardaktion für Endpunktzugriff. Sie gilt nur, wenn publicNetworkAccess aktiviert ist.

ipRules

IPRule[]

Array von IP-Bereichen zum Filtern der Client-IP-Adresse.

IPRule

Regel zum Filtern der Client-IP-Adresse.

Name Typ Beschreibung
action

IPRuleAction

Aktion, wenn client-IP-Adresse abgeglichen wird.

value

string

Die zu filternde IP-Adresse oder der IP-Adressbereich
IPv4-Adresse oder IPv4-Adressbereich im CIDR-Format.

IPRuleAction

Aktion, wenn client-IP-Adresse abgeglichen wird.

Wert Beschreibung
Allow

Zugriff auf die übereinstimmene Client-IP-Adresse zulassen.

KeySource

Typ der Schlüsselquelle.

Wert Beschreibung
Microsoft.Batch

Batch erstellt und verwaltet die Verschlüsselungsschlüssel, die zum Schutz der Kontodaten verwendet werden.

Microsoft.KeyVault

Die Verschlüsselungsschlüssel zum Schutz der Kontodaten werden in einem externen Schlüsseltresor gespeichert. Wenn dies festgelegt ist, muss die Identität des Batchkontos auf SystemAssigned festgelegt werden, und unter "keyVaultProperties" muss auch ein gültiger Schlüsselbezeichner angegeben werden.

KeyVaultProperties

KeyVault-Konfiguration bei Verwendung einer Verschlüsselungs-KeySource von Microsoft.KeyVault.

Name Typ Beschreibung
keyIdentifier

string

Vollständiger Pfad zum geheimen Schlüssel mit oder ohne Version. Beispiel https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. oder https://mykeyvault.vault.azure.net/keys/testkey. Damit die folgenden Voraussetzungen erfüllt werden können:

Das Batchkonto verfügt über eine vom System zugewiesene Identität Der Kontoidentität wurde Schlüssel/Abrufen, Schlüssel/Entwrap- und Schlüssel-/Umbruchberechtigungen gewährt. KeyVault verfügt über soft-delete- und Löschschutz aktiviert

KeyVaultReference

Identifiziert den Azure Key Vault, der einem Batchkonto zugeordnet ist.

Name Typ Beschreibung
id

string (arm-id)

Die Ressourcen-ID des Azure Key Vault, der dem Batchkonto zugeordnet ist.

url

string

Die URL des Azure-Schlüsseltresors, der dem Batchkonto zugeordnet ist.

NetworkProfile

Netzwerkprofil für Batchkonto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.

Name Typ Beschreibung
accountAccess

EndpointAccessProfile

Netzwerkzugriffsprofil für batchAccount-Endpunkt (Batchkonto-Datenebene-API).

nodeManagementAccess

EndpointAccessProfile

Netzwerkzugriffsprofil für nodeManagement-Endpunkt (Batchdienst, der Computeknoten für Batchpools verwaltet).

PoolAllocationMode

Der Zuordnungsmodus zum Erstellen von Pools im Batchkonto.

Wert Beschreibung
BatchService

Pools werden in Abonnements zugewiesen, die sich im Besitz des Batchdiensts befinden.

UserSubscription

Pools werden in einem Abonnement zugewiesen, das dem Benutzer gehört.

PrivateEndpoint

Der private Endpunkt der privaten Endpunktverbindung.

Name Typ Beschreibung
id

string

Der ARM-Ressourcenbezeichner des privaten Endpunkts. Dies ist das Format "/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}".

PrivateEndpointConnection

Enthält Informationen zu einer privaten Verknüpfungsressource.

Name Typ Beschreibung
etag

string

Das ETag der Ressource, das für Parallelitätsanweisungen verwendet wird.

id

string

Die ID der Ressource.

name

string

Der Name der Ressource.

properties.groupIds

string[]

Die Gruppen-ID der privaten Endpunktverbindung.
Der Wert weist nur eine Gruppen-ID auf.

properties.privateEndpoint

PrivateEndpoint

Der ARM-Ressourcenbezeichner des privaten Endpunkts.
Der private Endpunkt der privaten Endpunktverbindung.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Der Verbindungsstatus des privaten Verknüpfungsdiensts der privaten Endpunktverbindung.
Der Verbindungsstatus des privaten Verknüpfungsdiensts der privaten Endpunktverbindung

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der privaten Endpunktverbindung.

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der privaten Endpunktverbindung.

Wert Beschreibung
Cancelled

Der Benutzer hat die Verbindungserstellung abgebrochen.

Creating

Die Verbindung wird erstellt.

Deleting

Die Verbindung wird gelöscht.

Failed

Der Benutzer hat angefordert, dass die Verbindung aktualisiert und fehlgeschlagen ist. Sie können den Aktualisierungsvorgang wiederholen.

Succeeded

Der Verbindungsstatus ist abgeschlossen und kann verwendet werden, wenn der Status genehmigt ist.

Updating

Der Benutzer hat angefordert, dass der Verbindungsstatus aktualisiert wird, der Aktualisierungsvorgang wurde jedoch noch nicht abgeschlossen. Sie können beim Herstellen einer Verbindung mit dem Batchkonto nicht auf die Verbindung verweisen.

PrivateLinkServiceConnectionState

Der Verbindungsstatus des privaten Verknüpfungsdiensts der privaten Endpunktverbindung

Name Typ Beschreibung
actionsRequired

string

Aktion erforderlich für den Status der privaten Verbindung

description

string

Beschreibung des privaten Verbindungszustands

status

PrivateLinkServiceConnectionStatus

Der Status für die private Endpunktverbindung des Batchkontos

PrivateLinkServiceConnectionStatus

Der Status der Privaten Batch-Endpunktverbindung

Wert Beschreibung
Approved

Die private Endpunktverbindung wurde genehmigt und kann für den Zugriff auf das Batchkonto verwendet werden.

Disconnected

Die private Endpunktverbindung ist getrennt und kann nicht für den Zugriff auf das Batchkonto verwendet werden.

Pending

Die private Endpunktverbindung steht aus und kann nicht für den Zugriff auf das Batchkonto verwendet werden.

Rejected

Die private Endpunktverbindung wird abgelehnt und kann nicht für den Zugriff auf das Batchkonto verwendet werden.

ProvisioningState

Der bereitgestellte Status der Ressource

Wert Beschreibung
Cancelled

Der letzte Vorgang für das Konto wird abgebrochen.

Creating

Das Konto wird erstellt.

Deleting

Das Konto wird gelöscht.

Failed

Der letzte Vorgang für das Konto ist fehlgeschlagen.

Invalid

Das Konto befindet sich in einem ungültigen Zustand.

Succeeded

Das Konto wurde erstellt und kann verwendet werden.

PublicNetworkAccessType

Der Netzwerkzugriffstyp für die Ressourcen im Batchkonto.

Wert Beschreibung
Disabled

Deaktiviert die öffentliche Konnektivität und ermöglicht private Konnektivität mit Azure Batch Service über private Endpunktressource.

Enabled

Ermöglicht die Verbindung mit Azure Batch über öffentliches DNS.

SecuredByPerimeter

Sichert die Konnektivität mit Azure Batch über die NSP-Konfiguration.

ResourceIdentityType

Der Identitätstyp, der für das Batchkonto verwendet wird.

Wert Beschreibung
None

Dem Batchkonto ist keine Identität zugeordnet. Wenn Sie None im Updatekonto festlegen, werden vorhandene Identitäten entfernt.

SystemAssigned

Einem Batchkonto ist eine Systemidentität zugewiesen.

UserAssigned

Das Batchkonto hat ihm Benutzeridentitäten zugewiesen.

UserAssignedIdentities

Die Liste der zugeordneten Benutzeridentitäten.

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.

principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

VirtualMachineFamilyCoreQuota

Eine VM-Familie und das zugehörige Kernkontingent für das Batchkonto.

Name Typ Beschreibung
coreQuota

integer (int32)

Das Kernkontingent für die VM-Familie für das Batchkonto.

name

string

Der Familienname des virtuellen Computers.