Certificate - List
Wyświetla listę wszystkich certyfikatów, które zostały dodane do określonego konta.
Ostrzeżenie: Ta operacja jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault .
GET {batchUrl}/certificates?api-version=2023-11-01.18.0
GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
batch
|
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-certificates. |
|
$select
|
query |
string |
Klauzula $select OData. |
|
maxresults
|
query |
integer int32 |
Maksymalna liczba elementów do zwrócenia w odpowiedzi. Można zwrócić maksymalnie 1000 certyfikató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 |
Odpowiedź zawierająca listę certyfikatów. Nagłówki
|
|
Other Status Codes |
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
Certificate list
Przykładowe żądanie
GET account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0
Przykładowa odpowiedź
{
"value": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
"state": "deletefailed",
"stateTransitionTime": "2014-07-31T21:12:58.236Z",
"previousState": "deleting",
"previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
"publicData": "#####...",
"deleteCertificateError": {
"code": "PoolsReferencingCertificate",
"message": "The specified certificate is being used by the below mentioned pool(s)",
"values": [
{
"name": "Pools",
"value": "mypool1"
}
]
}
}
]
}
Definicje
Nazwa | Opis |
---|---|
Batch |
Odpowiedź o błędzie odebrana z usługi Azure Batch. |
Batch |
Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu. |
Certificate |
Certyfikat, który można zainstalować w węzłach obliczeniowych i może służyć do uwierzytelniania operacji na maszynie. |
Certificate |
Wynik wyświetlania listy certyfikatów na koncie. |
Certificate |
Stan certyfikatu. |
Delete |
Błąd napotkany przez usługę Batch podczas usuwania certyfikatu. |
Error |
Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu. |
Name |
Reprezentuje parę name-value. |
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 |
Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
|
values |
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. |
Certificate
Certyfikat, który można zainstalować w węzłach obliczeniowych i może służyć do uwierzytelniania operacji na maszynie.
Nazwa | Typ | Opis |
---|---|---|
deleteCertificateError |
Błąd, który wystąpił podczas ostatniej próby usunięcia tego certyfikatu. |
|
previousState |
Poprzedni stan certyfikatu. |
|
previousStateTransitionTime |
string |
Czas, w którym certyfikat wprowadził swój poprzedni stan. |
publicData |
string |
Publiczna część certyfikatu jako plik .cer zakodowany w formacie base-64. |
state |
Bieżący stan certyfikatu. |
|
stateTransitionTime |
string |
Czas, w którym certyfikat wprowadził bieżący stan. |
thumbprint |
string |
Odcisk palca X.509 certyfikatu. Jest to sekwencja maksymalnie 40 cyfr szesnastkowa. |
thumbprintAlgorithm |
string |
Algorytm używany do uzyskiwania odcisku palca. |
url |
string |
Adres URL certyfikatu. |
CertificateListResult
Wynik wyświetlania listy certyfikatów na koncie.
Nazwa | Typ | Opis |
---|---|---|
odata.nextLink |
string |
Adres URL umożliwiający uzyskanie następnego zestawu wyników. |
value |
Lista certyfikatów. |
CertificateState
Stan certyfikatu.
Nazwa | Typ | Opis |
---|---|---|
active |
string |
Certyfikat jest dostępny do użycia w pulach. |
deletefailed |
string |
Użytkownik zażądał usunięcia certyfikatu, ale istnieją pule, które nadal mają odwołania do certyfikatu lub nadal są zainstalowane w co najmniej jednym węzłze. (Ten ostatni może wystąpić, jeśli certyfikat został usunięty z puli, ale węzeł obliczeniowy nie został jeszcze uruchomiony ponownie. Węzły obliczeniowe odświeżają swoje certyfikaty tylko po ponownym uruchomieniu). Możesz użyć operacji anulowania usuwania certyfikatu w celu anulowania usunięcia lub operacji usuwania certyfikatu, aby ponowić próbę usunięcia. |
deleting |
string |
Użytkownik zażądał usunięcia certyfikatu, ale operacja usuwania nie została jeszcze ukończona. Podczas tworzenia lub aktualizowania pul nie można odwoływać się do certyfikatu. |
DeleteCertificateError
Błąd napotkany przez usługę Batch podczas usuwania certyfikatu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Identyfikator błędu usuwania certyfikatu. Kody są niezmienne i mają być używane programowo. |
message |
string |
Komunikat opisujący błąd usuwania certyfikatu, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
values |
Lista dodatkowych szczegółów błędu związanych z błędem usuwania certyfikatu. |
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. |
NameValuePair
Reprezentuje parę name-value.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa w parze name-value. |
value |
string |
Wartość w parze name-value. |