Account - List Supported Images

Usługa:

Batch Service

Wersja interfejsu API:

2023-11-01.18.0

Wyświetla listę wszystkich obrazów maszyn wirtualnych obsługiwanych przez usługę Azure Batch.

GET {batchUrl}/supportedimages?api-version=2023-11-01.18.0

Z parametrami opcjonalnymi:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsługi Azure Batch.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Klauzula $filter OData. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Zostanie zwróconych maksymalnie 1000 wyników.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

Media Types: "application/json; odata=minimalmetadata"

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić wartość client-request-id w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AccountListSupportedImagesResult	Odpowiedź zawierająca listę obsługiwanych obrazów maszyn wirtualnych. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0

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

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Account list node agent skus

Przykładowe żądanie

HTTP

GET account.region.batch.azure.com/supportedimages?api-version=2023-11-01.18.0

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "nodeAgentSKUId": "batch.node.centos 7",
      "imageReference": {
        "publisher": "OpenLogic",
        "offer": "CentOS",
        "sku": "7.2",
        "version": "latest"
      },
      "verificationType": "verified",
      "capabilities": [
        "DockerCompatible",
        "NvidiaTeslaDriverInstalled"
      ],
      "osType": "linux"
    },
    {
      "nodeAgentSKUId": "batch.node.centos 7",
      "imageReference": {
        "publisher": "OpenLogic",
        "offer": "CentOS",
        "sku": "7.1",
        "version": "latest"
      },
      "verificationType": "unverified",
      "osType": "linux",
      "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z"
    },
    {
      "nodeAgentSKUId": "batch.node.debian 8",
      "imageReference": {
        "publisher": "Credativ",
        "offer": "Debian",
        "sku": "8",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "linux"
    },
    {
      "nodeAgentSKUId": "batch.node.windows amd64",
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "windows"
    },
    {
      "nodeAgentSKUId": "batch.node.windows amd64",
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-Datacenter",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "windows"
    }
  ]
}

Definicje

Nazwa	Opis
AccountListSupportedImagesResult	Wynik wyświetlania listy obsługiwanych obrazów maszyn wirtualnych.
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
ImageInformation	Odwołanie do obrazu witryny Azure Virtual Machines Marketplace i dodatkowe informacje o obrazie.
ImageReference	Odwołanie do obrazu witryny Azure Virtual Machines Marketplace lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "Wyświetlanie listy obsługiwanych obrazów".
OSType	Typ systemu operacyjnego (np. Windows lub Linux) obrazu.
VerificationType	Czy usługa Azure Batch aktywnie sprawdza, czy obraz jest zgodny z skojarzona jednostka SKU agenta węzła obliczeniowego.

AccountListSupportedImagesResult

Wynik wyświetlania listy obsługiwanych obrazów maszyn wirtualnych.

Nazwa	Typ	Opis
odata.nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	ImageInformation[]	Lista obsługiwanych obrazów maszyn wirtualnych.

BatchError

Odpowiedź o błędzie odebrana z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

ImageInformation

Odwołanie do obrazu witryny Azure Virtual Machines Marketplace i dodatkowe informacje o obrazie.

Nazwa	Typ	Opis
batchSupportEndOfLife	string	Czas, kiedy usługa Azure Batch przestanie akceptować żądania puli dla obrazu.
capabilities	string[]	Możliwości lub funkcje obsługiwane przez obraz. Nie każda możliwość obrazu jest wyświetlana. Możliwości na tej liście są uznawane za interesujące i są ogólnie związane z integracją z innymi funkcjami w usłudze Azure Batch.
imageReference	ImageReference	Odwołanie do obrazu witryny Marketplace maszyny wirtualnej platformy Azure.
nodeAgentSKUId	string	Identyfikator jednostki SKU agenta węzła obliczeniowego, którą obsługuje obraz.
osType	OSType	Typ systemu operacyjnego (np. Windows lub Linux) obrazu.
verificationType	VerificationType	Czy usługa Azure Batch aktywnie sprawdza, czy obraz jest zgodny z skojarzona jednostka SKU agenta węzła obliczeniowego.

ImageReference

Odwołanie do obrazu witryny Azure Virtual Machines Marketplace lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "Wyświetlanie listy obsługiwanych obrazów".

Nazwa	Typ	Opis
exactVersion	string	Określona wersja obrazu platformy lub obrazu witryny Marketplace używana do utworzenia węzła. To pole tylko do odczytu różni się od "wersji" tylko wtedy, gdy wartość określona dla "wersji" podczas tworzenia puli była "najnowsza".
offer	string	Typ oferty obrazu witryny Azure Virtual Machines Marketplace. Na przykład UbuntuServer lub WindowsServer.
publisher	string	Wydawca obrazu witryny Azure Virtual Machines Marketplace. Na przykład Canonical lub MicrosoftWindowsServer.
sku	string	Jednostka SKU obrazu witryny Azure Virtual Machines Marketplace. Na przykład 18.04-LTS lub 2019-Datacenter.
version	string	Wersja obrazu witryny Azure Virtual Machines Marketplace. Można określić wartość "latest", aby wybrać najnowszą wersję obrazu. Jeśli pominięto, wartość domyślna to "latest".
virtualMachineImageId	string	Identyfikator zasobu usługi ARM obrazu galerii obliczeniowej platformy Azure. Węzły obliczeniowe w puli zostaną utworzone przy użyciu tego identyfikatora obrazu. Jest to formularz /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} lub /subscriptions/{subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{gallerys/{galleryName}/images/{imageDefinitionName} dla zawsze domyślnej wersji obrazu. Ta właściwość wzajemnie wyklucza się z innymi właściwościami ImageReference. Obraz galerii obliczeniowej platformy Azure musi mieć repliki w tym samym regionie i musi znajdować się w tej samej subskrypcji co konto Azure Batch. Jeśli wersja obrazu nie zostanie określona w identyfikatorze imageId, zostanie użyta najnowsza wersja. Aby uzyskać informacje o ustawieniach zapory dla agenta węzła obliczeniowego usługi Batch do komunikowania się z usługą Batch, zobacz https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

Typ systemu operacyjnego (np. Windows lub Linux) obrazu.

Nazwa	Typ	Opis
linux	string	System operacyjny Linux.
windows	string	System operacyjny Windows.

VerificationType

Czy usługa Azure Batch aktywnie sprawdza, czy obraz jest zgodny z skojarzona jednostka SKU agenta węzła obliczeniowego.

Nazwa	Typ	Opis
unverified	string	Skojarzona jednostka SKU agenta węzła obliczeniowego powinna mieć zgodność binarną z obrazem, ale określone funkcje nie zostały zweryfikowane.
verified	string	Obraz ma gwarancję zgodności ze skojarzona jednostka SKU agenta węzła obliczeniowego, a wszystkie funkcje usługi Batch zostały potwierdzone, aby działały zgodnie z oczekiwaniami.