Batch Account - Update
Updates de eigenschappen van een bestaand Batch-account.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2024-02-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
De naam van het Batch-account. Regex-patroon: |
resource
|
path | True |
string |
De naam van de resourcegroep die het Batch-account bevat. |
subscription
|
path | True |
string |
De Azure-abonnements-id. Dit is een tekenreeks in GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000) |
api-version
|
query | True |
string |
De API-versie die moet worden gebruikt met de HTTP-aanvraag. |
Aanvraagbody
Name | Type | Description |
---|---|---|
identity |
De identiteit van het Batch-account. |
|
properties.allowedAuthenticationModes |
Lijst met toegestane verificatiemodi voor het Batch-account die kunnen worden gebruikt voor verificatie met het gegevensvlak. Dit heeft geen invloed op de verificatie met het besturingsvlak. |
|
properties.autoStorage |
De eigenschappen met betrekking tot het automatische opslagaccount. |
|
properties.encryption |
De versleutelingsconfiguratie voor het Batch-account. |
|
properties.networkProfile |
Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat. |
|
properties.publicNetworkAccess |
Het netwerktoegangstype voor toegang tot Azure Batch-account. |
|
tags |
object |
De door de gebruiker opgegeven tags die zijn gekoppeld aan het account. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De bewerking is geslaagd. Het antwoord bevat de entiteit Batch-account. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Microsoft Entra OAuth 2.0-verificatiecodestroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
BatchAccountUpdate
Voorbeeldaanvraag
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01
{
"properties": {
"autoStorage": {
"storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
}
}
}
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Authentication |
De verificatiemodus voor het Batch-account. |
Auto |
De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren. |
Auto |
De eigenschappen met betrekking tot het automatische opslagaccount. |
Auto |
Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account. |
Batch |
Bevat informatie over een Azure Batch-account. |
Batch |
De identiteit van het Batch-account, indien geconfigureerd. Dit wordt gebruikt wanneer de gebruiker 'Microsoft.KeyVault' opgeeft als de batch-accountversleutelingsconfiguratie of wanneer |
Batch |
Parameters voor het bijwerken van een Azure Batch-account. |
Cloud |
Een foutreactie van de Batch-service. |
Cloud |
Een foutreactie van de Batch-service. |
Compute |
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt. |
Encryption |
Hiermee configureert u hoe klantgegevens worden versleuteld in het Batch-account. Accounts worden standaard versleuteld met behulp van een door Microsoft beheerde sleutel. Voor extra controle kan in plaats daarvan een door de klant beheerde sleutel worden gebruikt. |
Endpoint |
De standaardactie wanneer er geen IPRule wordt vergeleken. |
Endpoint |
Netwerktoegangsprofiel voor Batch-eindpunt. |
IPRule |
Regel om het IP-adres van de client te filteren. |
IPRule |
Actie wanneer het IP-adres van de client overeenkomt. |
Key |
Type van de sleutelbron. |
Key |
KeyVault-configuratie bij gebruik van een versleutelingssleutelbron van Microsoft.KeyVault. |
Key |
Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account. |
Network |
Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat. |
Pool |
De toewijzingsmodus voor het maken van pools in het Batch-account. |
Private |
Het privé-eindpunt van de privé-eindpuntverbinding. |
Private |
Bevat informatie over een private link-resource. |
Private |
De inrichtingsstatus van de privé-eindpuntverbinding. |
Private |
De verbindingsstatus van de private link-service van de privé-eindpuntverbinding |
Private |
De status van de verbinding met het privé-eindpunt van Batch |
Provisioning |
De ingerichte status van de resource |
Public |
Het netwerktoegangstype voor het uitvoeren van de resources in het Batch-account. |
Resource |
Het type identiteit dat wordt gebruikt voor het Batch-account. |
User |
De lijst met gekoppelde gebruikersidentiteiten. |
Virtual |
Een VM-serie en het bijbehorende kernquotum voor het Batch-account. |
AuthenticationMode
De verificatiemodus voor het Batch-account.
Name | Type | Description |
---|---|---|
AAD |
string |
De verificatiemodus met Microsoft Entra ID. |
SharedKey |
string |
De verificatiemodus met gedeelde sleutels. |
TaskAuthenticationToken |
string |
De verificatiemodus met behulp van taakverificatietokens. |
AutoStorageAuthenticationMode
De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren.
Name | Type | Description |
---|---|---|
BatchAccountManagedIdentity |
string |
De Batch-service verifieert aanvragen voor automatische opslag met behulp van de beheerde identiteit die is toegewezen aan het Batch-account. |
StorageKeys |
string |
De Batch-service verifieert aanvragen voor automatische opslag met behulp van opslagaccountsleutels. |
AutoStorageBaseProperties
De eigenschappen met betrekking tot het automatische opslagaccount.
Name | Type | Default value | Description |
---|---|---|---|
authenticationMode | StorageKeys |
De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren. |
|
nodeIdentityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die rekenknooppunten gebruiken om toegang te krijgen tot automatische opslag. |
||
storageAccountId |
string |
De resource-id van het opslagaccount dat moet worden gebruikt voor een automatisch opslagaccount. |
AutoStorageProperties
Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.
Name | Type | Default value | Description |
---|---|---|---|
authenticationMode | StorageKeys |
De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren. |
|
lastKeySync |
string |
De UTC-tijd waarop opslagsleutels voor het laatst zijn gesynchroniseerd met het Batch-account. |
|
nodeIdentityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die rekenknooppunten gebruiken om toegang te krijgen tot automatische opslag. |
||
storageAccountId |
string |
De resource-id van het opslagaccount dat moet worden gebruikt voor een automatisch opslagaccount. |
BatchAccount
Bevat informatie over een Azure Batch-account.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
De id van de resource. |
|
identity |
De identiteit van het Batch-account. |
||
location |
string |
De locatie van de resource. |
|
name |
string |
De naam van de resource. |
|
properties.accountEndpoint |
string |
Het accounteindpunt dat wordt gebruikt voor interactie met de Batch-service. |
|
properties.activeJobAndJobScheduleQuota |
integer |
Het quotum voor de actieve taak en taakplanning voor het Batch-account. |
|
properties.allowedAuthenticationModes |
Lijst met toegestane verificatiemodi voor het Batch-account die kunnen worden gebruikt voor verificatie met het gegevensvlak. Dit heeft geen invloed op de verificatie met het besturingsvlak. |
||
properties.autoStorage |
De eigenschappen en status van een automatisch opslagaccount dat is gekoppeld aan het Batch-account. |
||
properties.dedicatedCoreQuota |
integer |
Het toegewezen kernquotum voor het Batch-account. |
|
properties.dedicatedCoreQuotaPerVMFamily |
Een lijst met het toegewezen kernquotum per virtuele-machinefamilie voor het Batch-account. Voor accounts waarvoor PoolAllocationMode is ingesteld op UserSubscription, wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd. |
||
properties.dedicatedCoreQuotaPerVMFamilyEnforced |
boolean |
Een waarde die aangeeft of kernquota per virtuele-machinefamilie worden afgedwongen voor dit account |
|
properties.encryption |
De versleutelingsconfiguratie voor het Batch-account. |
||
properties.keyVaultReference |
Een verwijzing naar de Azure-sleutelkluis die is gekoppeld aan het Batch-account. |
||
properties.lowPriorityCoreQuota |
integer |
Het kernquotum spot/lage prioriteit voor het Batch-account. |
|
properties.networkProfile |
Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat. |
||
properties.nodeManagementEndpoint |
string |
Het eindpunt dat door het rekenknooppunt wordt gebruikt om verbinding te maken met de Batch-knooppuntbeheerservice. |
|
properties.poolAllocationMode |
De toewijzingsmodus die moet worden gebruikt om pools te maken in het Batch-account. |
||
properties.poolQuota |
integer |
Het poolquotum voor het Batch-account. |
|
properties.privateEndpointConnections |
Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan het Batch-account |
||
properties.provisioningState |
De ingerichte status van de resource |
||
properties.publicNetworkAccess | Enabled |
Het netwerkinterfacetype voor toegang tot Azure Batch service- en Batch-accountbewerkingen. |
|
tags |
object |
De tags van de resource. |
|
type |
string |
Het type resource. |
BatchAccountIdentity
De identiteit van het Batch-account, indien geconfigureerd. Dit wordt gebruikt wanneer de gebruiker 'Microsoft.KeyVault' opgeeft als de batch-accountversleutelingsconfiguratie of wanneer ManagedIdentity
is geselecteerd als de verificatiemodus voor automatische opslag.
Name | Type | Description |
---|---|---|
principalId |
string |
De principal-id van het Batch-account. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit. |
tenantId |
string |
De tenant-id die is gekoppeld aan het Batch-account. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit. |
type |
Het type identiteit dat wordt gebruikt voor het Batch-account. |
|
userAssignedIdentities |
<string,
User |
De lijst met gebruikersidentiteiten die zijn gekoppeld aan het Batch-account. |
BatchAccountUpdateParameters
Parameters voor het bijwerken van een Azure Batch-account.
Name | Type | Default value | Description |
---|---|---|---|
identity |
De identiteit van het Batch-account. |
||
properties.allowedAuthenticationModes |
Lijst met toegestane verificatiemodi voor het Batch-account die kunnen worden gebruikt voor verificatie met het gegevensvlak. Dit heeft geen invloed op de verificatie met het besturingsvlak. |
||
properties.autoStorage |
De eigenschappen met betrekking tot het automatische opslagaccount. |
||
properties.encryption |
De versleutelingsconfiguratie voor het Batch-account. |
||
properties.networkProfile |
Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat. |
||
properties.publicNetworkAccess | Enabled |
Het netwerktoegangstype voor toegang tot Azure Batch-account. |
|
tags |
object |
De door de gebruiker opgegeven tags die zijn gekoppeld aan het account. |
CloudError
Een foutreactie van de Batch-service.
Name | Type | Description |
---|---|---|
error |
De hoofdtekst van het foutbericht. |
CloudErrorBody
Een foutreactie van de Batch-service.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
details |
Een lijst met aanvullende informatie over de fout. |
|
message |
string |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
target |
string |
Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout. |
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. |
EncryptionProperties
Hiermee configureert u hoe klantgegevens worden versleuteld in het Batch-account. Accounts worden standaard versleuteld met behulp van een door Microsoft beheerde sleutel. Voor extra controle kan in plaats daarvan een door de klant beheerde sleutel worden gebruikt.
Name | Type | Description |
---|---|---|
keySource |
Type van de sleutelbron. |
|
keyVaultProperties |
Aanvullende informatie bij het gebruik van Microsoft.KeyVault |
EndpointAccessDefaultAction
De standaardactie wanneer er geen IPRule wordt vergeleken.
Name | Type | Description |
---|---|---|
Allow |
string |
Clienttoegang toestaan. |
Deny |
string |
Clienttoegang weigeren. |
EndpointAccessProfile
Netwerktoegangsprofiel voor Batch-eindpunt.
Name | Type | Description |
---|---|---|
defaultAction |
De standaardactie wanneer er geen IPRule wordt vergeleken. |
|
ipRules |
IPRule[] |
Matrix van IP-bereiken om het IP-adres van de client te filteren. |
IPRule
Regel om het IP-adres van de client te filteren.
Name | Type | Description |
---|---|---|
action |
Actie wanneer het IP-adres van de client overeenkomt. |
|
value |
string |
Het IP-adres of IP-adresbereik dat moet worden gefilterd |
IPRuleAction
Actie wanneer het IP-adres van de client overeenkomt.
Name | Type | Description |
---|---|---|
Allow |
string |
Toegang toestaan voor het overeenkomende IP-adres van de client. |
KeySource
Type van de sleutelbron.
Name | Type | Description |
---|---|---|
Microsoft.Batch |
string |
Batch maakt en beheert de versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen. |
Microsoft.KeyVault |
string |
De versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen, worden opgeslagen in een externe sleutelkluis. Als dit is ingesteld, moet de identiteit van het Batch-account worden ingesteld op |
KeyVaultProperties
KeyVault-configuratie bij gebruik van een versleutelingssleutelbron van Microsoft.KeyVault.
Name | Type | Description |
---|---|---|
keyIdentifier |
string |
Volledig pad naar het geheim met of zonder versie. Voorbeeld https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. https://mykeyvault.vault.azure.net/keys/testkey gebruiken. Om bruikbaar te zijn, moet aan de volgende vereisten worden voldaan: Het Batch-account heeft een door het systeem toegewezen identiteit De account-id heeft de machtigingen Key/Get, Key/Unwrap en Key/Wrap De KeyVault heeft beveiliging voor voorlopig verwijderen en opschonen ingeschakeld |
KeyVaultReference
Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.
Name | Type | Description |
---|---|---|
id |
string |
De resource-id van de Azure-sleutelkluis die is gekoppeld aan het Batch-account. |
url |
string |
De URL van de Azure-sleutelkluis die is gekoppeld aan het Batch-account. |
NetworkProfile
Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat.
Name | Type | Description |
---|---|---|
accountAccess |
Netwerktoegangsprofiel voor batchAccount-eindpunt (Gegevensvlak-API voor Batch-account). |
|
nodeManagementAccess |
Netwerktoegangsprofiel voor nodeManagement-eindpunt (Batch-service die rekenknooppunten voor Batch-pools beheert). |
PoolAllocationMode
De toewijzingsmodus voor het maken van pools in het Batch-account.
Name | Type | Description |
---|---|---|
BatchService |
string |
Pools worden toegewezen in abonnementen die eigendom zijn van de Batch-service. |
UserSubscription |
string |
Pools worden toegewezen in een abonnement dat eigendom is van de gebruiker. |
PrivateEndpoint
Het privé-eindpunt van de privé-eindpuntverbinding.
Name | Type | Description |
---|---|---|
id |
string |
De ARM-resource-id van het privé-eindpunt. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. |
PrivateEndpointConnection
Bevat informatie over een private link-resource.
Name | Type | Description |
---|---|---|
etag |
string |
De ETag van de resource, die wordt gebruikt voor gelijktijdigheidsinstructies. |
id |
string |
De id van de resource. |
name |
string |
De naam van de resource. |
properties.groupIds |
string[] |
De groeps-id van de privé-eindpuntverbinding. |
properties.privateEndpoint |
De ARM-resource-id van het privé-eindpunt. |
|
properties.privateLinkServiceConnectionState |
De verbindingsstatus van de private link-service van de privé-eindpuntverbinding. |
|
properties.provisioningState |
De inrichtingsstatus van de privé-eindpuntverbinding. |
|
type |
string |
Het type resource. |
PrivateEndpointConnectionProvisioningState
De inrichtingsstatus van de privé-eindpuntverbinding.
Name | Type | Description |
---|---|---|
Cancelled |
string |
De gebruiker heeft het maken van de verbinding geannuleerd. |
Creating |
string |
De verbinding wordt gemaakt. |
Deleting |
string |
De verbinding wordt verwijderd. |
Failed |
string |
De gebruiker heeft gevraagd om de verbinding bij te werken, maar deze is mislukt. U kunt de updatebewerking opnieuw proberen. |
Succeeded |
string |
De verbindingsstatus is definitief en is klaar voor gebruik als status Goedgekeurd is. |
Updating |
string |
De gebruiker heeft aangevraagd dat de verbindingsstatus wordt bijgewerkt, maar de updatebewerking is nog niet voltooid. U mag niet verwijzen naar de verbinding wanneer u verbinding maakt met het Batch-account. |
PrivateLinkServiceConnectionState
De verbindingsstatus van de private link-service van de privé-eindpuntverbinding
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Actie vereist voor de status van de privéverbinding |
description |
string |
Beschrijving van de privéverbindingsstatus |
status |
De status voor de privé-eindpuntverbinding van het Batch-account |
PrivateLinkServiceConnectionStatus
De status van de verbinding met het privé-eindpunt van Batch
Name | Type | Description |
---|---|---|
Approved |
string |
De privé-eindpuntverbinding is goedgekeurd en kan worden gebruikt voor toegang tot het Batch-account |
Disconnected |
string |
De verbinding met het privé-eindpunt is verbroken en kan niet worden gebruikt voor toegang tot het Batch-account |
Pending |
string |
De privé-eindpuntverbinding is in behandeling en kan niet worden gebruikt voor toegang tot het Batch-account |
Rejected |
string |
De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt voor toegang tot het Batch-account |
ProvisioningState
De ingerichte status van de resource
Name | Type | Description |
---|---|---|
Cancelled |
string |
De laatste bewerking voor het account wordt geannuleerd. |
Creating |
string |
Het account wordt gemaakt. |
Deleting |
string |
Het account wordt verwijderd. |
Failed |
string |
De laatste bewerking voor het account is mislukt. |
Invalid |
string |
Het account heeft een ongeldige status. |
Succeeded |
string |
Het account is gemaakt en is klaar voor gebruik. |
PublicNetworkAccessType
Het netwerktoegangstype voor het uitvoeren van de resources in het Batch-account.
Name | Type | Description |
---|---|---|
Disabled |
string |
Hiermee schakelt u openbare connectiviteit uit en schakelt u privéconnectiviteit met Azure Batch Service in via een privé-eindpuntresource. |
Enabled |
string |
Hiermee kunt u connectiviteit met Azure Batch via openbare DNS. |
ResourceIdentityType
Het type identiteit dat wordt gebruikt voor het Batch-account.
Name | Type | Description |
---|---|---|
None |
string |
Er is geen identiteit aan het Batch-account gekoppeld. Als u het account bijwerken instelt |
SystemAssigned |
string |
Batch-account heeft een door het systeem toegewezen identiteit. |
UserAssigned |
string |
Batch-account heeft door de gebruiker toegewezen identiteiten. |
UserAssignedIdentities
De lijst met gekoppelde gebruikersidentiteiten.
Name | Type | Description |
---|---|---|
clientId |
string |
De client-id van de door de gebruiker toegewezen identiteit. |
principalId |
string |
De principal-id van de door de gebruiker toegewezen identiteit. |
VirtualMachineFamilyCoreQuota
Een VM-serie en het bijbehorende kernquotum voor het Batch-account.
Name | Type | Description |
---|---|---|
coreQuota |
integer |
Het kernquotum voor de VM-familie voor het Batch-account. |
name |
string |
De naam van de virtuele machinefamilie. |