Certificate - Add

Usługa:

Batch Service

Wersja interfejsu API:

2023-11-01.18.0

Dodaje certyfikat 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 .

POST {batchUrl}/certificates?api-version=2023-11-01.18.0

Z parametrami opcjonalnymi:

POST {batchUrl}/certificates?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.
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.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
data	True	string	Zawartość zakodowana w formacie base64 certyfikatu. Maksymalny rozmiar to 10 KB.
thumbprint	True	string	Odcisk palca X.509 certyfikatu. Jest to sekwencja maksymalnie 40 cyfr szesnastkowy (może zawierać spacje, ale są one usuwane).
thumbprintAlgorithm	True	string	Algorytm używany do uzyskiwania odcisku palca. Musi to być sha1.
certificateFormat		CertificateFormat	Format danych certyfikatu.
password		string	Hasło umożliwiające uzyskanie dostępu do klucza prywatnego certyfikatu. Musi to zostać pominięte, jeśli format certyfikatu ma wartość cer.

Odpowiedzi

Nazwa	Typ	Opis
201 Created		Żądanie usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: 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

Certificate add

Przykładowe żądanie

HTTP

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



{
  "thumbprintAlgorithm": "sha1",
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "data": "#####...",
  "certificateFormat": "pfx",
  "password": "<ExamplePassword>"
}

Przykładowa odpowiedź

Kod stanu:

201

Definicje

Nazwa	Opis
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
CertificateAddParameter	Certyfikat, który można zainstalować w węzłach obliczeniowych i może służyć do uwierzytelniania operacji na maszynie.
CertificateFormat	Format danych certyfikatu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

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.

CertificateAddParameter

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
certificateFormat	CertificateFormat	Format danych certyfikatu.
data	string	Zawartość zakodowana w formacie base64 certyfikatu. Maksymalny rozmiar to 10 KB.
password	string	Hasło umożliwiające uzyskanie dostępu do klucza prywatnego certyfikatu. Musi to zostać pominięte, jeśli format certyfikatu ma wartość cer.
thumbprint	string	Odcisk palca X.509 certyfikatu. Jest to sekwencja maksymalnie 40 cyfr szesnastkowy (może zawierać spacje, ale są one usuwane).
thumbprintAlgorithm	string	Algorytm używany do uzyskiwania odcisku palca. Musi to być sha1.

CertificateFormat

Format danych certyfikatu.

Nazwa	Typ	Opis
cer	string	Certyfikat jest certyfikatem X.509 zakodowanym w formacie base64.
pfx	string	Certyfikat jest certyfikatem PFX (PKCS#12) sformatowanym certyfikatem lub łańcuchem certyfikatów.

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.