Udostępnij za pośrednictwem


Batch Account - List

Pobiera informacje o kontach usługi Batch skojarzonych z subskrypcją.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string

Identyfikator subskrypcji platformy Azure. Jest to ciąg sformatowany w formacie GUID (np. 000000000-0000-0000-0000-0000000000000)

api-version
query True

string

Wersja interfejsu API do użycia z żądaniem HTTP.

Odpowiedzi

Nazwa Typ Opis
200 OK

BatchAccountListResult

Operacja zakończyła się pomyślnie. Odpowiedź zawiera listę jednostek konta usługi Batch skojarzonych z subskrypcją.

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

BatchAccountList

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AuthenticationMode

Tryb uwierzytelniania dla konta usługi Batch.

AutoStorageAuthenticationMode

Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu.

AutoStorageProperties

Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.

BatchAccount

Zawiera informacje o koncie usługi Azure Batch.

BatchAccountIdentity

Tożsamość konta usługi Batch, jeśli jest skonfigurowana. Jest to używane, gdy użytkownik określa wartość "Microsoft.KeyVault" jako konfigurację szyfrowania konta usługi Batch lub po wybraniu ManagedIdentity jako trybu uwierzytelniania automatycznego magazynu.

BatchAccountListResult

Wartości zwracane przez operację Lista.

CloudError

Odpowiedź na błąd z usługi Batch.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

EncryptionProperties

Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.

EndpointAccessDefaultAction

Domyślna akcja, gdy nie ma pasowanego adresu IPRule.

EndpointAccessProfile

Profil dostępu do sieci dla punktu końcowego usługi Batch.

IPRule

Reguła filtrowania adresu IP klienta.

IPRuleAction

Akcja w przypadku dopasowania adresu IP klienta.

KeySource

Typ źródła klucza.

KeyVaultProperties

Konfiguracja usługi KeyVault podczas korzystania z szyfrowania KeySource usługi Microsoft.KeyVault.

KeyVaultReference

Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.

NetworkProfile

Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieciowej dla każdego punktu końcowego.

PoolAllocationMode

Tryb alokacji do tworzenia pul na koncie usługi Batch.

PrivateEndpoint

Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

PrivateEndpointConnection

Zawiera informacje o zasobie łącza prywatnego.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego usługi Batch

ProvisioningState

Stan aprowizacji zasobu

PublicNetworkAccessType

Typ dostępu do sieci dla operacji na zasobach na koncie usługi Batch.

ResourceIdentityType

Typ tożsamości używany dla konta usługi Batch.

UserAssignedIdentities

Lista skojarzonych tożsamości użytkowników.

VirtualMachineFamilyCoreQuota

Rodzina maszyn wirtualnych i skojarzony z nim limit przydziału rdzeni dla konta usługi Batch.

AuthenticationMode

Tryb uwierzytelniania dla konta usługi Batch.

Wartość Opis
AAD

Tryb uwierzytelniania przy użyciu identyfikatora Entra firmy Microsoft.

SharedKey

Tryb uwierzytelniania przy użyciu kluczy udostępnionych.

TaskAuthenticationToken

Tryb uwierzytelniania przy użyciu tokenów uwierzytelniania zadań.

AutoStorageAuthenticationMode

Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu.

Wartość Opis
BatchAccountManagedIdentity

Usługa Batch uwierzytelni żądania do automatycznego magazynu przy użyciu tożsamości zarządzanej przypisanej do konta usługi Batch.

StorageKeys

Usługa Batch będzie uwierzytelniać żądania do automatycznego magazynu przy użyciu kluczy konta magazynu.

AutoStorageProperties

Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.

Nazwa Typ Domyślna wartość Opis
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu.

lastKeySync

string (date-time)

Godzina UTC, o której klucze magazynu zostały ostatnio zsynchronizowane z kontem usługi Batch.

nodeIdentityReference

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika, której węzły obliczeniowe będą używać do uzyskiwania dostępu do automatycznego magazynu.
Tożsamość, do której odwołuje się tutaj, musi być przypisana do pul, które mają węzły obliczeniowe wymagające dostępu do automatycznego magazynu.

storageAccountId

string (arm-id)

Identyfikator zasobu konta magazynu, który ma być używany dla konta magazynu automatycznego.

BatchAccount

Zawiera informacje o koncie usługi Azure Batch.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator zasobu.

identity

BatchAccountIdentity

Tożsamość konta usługi Batch.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.accountEndpoint

string

Punkt końcowy konta używany do interakcji z usługą Batch.

properties.activeJobAndJobScheduleQuota

integer (int32)

Aktywny limit przydziału zadania i harmonogramu zadań dla konta usługi Batch.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista dozwolonych trybów uwierzytelniania dla konta usługi Batch, których można użyć do uwierzytelniania za pomocą płaszczyzny danych. Nie ma to wpływu na uwierzytelnianie za pomocą płaszczyzny sterowania.

properties.autoStorage

AutoStorageProperties

Właściwości i stan dowolnego konta automatycznego magazynu skojarzonego z kontem usługi Batch.
Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.

properties.dedicatedCoreQuota

integer (int32)

Dedykowany limit przydziału rdzeni dla konta usługi Batch.
W przypadku kont z wartością PoolAllocationMode ustawioną na UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Lista dedykowanych przydziałów rdzeni dla rodziny maszyn wirtualnych dla konta usługi Batch. W przypadku kont z wartością PoolAllocationMode ustawioną na UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

Wartość wskazująca, czy limity przydziału rdzeni dla rodziny maszyn wirtualnych są wymuszane dla tego konta
Jeśli ta flaga ma wartość true, dedykowany limit przydziału rdzeni jest wymuszany za pośrednictwem właściwości dedicatedCoreQuotaPerVMFamily i dedicatedCoreQuota na koncie. Jeśli ta flaga ma wartość false, dedykowany limit przydziału rdzeni jest wymuszany tylko za pośrednictwem właściwości dedicatedCoreQuota na koncie i nie uwzględnia rodziny maszyn wirtualnych.

properties.encryption

EncryptionProperties

Konfiguracja szyfrowania dla konta usługi Batch.
Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.

properties.keyVaultReference

KeyVaultReference

Odwołanie do magazynu kluczy platformy Azure skojarzonego z kontem usługi Batch.
Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.

properties.lowPriorityCoreQuota

integer (int32)

Limit przydziału rdzeni typu spot/low-priority dla konta usługi Batch.
W przypadku kont z wartością PoolAllocationMode ustawioną na UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.

properties.networkProfile

NetworkProfile

Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieciowej dla każdego punktu końcowego.
Profil sieciowy ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona.

properties.nodeManagementEndpoint

string

Punkt końcowy używany przez węzeł obliczeniowy do nawiązywania połączenia z usługą zarządzania węzłami usługi Batch.

properties.poolAllocationMode

PoolAllocationMode

Tryb alokacji używany do tworzenia pul na koncie usługi Batch.
Tryb alokacji do tworzenia pul na koncie usługi Batch.

properties.poolQuota

integer (int32)

Limit przydziału puli dla konta usługi Batch.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista połączeń prywatnych punktów końcowych skojarzonych z kontem usługi Batch

properties.provisioningState

ProvisioningState

Stan aprowizacji zasobu

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Typ interfejsu sieciowego na potrzeby uzyskiwania dostępu do usługi Azure Batch i operacji konta usługi Batch.
Jeśli nie zostanie określona, wartość domyślna to "włączone".

tags

object

Tagi zasobu.

type

string

Typ zasobu.

BatchAccountIdentity

Tożsamość konta usługi Batch, jeśli jest skonfigurowana. Jest to używane, gdy użytkownik określa wartość "Microsoft.KeyVault" jako konfigurację szyfrowania konta usługi Batch lub po wybraniu ManagedIdentity jako trybu uwierzytelniania automatycznego magazynu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń konta usługi Batch. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

tenantId

string

Identyfikator dzierżawy skojarzony z kontem usługi Batch. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

type

ResourceIdentityType

Typ tożsamości używany dla konta usługi Batch.

userAssignedIdentities

<string,  UserAssignedIdentities>

Lista tożsamości użytkowników skojarzonych z kontem usługi Batch.

BatchAccountListResult

Wartości zwracane przez operację Lista.

Nazwa Typ Opis
nextLink

string

Token kontynuacji.

value

BatchAccount[]

Kolekcja kont usługi Batch zwróconych przez operację wyświetlania listy.

CloudError

Odpowiedź na błąd z usługi Batch.

Nazwa Typ Opis
error

CloudErrorBody

Treść odpowiedzi o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

CloudErrorBody[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

EncryptionProperties

Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.

Nazwa Typ Opis
keySource

KeySource

Typ źródła klucza.

keyVaultProperties

KeyVaultProperties

Dodatkowe szczegóły dotyczące korzystania z usługi Microsoft.KeyVault

EndpointAccessDefaultAction

Domyślna akcja, gdy nie ma pasowanego adresu IPRule.

Wartość Opis
Allow

Zezwalaj na dostęp klienta.

Deny

Odmowa dostępu klienta.

EndpointAccessProfile

Profil dostępu do sieci dla punktu końcowego usługi Batch.

Nazwa Typ Opis
defaultAction

EndpointAccessDefaultAction

Domyślna akcja, gdy nie ma pasowanego adresu IPRule.
Domyślna akcja dostępu do punktu końcowego. Ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona.

ipRules

IPRule[]

Tablica zakresów adresów IP do filtrowania adresu IP klienta.

IPRule

Reguła filtrowania adresu IP klienta.

Nazwa Typ Opis
action

IPRuleAction

Akcja w przypadku dopasowania adresu IP klienta.

value

string

Adres IP lub zakres adresów IP do filtrowania
Adres IPv4 lub zakres adresów IPv4 w formacie CIDR.

IPRuleAction

Akcja w przypadku dopasowania adresu IP klienta.

Wartość Opis
Allow

Zezwalaj na dostęp do dopasowanego adresu IP klienta.

KeySource

Typ źródła klucza.

Wartość Opis
Microsoft.Batch

Usługa Batch tworzy klucze szyfrowania używane do ochrony danych konta i zarządza nimi.

Microsoft.KeyVault

Klucze szyfrowania używane do ochrony danych konta są przechowywane w zewnętrznym magazynie kluczy. Jeśli ta wartość jest ustawiona, tożsamość konta usługi Batch musi być ustawiona na SystemAssigned, a prawidłowy identyfikator klucza musi być również podany w obszarze keyVaultProperties.

KeyVaultProperties

Konfiguracja usługi KeyVault podczas korzystania z szyfrowania KeySource usługi Microsoft.KeyVault.

Nazwa Typ Opis
keyIdentifier

string

Pełna ścieżka do wpisu tajnego z wersją lub bez tej wersji. Przykład https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. lub https://mykeyvault.vault.azure.net/keys/testkey. Aby można było używać następujących wymagań wstępnych, należy spełnić następujące wymagania wstępne:

Konto usługi Batch ma tożsamość przypisaną przez system Tożsamość konta została udzielona: Klucz/Get, Klucz/Odpakuj i Klucz/Zawijanie uprawnień KeyVault ma włączoną ochronę przed usuwaniem nietrwałym i przeczyszczaniem

KeyVaultReference

Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.

Nazwa Typ Opis
id

string (arm-id)

Identyfikator zasobu magazynu kluczy platformy Azure skojarzony z kontem usługi Batch.

url

string

Adres URL magazynu kluczy platformy Azure skojarzony z kontem usługi Batch.

NetworkProfile

Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieciowej dla każdego punktu końcowego.

Nazwa Typ Opis
accountAccess

EndpointAccessProfile

Profil dostępu do sieci dla punktu końcowego batchAccount (interfejs API płaszczyzny danych konta usługi Batch).

nodeManagementAccess

EndpointAccessProfile

Profil dostępu do sieci dla punktu końcowego nodeManagement (usługa Batch zarządzająca węzłami obliczeniowymi dla pul usługi Batch).

PoolAllocationMode

Tryb alokacji do tworzenia pul na koncie usługi Batch.

Wartość Opis
BatchService

Pule zostaną przydzielone w subskrypcjach należących do usługi Batch.

UserSubscription

Pule zostaną przydzielone w subskrypcji należącej do użytkownika.

PrivateEndpoint

Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Identyfikator zasobu usługi ARM prywatnego punktu końcowego. Jest to formularz /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Zawiera informacje o zasobie łącza prywatnego.

Nazwa Typ Opis
etag

string

Element ETag zasobu używany na potrzeby instrukcji współbieżności.

id

string

Identyfikator zasobu.

name

string

Nazwa zasobu.

properties.groupIds

string[]

Identyfikator grupy połączenia prywatnego punktu końcowego.
Wartość ma jeden i tylko jeden identyfikator grupy.

properties.privateEndpoint

PrivateEndpoint

Identyfikator zasobu usługi ARM prywatnego punktu końcowego.
Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym.
Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

tags

object

Tagi zasobu.

type

string

Typ zasobu.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Wartość Opis
Cancelled

Użytkownik anulował tworzenie połączenia.

Creating

Połączenie jest tworzone.

Deleting

Połączenie jest usuwane.

Failed

Użytkownik zażądał, aby połączenie zostało zaktualizowane i nie powiodło się. Możesz ponowić próbę wykonania operacji aktualizacji.

Succeeded

Stan połączenia jest końcowy i jest gotowy do użycia, jeśli stan to Zatwierdzone.

Updating

Użytkownik zażądał zaktualizowania stanu połączenia, ale operacja aktualizacji nie została jeszcze ukończona. Nie można odwoływać się do połączenia podczas nawiązywania połączenia z kontem usługi Batch.

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

Nazwa Typ Opis
actionsRequired

string

Akcja wymagana w stanie połączenia prywatnego

description

string

Opis stanu połączenia prywatnego

status

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego konta usługi Batch

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego usługi Batch

Wartość Opis
Approved

Połączenie prywatnego punktu końcowego jest zatwierdzone i może służyć do uzyskiwania dostępu do konta usługi Batch

Disconnected

Połączenie prywatnego punktu końcowego jest rozłączone i nie można go użyć do uzyskiwania dostępu do konta usługi Batch

Pending

Trwa oczekiwanie na połączenie prywatnego punktu końcowego i nie można go użyć do uzyskania dostępu do konta usługi Batch

Rejected

Połączenie prywatnego punktu końcowego jest odrzucane i nie można go użyć do uzyskiwania dostępu do konta usługi Batch

ProvisioningState

Stan aprowizacji zasobu

Wartość Opis
Cancelled

Ostatnia operacja dla konta została anulowana.

Creating

Konto jest tworzone.

Deleting

Konto jest usuwane.

Failed

Ostatnia operacja dla konta nie powiodła się.

Invalid

Konto jest w nieprawidłowym stanie.

Succeeded

Konto zostało utworzone i jest gotowe do użycia.

PublicNetworkAccessType

Typ dostępu do sieci dla operacji na zasobach na koncie usługi Batch.

Wartość Opis
Disabled

Wyłącza łączność publiczną i umożliwia prywatną łączność z usługą Azure Batch za pośrednictwem zasobu prywatnego punktu końcowego.

Enabled

Umożliwia łączność z usługą Azure Batch za pośrednictwem publicznej usługi DNS.

SecuredByPerimeter

Zabezpiecza łączność z usługą Azure Batch za pośrednictwem konfiguracji NSP.

ResourceIdentityType

Typ tożsamości używany dla konta usługi Batch.

Wartość Opis
None

Konto usługi Batch nie ma skojarzonej tożsamości. Ustawienie None na koncie aktualizacji spowoduje usunięcie istniejących tożsamości.

SystemAssigned

Konto usługi Batch ma przypisaną przez system tożsamość.

UserAssigned

Konto usługi Batch ma przypisane przez użytkownika tożsamości.

UserAssignedIdentities

Lista skojarzonych tożsamości użytkowników.

Nazwa Typ Opis
clientId

string

Identyfikator klienta tożsamości przypisanej przez użytkownika.

principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

VirtualMachineFamilyCoreQuota

Rodzina maszyn wirtualnych i skojarzony z nim limit przydziału rdzeni dla konta usługi Batch.

Nazwa Typ Opis
coreQuota

integer (int32)

Limit przydziału rdzeni dla rodziny maszyn wirtualnych dla konta usługi Batch.

name

string

Nazwa rodziny maszyn wirtualnych.