Delen via


Batch Account - List

Hiermee wordt informatie opgehaald over de Batch-accounts die zijn gekoppeld aan het abonnement.

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

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string

De Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000)

api-version
query True

string

De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Antwoorden

Name Type Description
200 OK

BatchAccountListResult

De bewerking is geslaagd. Het antwoord bevat een lijst met Batch-accountentiteiten die zijn gekoppeld aan het abonnement.

Other Status Codes

CloudError

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

BatchAccountList

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Batch/batchAccounts?api-version=2024-07-01

Voorbeeldrespons

{
  "value": [
    {
      "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
AuthenticationMode

De verificatiemodus voor het Batch-account.

AutoStorageAuthenticationMode

De verificatiemodus die door de Batch-service wordt gebruikt voor het beheren van het automatische opslagaccount.

AutoStorageProperties

Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.

BatchAccount

Bevat informatie over een Azure Batch-account.

BatchAccountIdentity

De identiteit van het Batch-account, indien geconfigureerd. Dit wordt gebruikt wanneer de gebruiker Microsoft.KeyVault opgeeft als de configuratie van de Batch-accountversleuteling of wanneer ManagedIdentity is geselecteerd als de verificatiemodus voor automatische opslag.

BatchAccountListResult

Waarden die worden geretourneerd door de bewerking Lijst.

CloudError

Een foutreactie van de Batch-service.

CloudErrorBody

Een foutreactie van de Batch-service.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

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.

EndpointAccessDefaultAction

De standaardactie wanneer er geen IPRule-overeenkomst is gevonden.

EndpointAccessProfile

Netwerktoegangsprofiel voor Batch-eindpunt.

IPRule

Regel voor het filteren van het IP-adres van de client.

IPRuleAction

Actie wanneer het IP-adres van de client overeenkomt.

KeySource

Type sleutelbron.

KeyVaultProperties

KeyVault-configuratie bij gebruik van een versleutelingssleutelbron van Microsoft.KeyVault.

KeyVaultReference

Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.

NetworkProfile

Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat.

PoolAllocationMode

De toewijzingsmodus voor het maken van pools in het Batch-account.

PrivateEndpoint

Het privé-eindpunt van de privé-eindpuntverbinding.

PrivateEndpointConnection

Bevat informatie over een private link-resource.

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbinding.

PrivateLinkServiceConnectionState

De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding

PrivateLinkServiceConnectionStatus

De status van de privé-eindpuntverbinding van Batch

ProvisioningState

De ingerichte status van de resource

PublicNetworkAccessType

Het netwerktoegangstype voor gebruik op de resources in het Batch-account.

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor het Batch-account.

UserAssignedIdentities

De lijst met gekoppelde gebruikersidentiteiten.

VirtualMachineFamilyCoreQuota

Een VM-serie en het bijbehorende kernquotum voor het Batch-account.

AuthenticationMode

De verificatiemodus voor het Batch-account.

Waarde Description
AAD

De verificatiemodus met behulp van Microsoft Entra-id.

SharedKey

De verificatiemodus met behulp van gedeelde sleutels.

TaskAuthenticationToken

De verificatiemodus met behulp van taakverificatietokens.

AutoStorageAuthenticationMode

De verificatiemodus die door de Batch-service wordt gebruikt voor het beheren van het automatische opslagaccount.

Waarde Description
BatchAccountManagedIdentity

De Batch-service verifieert aanvragen voor automatische opslag met behulp van de beheerde identiteit die is toegewezen aan het Batch-account.

StorageKeys

De Batch-service verifieert aanvragen voor automatische opslag met behulp van opslagaccountsleutels.

AutoStorageProperties

Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.

Name Type Default value Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

De verificatiemodus die door de Batch-service wordt gebruikt voor het beheren van het automatische opslagaccount.

lastKeySync

string (date-time)

Het UTC-tijdstip waarop opslagsleutels voor het laatst zijn gesynchroniseerd met het Batch-account.

nodeIdentityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die rekenknooppunten gebruiken voor toegang tot automatische opslag.
De identiteit waarnaar hier wordt verwezen, moet worden toegewezen aan pools met rekenknooppunten die toegang nodig hebben tot automatische opslag.

storageAccountId

string (arm-id)

De resource-id van het opslagaccount dat moet worden gebruikt voor automatisch opslagaccount.

BatchAccount

Bevat informatie over een Azure Batch-account.

Name Type Default value Description
id

string

De id van de resource.

identity

BatchAccountIdentity

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 om te communiceren met de Batch-service.

properties.activeJobAndJobScheduleQuota

integer (int32)

Het actieve taak- en taakschemaquotum voor het Batch-account.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lijst met toegestane verificatiemodi voor het Batch-account dat kan worden gebruikt voor verificatie met het gegevensvlak. Dit heeft geen invloed op verificatie met het besturingsvlak.

properties.autoStorage

AutoStorageProperties

De eigenschappen en status van een automatisch opslagaccount dat is gekoppeld aan het Batch-account.
Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.

properties.dedicatedCoreQuota

integer (int32)

Het toegewezen kernquotum voor het Batch-account.
Voor accounts met PoolAllocationMode ingesteld op UserSubscription wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Een lijst met het toegewezen kernquotum per virtuele-machinefamilie voor het Batch-account. Voor accounts met PoolAllocationMode 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
Als deze vlag waar is, wordt toegewezen kernquotum afgedwongen via zowel de dedicatedCoreQuotaPerVMFamily- als dedicatedCoreQuota-eigenschappen op het account. Als deze vlag onwaar is, wordt toegewezen kernquotum alleen afgedwongen via de eigenschap dedicatedCoreQuota op het account en wordt geen rekening gehouden met de virtuele-machinefamilie.

properties.encryption

EncryptionProperties

De versleutelingsconfiguratie voor het Batch-account.
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.

properties.keyVaultReference

KeyVaultReference

Een verwijzing naar de Azure-sleutelkluis die is gekoppeld aan het Batch-account.
Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.

properties.lowPriorityCoreQuota

integer (int32)

Het kernquotum voor spot/lage prioriteit voor het Batch-account.
Voor accounts met PoolAllocationMode ingesteld op UserSubscription wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd.

properties.networkProfile

NetworkProfile

Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat.
Het netwerkprofiel wordt alleen van kracht wanneer publicNetworkAccess is ingeschakeld.

properties.nodeManagementEndpoint

string

Het eindpunt dat door het rekenknooppunt wordt gebruikt om verbinding te maken met de Beheerservice voor Batch-knooppunten.

properties.poolAllocationMode

PoolAllocationMode

De toewijzingsmodus die moet worden gebruikt voor het maken van pools in het Batch-account.
De toewijzingsmodus voor het maken van pools in het Batch-account.

properties.poolQuota

integer (int32)

Het poolquotum voor het Batch-account.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan het Batch-account

properties.provisioningState

ProvisioningState

De ingerichte status van de resource

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Het type netwerkinterface voor toegang tot de Azure Batch-service en Batch-accountbewerkingen.
Als deze niet is opgegeven, is de standaardwaarde ingeschakeld.

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 configuratie van de Batch-accountversleuteling 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 verstrekt voor een door het systeem toegewezen identiteit.

tenantId

string

De tenant-id die is gekoppeld aan het Batch-account. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.

type

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor het Batch-account.

userAssignedIdentities

<string,  UserAssignedIdentities>

De lijst met gebruikersidentiteiten die zijn gekoppeld aan het Batch-account.

BatchAccountListResult

Waarden die worden geretourneerd door de bewerking Lijst.

Name Type Description
nextLink

string

Het vervolgtoken.

value

BatchAccount[]

De verzameling Batch-accounts die worden geretourneerd door de vermeldingsbewerking.

CloudError

Een foutreactie van de Batch-service.

Name Type Description
error

CloudErrorBody

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

CloudErrorBody[]

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

KeySource

Type sleutelbron.

keyVaultProperties

KeyVaultProperties

Aanvullende informatie bij het gebruik van Microsoft.KeyVault

EndpointAccessDefaultAction

De standaardactie wanneer er geen IPRule-overeenkomst is gevonden.

Waarde Description
Allow

Clienttoegang toestaan.

Deny

Clienttoegang weigeren.

EndpointAccessProfile

Netwerktoegangsprofiel voor Batch-eindpunt.

Name Type Description
defaultAction

EndpointAccessDefaultAction

De standaardactie wanneer er geen IPRule-overeenkomst is gevonden.
Standaardactie voor eindpunttoegang. Dit is alleen van toepassing wanneer publicNetworkAccess is ingeschakeld.

ipRules

IPRule[]

Matrix van IP-bereiken om het IP-adres van de client te filteren.

IPRule

Regel voor het filteren van het IP-adres van de client.

Name Type Description
action

IPRuleAction

Actie wanneer het IP-adres van de client overeenkomt.

value

string

Het IP-adres of IP-adresbereik dat moet worden gefilterd
IPv4-adres of IPv4-adresbereik in CIDR-indeling.

IPRuleAction

Actie wanneer het IP-adres van de client overeenkomt.

Waarde Description
Allow

Hiermee staat u toegang toe voor het overeenkomende IP-adres van de client.

KeySource

Type sleutelbron.

Waarde Description
Microsoft.Batch

Batch maakt en beheert de versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen.

Microsoft.KeyVault

De versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen, worden opgeslagen in een externe sleutelkluis. Als deze is ingesteld, moet de Batch-accountidentiteit worden ingesteld op SystemAssigned en moet er ook een geldige sleutel-id worden opgegeven onder de keyVaultProperties.

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. of https://mykeyvault.vault.azure.net/keys/testkey. Aan de volgende vereisten moet worden voldaan om te kunnen worden gebruikt:

Het Batch-account heeft een door het systeem toegewezen identiteit De account-id is key/get, sleutel/uitpakken en sleutel-/wrap-machtigingen verleend. De KeyVault heeft voorlopig verwijderen en beveiliging tegen opschonen ingeschakeld

KeyVaultReference

Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.

Name Type Description
id

string (arm-id)

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

EndpointAccessProfile

Netwerktoegangsprofiel voor batchAccount-eindpunt (API voor batchaccountgegevensvlak).

nodeManagementAccess

EndpointAccessProfile

Netwerktoegangsprofiel voor nodeManagement-eindpunt (Batch-service die rekenknooppunten voor Batch-pools beheert).

PoolAllocationMode

De toewijzingsmodus voor het maken van pools in het Batch-account.

Waarde Description
BatchService

Pools worden toegewezen in abonnementen die eigendom zijn van de Batch-service.

UserSubscription

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 is van het formulier /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.
De waarde heeft één en slechts één groeps-id.

properties.privateEndpoint

PrivateEndpoint

De ARM-resource-id van het privé-eindpunt.
Het privé-eindpunt van de privé-eindpuntverbinding.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding.
De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding

properties.provisioningState

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbinding.

tags

object

De tags van de resource.

type

string

Het type resource.

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbinding.

Waarde Description
Cancelled

De gebruiker heeft het maken van de verbinding geannuleerd.

Creating

De verbinding wordt gemaakt.

Deleting

De verbinding wordt verwijdert.

Failed

De gebruiker heeft gevraagd om de verbinding bij te werken en de verbinding is mislukt. U kunt de updatebewerking opnieuw proberen.

Succeeded

De verbindingsstatus is definitief en kan worden gebruikt als de status is goedgekeurd.

Updating

De gebruiker heeft gevraagd om de verbindingsstatus bij te werken, maar de updatebewerking is nog niet voltooid. Mogelijk verwijst u niet naar de verbinding bij het verbinden van het Batch-account.

PrivateLinkServiceConnectionState

De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding

Name Type Description
actionsRequired

string

Actie vereist voor de privéverbindingsstatus

description

string

Beschrijving van de privéverbindingsstatus

status

PrivateLinkServiceConnectionStatus

De status voor de privé-eindpuntverbinding van het Batch-account

PrivateLinkServiceConnectionStatus

De status van de privé-eindpuntverbinding van Batch

Waarde Description
Approved

De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt voor toegang tot het Batch-account

Disconnected

De verbinding met het privé-eindpunt is verbroken en kan niet worden gebruikt voor toegang tot het Batch-account

Pending

De verbinding met het privé-eindpunt is in behandeling en kan niet worden gebruikt voor toegang tot het Batch-account

Rejected

De verbinding met het privé-eindpunt wordt geweigerd en kan niet worden gebruikt voor toegang tot het Batch-account

ProvisioningState

De ingerichte status van de resource

Waarde Description
Cancelled

De laatste bewerking voor het account wordt geannuleerd.

Creating

Het account wordt gemaakt.

Deleting

Het account wordt verwijderd.

Failed

De laatste bewerking voor het account is mislukt.

Invalid

Het account heeft een ongeldige status.

Succeeded

Het account is gemaakt en is klaar voor gebruik.

PublicNetworkAccessType

Het netwerktoegangstype voor gebruik op de resources in het Batch-account.

Waarde Description
Disabled

Hiermee schakelt u openbare connectiviteit uit en maakt u privéconnectiviteit met Azure Batch Service mogelijk via een privé-eindpuntresource.

Enabled

Maakt connectiviteit met Azure Batch mogelijk via openbare DNS.

SecuredByPerimeter

Beveiligt de connectiviteit met Azure Batch via NSP-configuratie.

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor het Batch-account.

Waarde Description
None

Er is geen identiteit aan het Batch-account gekoppeld. Als u None instelt in het updateaccount, worden bestaande identiteiten verwijderd.

SystemAssigned

Batch-account heeft een door het systeem toegewezen identiteit.

UserAssigned

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 (int32)

Het kernquotum voor de VM-familie voor het Batch-account.

name

string

De familienaam van de virtuele machine.