Batch Account - List
Hämtar information om De Batch-konton som är associerade med prenumerationen.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts?api-version=2024-07-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Azure-prenumerations-ID:t. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-00000000000) |
api-version
|
query | True |
string |
DEN API-version som ska användas med HTTP-begäran. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Åtgärden lyckades. Svaret innehåller en lista över Batch-kontoentiteter som är associerade med prenumerationen. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Autentiseringskodflöde för Microsoft Entra OAuth 2.0
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
BatchAccountList
Exempelbegäran
Exempelsvar
{
"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"
}
]
}
Definitioner
Name | Description |
---|---|
Authentication |
Autentiseringsläget för Batch-kontot. |
Auto |
Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring. |
Auto |
Innehåller information om det automatiskt lagringskonto som är associerat med ett Batch-konto. |
Batch |
Innehåller information om ett Azure Batch-konto. |
Batch |
Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som krypteringskonfiguration för Batch-konto eller när |
Batch |
Värden som returneras av liståtgärden. |
Cloud |
Ett felsvar från Batch-tjänsten. |
Cloud |
Ett felsvar från Batch-tjänsten. |
Compute |
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda. |
Encryption |
Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället. |
Endpoint |
Standardåtgärden när det inte finns någon IPRule matchad. |
Endpoint |
Nätverksåtkomstprofil för Batch-slutpunkt. |
IPRule |
Regel för att filtrera klientens IP-adress. |
IPRule |
Åtgärd när klientens IP-adress matchas. |
Key |
Typ av nyckelkälla. |
Key |
KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault. |
Key |
Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto. |
Network |
Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt. |
Pool |
Allokeringsläget för att skapa pooler i Batch-kontot. |
Private |
Den privata slutpunkten för den privata slutpunktsanslutningen. |
Private |
Innehåller information om en privat länkresurs. |
Private |
Etableringstillståndet för den privata slutpunktsanslutningen. |
Private |
Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen |
Private |
Status för den privata Batch-slutpunktsanslutningen |
Provisioning |
Resursens etablerade tillstånd |
Public |
Nätverksåtkomsttypen för drift på resurserna i Batch-kontot. |
Resource |
Den typ av identitet som används för Batch-kontot. |
User |
Listan över associerade användaridentiteter. |
Virtual |
En VM-familj och dess associerade kärnkvot för Batch-kontot. |
AuthenticationMode
Autentiseringsläget för Batch-kontot.
Värde | Description |
---|---|
AAD |
Autentiseringsläget med Microsoft Entra-ID. |
SharedKey |
Autentiseringsläget med delade nycklar. |
TaskAuthenticationToken |
Autentiseringsläget med aktivitetsautentiseringstoken. |
AutoStorageAuthenticationMode
Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring.
Värde | Description |
---|---|
BatchAccountManagedIdentity |
Batch-tjänsten autentiserar begäranden om automatisk lagring med hjälp av den hanterade identitet som tilldelats Batch-kontot. |
StorageKeys |
Batch-tjänsten autentiserar begäranden till automatisk lagring med hjälp av lagringskontonycklar. |
AutoStorageProperties
Innehåller information om det automatiskt lagringskonto som är associerat med ett Batch-konto.
Name | Typ | Standardvärde | Description |
---|---|---|---|
authenticationMode | StorageKeys |
Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring. |
|
lastKeySync |
string (date-time) |
UTC-tiden då lagringsnycklar senast synkroniserades med Batch-kontot. |
|
nodeIdentityReference |
Referensen till den användartilldelade identitet som beräkningsnoder ska använda för att få åtkomst till automatisk lagring. |
||
storageAccountId |
string (arm-id) |
Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto. |
BatchAccount
Innehåller information om ett Azure Batch-konto.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Resursens ID. |
|
identity |
Identiteten för Batch-kontot. |
||
location |
string |
Platsen för resursen. |
|
name |
string |
Namnet på resursen. |
|
properties.accountEndpoint |
string |
Kontoslutpunkten som används för att interagera med Batch-tjänsten. |
|
properties.activeJobAndJobScheduleQuota |
integer (int32) |
Den aktiva jobb- och jobbschemakvoten för Batch-kontot. |
|
properties.allowedAuthenticationModes |
Lista över tillåtna autentiseringslägen för Batch-kontot som kan användas för att autentisera med dataplanet. Detta påverkar inte autentisering med kontrollplanet. |
||
properties.autoStorage |
Egenskaper och status för alla konton för automatisk lagring som är associerade med Batch-kontot. |
||
properties.dedicatedCoreQuota |
integer (int32) |
Den dedikerade kärnkvoten för Batch-kontot. |
|
properties.dedicatedCoreQuotaPerVMFamily |
En lista över den dedikerade kärnkvoten per virtuell datorfamilj för Batch-kontot. För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras. |
||
properties.dedicatedCoreQuotaPerVMFamilyEnforced |
boolean |
Ett värde som anger om kärnkvoter per virtuell dator-familj tillämpas för det här kontot |
|
properties.encryption |
Krypteringskonfigurationen för Batch-kontot. |
||
properties.keyVaultReference |
En referens till Azure-nyckelvalvet som är associerat med Batch-kontot. |
||
properties.lowPriorityCoreQuota |
integer (int32) |
Kärnkvoten Spot/low-priority för Batch-kontot. |
|
properties.networkProfile |
Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt. |
||
properties.nodeManagementEndpoint |
string |
Slutpunkten som används av beräkningsnoden för att ansluta till Batch-nodhanteringstjänsten. |
|
properties.poolAllocationMode |
Det allokeringsläge som ska användas för att skapa pooler i Batch-kontot. |
||
properties.poolQuota |
integer (int32) |
Poolkvoten för Batch-kontot. |
|
properties.privateEndpointConnections |
Lista över privata slutpunktsanslutningar som är associerade med Batch-kontot |
||
properties.provisioningState |
Resursens etablerade tillstånd |
||
properties.publicNetworkAccess | Enabled |
Nätverksgränssnittstypen för åtkomst till Azure Batch-tjänsten och Batch-kontoåtgärder. |
|
tags |
object |
Taggarna för resursen. |
|
type |
string |
Resurstypen. |
BatchAccountIdentity
Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som krypteringskonfiguration för Batch-konto eller när ManagedIdentity
väljs som autentiseringsläge för automatisk lagring.
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID för Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
tenantId |
string |
Klient-ID:t som är associerat med Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
type |
Den typ av identitet som används för Batch-kontot. |
|
userAssignedIdentities |
<string,
User |
Listan över användaridentiteter som är associerade med Batch-kontot. |
BatchAccountListResult
Värden som returneras av liståtgärden.
Name | Typ | Description |
---|---|---|
nextLink |
string |
Fortsättningstoken. |
value |
Samlingen av Batch-konton som returneras av listningsåtgärden. |
CloudError
Ett felsvar från Batch-tjänsten.
Name | Typ | Description |
---|---|---|
error |
Brödtexten i felsvaret. |
CloudErrorBody
Ett felsvar från Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
details |
En lista med ytterligare information om felet. |
|
message |
string |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
target |
string |
Målet för det specifika felet. Till exempel namnet på egenskapen i fel. |
ComputeNodeIdentityReference
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
Name | Typ | Description |
---|---|---|
resourceId |
string |
ARM-resurs-ID för den användartilldelade identiteten. |
EncryptionProperties
Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.
Name | Typ | Description |
---|---|---|
keySource |
Typ av nyckelkälla. |
|
keyVaultProperties |
Ytterligare information när du använder Microsoft.KeyVault |
EndpointAccessDefaultAction
Standardåtgärden när det inte finns någon IPRule matchad.
Värde | Description |
---|---|
Allow |
Tillåt klientåtkomst. |
Deny |
Neka klientåtkomst. |
EndpointAccessProfile
Nätverksåtkomstprofil för Batch-slutpunkt.
Name | Typ | Description |
---|---|---|
defaultAction |
Standardåtgärden när det inte finns någon IPRule matchad. |
|
ipRules |
IPRule[] |
Matris med IP-intervall för att filtrera klientens IP-adress. |
IPRule
Regel för att filtrera klientens IP-adress.
Name | Typ | Description |
---|---|---|
action |
Åtgärd när klientens IP-adress matchas. |
|
value |
string |
IP-adressen eller IP-adressintervallet som ska filtreras |
IPRuleAction
Åtgärd när klientens IP-adress matchas.
Värde | Description |
---|---|
Allow |
Tillåt åtkomst för den matchade klientens IP-adress. |
KeySource
Typ av nyckelkälla.
Värde | Description |
---|---|
Microsoft.Batch |
Batch skapar och hanterar de krypteringsnycklar som används för att skydda kontodata. |
Microsoft.KeyVault |
Krypteringsnycklarna som används för att skydda kontodata lagras i ett externt nyckelvalv. Om detta anges måste Batch-kontoidentiteten anges till |
KeyVaultProperties
KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault.
Name | Typ | Description |
---|---|---|
keyIdentifier |
string |
Fullständig sökväg till hemligheten med eller utan version. Exempel https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. eller https://mykeyvault.vault.azure.net/keys/testkey. För att kunna användas måste följande krav uppfyllas: Batch-kontot har en systemtilldelad identitet Kontoidentiteten har beviljats behörigheterna Nyckel/Hämta, Nyckel/Packa upp och Nyckel/Omslut. KeyVault har mjuk borttagning och rensningsskydd aktiverat |
KeyVaultReference
Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.
Name | Typ | Description |
---|---|---|
id |
string (arm-id) |
Resurs-ID för Azure-nyckelvalvet som är associerat med Batch-kontot. |
url |
string |
URL:en för Azure-nyckelvalvet som är associerat med Batch-kontot. |
NetworkProfile
Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.
Name | Typ | Description |
---|---|---|
accountAccess |
Nätverksåtkomstprofil för batchAccount-slutpunkt (Batch-kontodataplans-API). |
|
nodeManagementAccess |
Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler). |
PoolAllocationMode
Allokeringsläget för att skapa pooler i Batch-kontot.
Värde | Description |
---|---|
BatchService |
Pooler allokeras i prenumerationer som ägs av Batch-tjänsten. |
UserSubscription |
Pooler allokeras i en prenumeration som ägs av användaren. |
PrivateEndpoint
Den privata slutpunkten för den privata slutpunktsanslutningen.
Name | Typ | Description |
---|---|---|
id |
string |
ARM-resursidentifieraren för den privata slutpunkten. Det här är formuläret /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. |
PrivateEndpointConnection
Innehåller information om en privat länkresurs.
Name | Typ | Description |
---|---|---|
etag |
string |
ETag för resursen, som används för samtidighetsinstruktioner. |
id |
string |
Resursens ID. |
name |
string |
Namnet på resursen. |
properties.groupIds |
string[] |
Grupp-ID för den privata slutpunktsanslutningen. |
properties.privateEndpoint |
ARM-resursidentifieraren för den privata slutpunkten. |
|
properties.privateLinkServiceConnectionState |
Anslutningstillståndet för privat länktjänst för den privata slutpunktsanslutningen. |
|
properties.provisioningState |
Etableringstillståndet för den privata slutpunktsanslutningen. |
|
tags |
object |
Taggarna för resursen. |
type |
string |
Resurstypen. |
PrivateEndpointConnectionProvisioningState
Etableringstillståndet för den privata slutpunktsanslutningen.
Värde | Description |
---|---|
Cancelled |
Användaren har avbrutit skapandet av anslutningen. |
Creating |
Anslutningen skapas. |
Deleting |
Anslutningen tas bort. |
Failed |
Användaren begärde att anslutningen skulle uppdateras och att den misslyckades. Du kan försöka uppdatera igen. |
Succeeded |
Anslutningsstatusen är slutgiltig och är klar för användning om Status är Godkänd. |
Updating |
Användaren har begärt att anslutningsstatusen ska uppdateras, men uppdateringsåtgärden har ännu inte slutförts. Du kanske inte refererar till anslutningen när du ansluter Batch-kontot. |
PrivateLinkServiceConnectionState
Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Åtgärd som krävs för det privata anslutningstillståndet |
description |
string |
Beskrivning av det privata anslutningstillståndet |
status |
Status för den privata slutpunktsanslutningen för Batch-kontot |
PrivateLinkServiceConnectionStatus
Status för den privata Batch-slutpunktsanslutningen
Värde | Description |
---|---|
Approved |
Den privata slutpunktsanslutningen är godkänd och kan användas för att komma åt Batch-kontot |
Disconnected |
Den privata slutpunktsanslutningen är frånkopplad och kan inte användas för att komma åt Batch-kontot |
Pending |
Den privata slutpunktsanslutningen väntar och kan inte användas för att komma åt Batch-kontot |
Rejected |
Den privata slutpunktsanslutningen avvisas och kan inte användas för att komma åt Batch-kontot |
ProvisioningState
Resursens etablerade tillstånd
Värde | Description |
---|---|
Cancelled |
Den sista åtgärden för kontot avbryts. |
Creating |
Kontot skapas. |
Deleting |
Kontot tas bort. |
Failed |
Den sista åtgärden för kontot misslyckades. |
Invalid |
Kontot är i ett ogiltigt tillstånd. |
Succeeded |
Kontot har skapats och är redo att användas. |
PublicNetworkAccessType
Nätverksåtkomsttypen för drift på resurserna i Batch-kontot.
Värde | Description |
---|---|
Disabled |
Inaktiverar offentlig anslutning och möjliggör privat anslutning till Azure Batch Service via en privat slutpunktsresurs. |
Enabled |
Möjliggör anslutning till Azure Batch via offentlig DNS. |
SecuredByPerimeter |
Skyddar anslutningen till Azure Batch via NSP-konfiguration. |
ResourceIdentityType
Den typ av identitet som används för Batch-kontot.
Värde | Description |
---|---|
None |
Batch-kontot har ingen associerad identitet. Om du anger |
SystemAssigned |
Batch-kontot har en systemtilldelad identitet med sig. |
UserAssigned |
Batch-kontot har användartilldelade identiteter med sig. |
UserAssignedIdentities
Listan över associerade användaridentiteter.
Name | Typ | Description |
---|---|---|
clientId |
string |
Klient-ID för användartilldelad identitet. |
principalId |
string |
Huvud-ID för användartilldelad identitet. |
VirtualMachineFamilyCoreQuota
En VM-familj och dess associerade kärnkvot för Batch-kontot.
Name | Typ | Description |
---|---|---|
coreQuota |
integer (int32) |
Kärnkvoten för vm-familjen för Batch-kontot. |
name |
string |
Familjenamnet för virtuell dator. |