Condividi tramite


Batch Account - List

Ottiene informazioni sugli account Batch associati alla sottoscrizione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-0000-000000000000)

api-version
query True

string

Versione dell'API da usare con la richiesta HTTP.

Risposte

Nome Tipo Descrizione
200 OK

BatchAccountListResult

L'operazione è stata completata. La risposta contiene un elenco di entità dell'account Batch associate alla sottoscrizione.

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Microsoft Entra flusso del codice di autenticazione OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

BatchAccountList

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}

Definizioni

Nome Descrizione
AuthenticationMode

Modalità di autenticazione per l'account Batch.

AutoStorageAuthenticationMode

Modalità di autenticazione che verrà usata dal servizio Batch per gestire l'account di archiviazione automatica.

AutoStorageProperties

Contiene informazioni sull'account di archiviazione automatico associato a un account Batch.

BatchAccount

Contiene informazioni su un account Azure Batch.

BatchAccountIdentity

Identità dell'account Batch, se configurata. Viene usato quando l'utente specifica "Microsoft.KeyVault" come configurazione di crittografia dell'account Batch o quando ManagedIdentity viene selezionato come modalità di autenticazione di archiviazione automatica.

BatchAccountListResult

Valori restituiti dall'operazione List.

CloudError

Risposta di errore dal servizio Batch.

CloudErrorBody

Risposta di errore dal servizio Batch.

ComputeNodeIdentityReference

Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo.

EncryptionProperties

Configura il modo in cui i dati dei clienti vengono crittografati all'interno dell'account Batch. Per impostazione predefinita, gli account vengono crittografati usando una chiave gestita da Microsoft. Per un controllo aggiuntivo, è possibile usare invece una chiave gestita dal cliente.

EndpointAccessDefaultAction

Azione predefinita quando non è presente alcuna corrispondenza IPRule.

EndpointAccessProfile

Profilo di accesso alla rete per l'endpoint Batch.

IPRule

Regola per filtrare l'indirizzo IP del client.

IPRuleAction

Azione quando viene trovata una corrispondenza con l'indirizzo IP del client.

KeySource

Tipo dell'origine della chiave.

KeyVaultProperties

Configurazione dell'insieme di credenziali delle chiavi quando si usa un keysource di crittografia di Microsoft.KeyVault.

KeyVaultReference

Identifica l'insieme di credenziali delle chiavi di Azure associato a un account Batch.

NetworkProfile

Profilo di rete per l'account Batch, che contiene le impostazioni delle regole di rete per ogni endpoint.

PoolAllocationMode

Modalità di allocazione per la creazione di pool nell'account Batch.

PrivateEndpoint

Endpoint privato della connessione dell'endpoint privato.

PrivateEndpointConnection

Contiene informazioni su una risorsa di collegamento privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

PrivateLinkServiceConnectionState

Stato di connessione del servizio di collegamento privato della connessione all'endpoint privato

PrivateLinkServiceConnectionStatus

Stato della connessione dell'endpoint privato Batch

ProvisioningState

Stato di provisioning della risorsa

PublicNetworkAccessType

Tipo di accesso di rete per l'uso delle risorse nell'account Batch.

ResourceIdentityType

Tipo di identità usato per l'account Batch.

UserAssignedIdentities

Elenco delle identità utente associate.

VirtualMachineFamilyCoreQuota

Una famiglia di macchine virtuali e la quota di core associata per l'account Batch.

AuthenticationMode

Modalità di autenticazione per l'account Batch.

Nome Tipo Descrizione
AAD

string

Modalità di autenticazione tramite Microsoft Entra ID.

SharedKey

string

Modalità di autenticazione tramite chiavi condivise.

TaskAuthenticationToken

string

Modalità di autenticazione che usa i token di autenticazione delle attività.

AutoStorageAuthenticationMode

Modalità di autenticazione che verrà usata dal servizio Batch per gestire l'account di archiviazione automatica.

Nome Tipo Descrizione
BatchAccountManagedIdentity

string

Il servizio Batch autentica le richieste di archiviazione automatica usando l'identità gestita assegnata all'account Batch.

StorageKeys

string

Il servizio Batch autentica le richieste all'archiviazione automatica usando le chiavi dell'account di archiviazione.

AutoStorageProperties

Contiene informazioni sull'account di archiviazione automatico associato a un account Batch.

Nome Tipo Valore predefinito Descrizione
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Modalità di autenticazione che il servizio Batch userà per gestire l'account di archiviazione automatica.

lastKeySync

string

Ora UTC in cui le chiavi di archiviazione sono state sincronizzate con l'account Batch.

nodeIdentityReference

ComputeNodeIdentityReference

Riferimento all'identità assegnata dall'utente che i nodi di calcolo useranno per accedere all'archiviazione automatica.
L'identità a cui si fa riferimento qui deve essere assegnata a pool con nodi di calcolo che necessitano dell'accesso all'archiviazione automatica.

storageAccountId

string

ID risorsa dell'account di archiviazione da usare per l'account di archiviazione automatica.

BatchAccount

Contiene informazioni su un account Azure Batch.

Nome Tipo Valore predefinito Descrizione
id

string

ID della risorsa.

identity

BatchAccountIdentity

Identità dell'account Batch.

location

string

Il percorso della risorsa.

name

string

Nome della risorsa.

properties.accountEndpoint

string

Endpoint dell'account usato per interagire con il servizio Batch.

properties.activeJobAndJobScheduleQuota

integer

Quota di pianificazione del processo e del processo attiva per l'account Batch.

properties.allowedAuthenticationModes

AuthenticationMode[]

Elenco delle modalità di autenticazione consentite per l'account Batch che può essere usato per l'autenticazione con il piano dati. Ciò non influisce sull'autenticazione con il piano di controllo.

properties.autoStorage

AutoStorageProperties

Proprietà e stato di qualsiasi account di archiviazione automatica associato all'account Batch.
Contiene informazioni sull'account di archiviazione automatico associato a un account Batch.

properties.dedicatedCoreQuota

integer

Quota di base dedicata per l'account Batch.
Per gli account con PoolAllocationMode impostato su UserSubscription, la quota viene gestita nella sottoscrizione in modo che questo valore non venga restituito.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Elenco della quota core dedicata per ogni famiglia di macchine virtuali per l'account Batch. Per gli account con PoolAllocationMode impostato su UserSubscription, la quota viene gestita nella sottoscrizione in modo che questo valore non venga restituito.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

Valore che indica se le quote di base per famiglia di macchine virtuali vengono applicate per questo account
Se questo flag è true, la quota core dedicata viene applicata tramite le proprietà dedicatedCoreQuotaPerVMFamily e dedicateCoreQuota nell'account. Se questo flag è false, la quota core dedicata viene applicata solo tramite la proprietà dedicatedCoreQuota nell'account e non considera la famiglia di macchine virtuali.

properties.encryption

EncryptionProperties

Configurazione della crittografia per l'account Batch.
Configura il modo in cui i dati dei clienti vengono crittografati all'interno dell'account Batch. Per impostazione predefinita, gli account vengono crittografati usando una chiave gestita da Microsoft. Per un controllo aggiuntivo, è possibile usare invece una chiave gestita dal cliente.

properties.keyVaultReference

KeyVaultReference

Riferimento all'insieme di credenziali delle chiavi di Azure associato all'account Batch.
Identifica l'insieme di credenziali delle chiavi di Azure associato a un account Batch.

properties.lowPriorityCoreQuota

integer

Quota principale spot/bassa priorità per l'account Batch.
Per gli account con PoolAllocationMode impostato su UserSubscription, la quota viene gestita nella sottoscrizione in modo che questo valore non venga restituito.

properties.networkProfile

NetworkProfile

Profilo di rete per l'account Batch, che contiene le impostazioni delle regole di rete per ogni endpoint.
Il profilo di rete ha effetto solo quando publicNetworkAccess è abilitato.

properties.nodeManagementEndpoint

string

Endpoint usato dal nodo di calcolo per connettersi al servizio di gestione dei nodi Batch.

properties.poolAllocationMode

PoolAllocationMode

Modalità di allocazione da usare per la creazione di pool nell'account Batch.
Modalità di allocazione per la creazione di pool nell'account Batch.

properties.poolQuota

integer

Quota del pool per l'account Batch.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Elenco di connessioni endpoint private associate all'account Batch

properties.provisioningState

ProvisioningState

Stato di provisioning della risorsa

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Tipo di interfaccia di rete per l'accesso alle operazioni del servizio e dell'account Batch Azure Batch.
Se non specificato, il valore predefinito è "abilitato".

tags

object

Tag della risorsa.

type

string

Tipo di risorsa.

BatchAccountIdentity

Identità dell'account Batch, se configurata. Viene usato quando l'utente specifica "Microsoft.KeyVault" come configurazione di crittografia dell'account Batch o quando ManagedIdentity viene selezionato come modalità di autenticazione di archiviazione automatica.

Nome Tipo Descrizione
principalId

string

ID principale dell'account Batch. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

tenantId

string

ID tenant associato all'account Batch. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

type

ResourceIdentityType

Tipo di identità utilizzata per l'account Batch.

userAssignedIdentities

object

Elenco delle identità utente associate all'account Batch.

BatchAccountListResult

Valori restituiti dall'operazione List.

Nome Tipo Descrizione
nextLink

string

Token di continuità.

value

BatchAccount[]

Raccolta di account Batch restituiti dall'operazione di presentazione.

CloudError

Risposta di errore dal servizio Batch.

Nome Tipo Descrizione
error

CloudErrorBody

Corpo della risposta all'errore.

CloudErrorBody

Risposta di errore dal servizio Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.

details

CloudErrorBody[]

Elenco di dettagli aggiuntivi sull'errore.

message

string

Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

target

string

Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in caso di errore.

ComputeNodeIdentityReference

Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo.

Nome Tipo Descrizione
resourceId

string

ID risorsa ARM dell'identità assegnata dall'utente.

EncryptionProperties

Configura il modo in cui i dati dei clienti vengono crittografati all'interno dell'account Batch. Per impostazione predefinita, gli account vengono crittografati usando una chiave gestita da Microsoft. Per un controllo aggiuntivo, è possibile usare invece una chiave gestita dal cliente.

Nome Tipo Descrizione
keySource

KeySource

Tipo dell'origine della chiave.

keyVaultProperties

KeyVaultProperties

Dettagli aggiuntivi quando si usa Microsoft.KeyVault

EndpointAccessDefaultAction

Azione predefinita quando non è presente alcuna corrispondenza IPRule.

Nome Tipo Descrizione
Allow

string

Consentire l'accesso client.

Deny

string

Negare l'accesso client.

EndpointAccessProfile

Profilo di accesso alla rete per l'endpoint Batch.

Nome Tipo Descrizione
defaultAction

EndpointAccessDefaultAction

Azione predefinita quando non è presente alcuna corrispondenza IPRule.
Azione predefinita per l'accesso all'endpoint. È applicabile solo quando publicNetworkAccess è abilitato.

ipRules

IPRule[]

Matrice di intervalli IP per filtrare l'indirizzo IP del client.

IPRule

Regola per filtrare l'indirizzo IP del client.

Nome Tipo Descrizione
action

IPRuleAction

Azione quando viene trovata una corrispondenza con l'indirizzo IP del client.

value

string

L'indirizzo IP o l'intervallo di indirizzi IP da filtrare
Indirizzo IPv4 o intervallo di indirizzi IPv4 in formato CIDR.

IPRuleAction

Azione quando viene trovata una corrispondenza con l'indirizzo IP del client.

Nome Tipo Descrizione
Allow

string

Consentire l'accesso per l'indirizzo IP client corrispondente.

KeySource

Tipo dell'origine della chiave.

Nome Tipo Descrizione
Microsoft.Batch

string

Batch crea e gestisce le chiavi di crittografia usate per proteggere i dati dell'account.

Microsoft.KeyVault

string

Le chiavi di crittografia usate per proteggere i dati dell'account vengono archiviate in un insieme di credenziali delle chiavi esterno. Se questa impostazione è impostata, l'identità dell'account Batch deve essere impostata su SystemAssigned e deve essere fornito anche un identificatore di chiave valido in keyVaultProperties.

KeyVaultProperties

Configurazione dell'insieme di credenziali delle chiavi quando si usa un keysource di crittografia di Microsoft.KeyVault.

Nome Tipo Descrizione
keyIdentifier

string

Percorso completo del segreto con o senza versione. Ad esempio, https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. o https://mykeyvault.vault.azure.net/keys/testkey. Per essere utilizzabili, è necessario soddisfare i prerequisiti seguenti:

L'account Batch ha un'identità assegnata dal sistema L'identità dell'account è stata concessa a Key/Get, Key/Unwrap e Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyVaultReference

Identifica l'insieme di credenziali delle chiavi di Azure associato a un account Batch.

Nome Tipo Descrizione
id

string

ID risorsa dell'istanza di Azure Key Vault associata all'account Batch.

url

string

URL dell'istanza di Azure Key Vault associata all'account Batch.

NetworkProfile

Profilo di rete per l'account Batch, che contiene le impostazioni delle regole di rete per ogni endpoint.

Nome Tipo Descrizione
accountAccess

EndpointAccessProfile

Profilo di accesso di rete per l'endpoint batchAccount (API del piano dati dell'account Batch).

nodeManagementAccess

EndpointAccessProfile

Profilo di accesso di rete per l'endpoint nodeManagement (servizio Batch che gestisce i nodi di calcolo per i pool batch).

PoolAllocationMode

Modalità di allocazione per la creazione di pool nell'account Batch.

Nome Tipo Descrizione
BatchService

string

I pool verranno allocati nelle sottoscrizioni di proprietà del servizio Batch.

UserSubscription

string

I pool verranno allocati in una sottoscrizione di proprietà dell'utente.

PrivateEndpoint

Endpoint privato della connessione dell'endpoint privato.

Nome Tipo Descrizione
id

string

Identificatore della risorsa ARM dell'endpoint privato. Si tratta del formato /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contiene informazioni su una risorsa di collegamento privato.

Nome Tipo Descrizione
etag

string

ETag della risorsa usata per le istruzioni di concorrenza.

id

string

ID della risorsa.

name

string

Nome della risorsa.

properties.groupIds

string[]

ID gruppo della connessione dell'endpoint privato.
Il valore ha uno e un solo ID gruppo.

properties.privateEndpoint

PrivateEndpoint

Identificatore di risorsa ARM dell'endpoint privato.
Endpoint privato della connessione dell'endpoint privato.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato.
Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

type

string

Tipo di risorsa.

PrivateEndpointConnectionProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

Nome Tipo Descrizione
Cancelled

string

L'utente ha annullato la creazione della connessione.

Creating

string

La connessione sta creando.

Deleting

string

La connessione viene eliminata.

Failed

string

L'utente ha richiesto che la connessione venga aggiornata e non è riuscita. È possibile ritentare l'operazione di aggiornamento.

Succeeded

string

Lo stato della connessione è finale ed è pronto per l'uso se lo stato è Approvato.

Updating

string

L'utente ha richiesto l'aggiornamento dello stato della connessione, ma l'operazione di aggiornamento non è ancora stata completata. Non è possibile fare riferimento alla connessione durante la connessione dell'account Batch.

PrivateLinkServiceConnectionState

Stato di connessione del servizio di collegamento privato della connessione all'endpoint privato

Nome Tipo Descrizione
actionsRequired

string

Azione necessaria per lo stato della connessione privata

description

string

Descrizione dello stato della connessione privata

status

PrivateLinkServiceConnectionStatus

Stato della connessione dell'endpoint privato dell'account Batch

PrivateLinkServiceConnectionStatus

Stato della connessione dell'endpoint privato Batch

Nome Tipo Descrizione
Approved

string

La connessione all'endpoint privato è approvata e può essere usata per accedere all'account Batch

Disconnected

string

La connessione all'endpoint privato è disconnessa e non può essere usata per accedere all'account Batch

Pending

string

La connessione all'endpoint privato è in sospeso e non può essere usata per accedere all'account Batch

Rejected

string

La connessione all'endpoint privato viene rifiutata e non può essere usata per accedere all'account Batch

ProvisioningState

Stato di provisioning della risorsa

Nome Tipo Descrizione
Cancelled

string

L'ultima operazione per l'account viene annullata.

Creating

string

L'account viene creato.

Deleting

string

L'account viene eliminato.

Failed

string

L'ultima operazione per l'account non è riuscita.

Invalid

string

L'account si trova in uno stato non valido.

Succeeded

string

L'account è stato creato e è pronto per l'uso.

PublicNetworkAccessType

Tipo di accesso di rete per l'uso delle risorse nell'account Batch.

Nome Tipo Descrizione
Disabled

string

Disabilita la connettività pubblica e consente la connettività privata per Azure Batch servizio tramite la risorsa dell'endpoint privato.

Enabled

string

Consente la connettività per Azure Batch tramite DNS pubblico.

ResourceIdentityType

Tipo di identità usato per l'account Batch.

Nome Tipo Descrizione
None

string

All'account Batch non è associata alcuna identità. L'impostazione None nell'account di aggiornamento rimuoverà le identità esistenti.

SystemAssigned

string

L'account Batch ha un'identità assegnata dal sistema.

UserAssigned

string

L'account Batch ha identità assegnate dall'utente.

UserAssignedIdentities

Elenco delle identità utente associate.

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata dall'utente.

principalId

string

ID principale dell'identità assegnata dall'utente.

VirtualMachineFamilyCoreQuota

Una famiglia di macchine virtuali e la quota di core associata per l'account Batch.

Nome Tipo Descrizione
coreQuota

integer

Quota di core per la famiglia di macchine virtuali per l'account Batch.

name

string

Nome della famiglia di macchine virtuali.