Update Certificate - Update Certificate

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 7.4

Aktualizacje określone atrybuty skojarzone z danym certyfikatem.
Operacja UpdateCertificate stosuje określoną aktualizację dla danego certyfikatu; jedynymi zaktualizowanymi elementami są atrybuty certyfikatu. Ta operacja wymaga uprawnień certyfikatów/aktualizacji.

PATCH {vaultBaseUrl}/certificates/{certificate-name}/{certificate-version}?api-version=7.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
certificate-name	path	True	string	Nazwa certyfikatu w danym magazynie kluczy.
certificate-version	path	True	string	Wersja certyfikatu.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu (opcjonalnie).
policy	CertificatePolicy	Zasady zarządzania certyfikatu.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CertificateBundle	Zaktualizowany certyfikat.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

UpdateCertificate

Przykładowe żądanie

HTTP

PATCH https://myvault.vault.azure.net//certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc?api-version=7.4

{
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "kid": "https://myvault.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "sid": "https://myvault.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1482188981,
    "updated": 1482188981
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Definicje

Nazwa	Opis
Action	Akcja, która zostanie wykonana.
CertificateAttributes	Atrybuty zarządzania certyfikatami.
CertificateBundle	Pakiet certyfikatów składa się z certyfikatu (X509) oraz jego atrybutów.
CertificatePolicy	Zasady zarządzania dla certyfikatu.
CertificatePolicyAction	Typ akcji.
CertificateUpdateParameters	Parametry aktualizacji certyfikatu.
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera wartość "Przeczyszczalną", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu okresu przechowywania.
Error	Błąd serwera magazynu kluczy.
IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName.
JsonWebKeyType	Typ pary kluczy, która ma być używana dla certyfikatu.
KeyProperties	Właściwości pary kluczy kopii zapasowej certyfikatu.
KeyUsageType	Definiuje sposób użycia klucza certyfikatu.
KeyVaultError	Wyjątek błędu magazynu kluczy.
LifetimeAction	Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.
SecretProperties	Właściwości klucza kopii zapasowej certyfikatu.
SubjectAlternativeNames	Alternatywne nazwy podmiotu obiektu X509.
Trigger	Warunek, który ma zostać spełniony, aby wykonać akcję.
X509CertificateProperties	Właściwości składnika X509 certyfikatu.

Action

Akcja, która zostanie wykonana.

Nazwa	Typ	Opis
action_type	CertificatePolicyAction	Typ akcji.

CertificateAttributes

Atrybuty zarządzania certyfikatami.

Nazwa	Typ	Opis
created	integer	Czas utworzenia w formacie UTC.
enabled	boolean	Określa, czy obiekt jest włączony.
exp	integer	Data wygaśnięcia w formacie UTC.
nbf	integer	Nie wcześniej niż data w formacie UTC.
recoverableDays	integer	softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć >wartość =7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie 0.
recoveryLevel	DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera wartość "Przeczyszczalną", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu okresu przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

CertificateBundle

Pakiet certyfikatów składa się z certyfikatu (X509) oraz jego atrybutów.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu.
cer	string	Zawartość CER certyfikatu x509.
contentType	string	Typ zawartości wpisu tajnego. np. "application/x-pem-file" lub "application/x-pkcs12",
id	string	Identyfikator certyfikatu.
kid	string	Identyfikator klucza.
policy	CertificatePolicy	Zasady zarządzania.
sid	string	Identyfikator wpisu tajnego.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość
x5t	string	Odcisk palca certyfikatu.

CertificatePolicy

Zasady zarządzania dla certyfikatu.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu.
id	string	Identyfikator certyfikatu.
issuer	IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
key_props	KeyProperties	Właściwości klucza kopii zapasowej certyfikatu.
lifetime_actions	LifetimeAction[]	Akcje, które będą wykonywane przez Key Vault przez okres istnienia certyfikatu.
secret_props	SecretProperties	Właściwości wpisu tajnego do tworzenia kopii zapasowej certyfikatu.
x509_props	X509CertificateProperties	Właściwości składnika X509 certyfikatu.

CertificatePolicyAction

Typ akcji.

Nazwa	Typ	Opis
AutoRenew	string
EmailContacts	string

CertificateUpdateParameters

Parametry aktualizacji certyfikatu.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu (opcjonalnie).
policy	CertificatePolicy	Zasady zarządzania certyfikatu.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera wartość "Przeczyszczalną", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu okresu przechowywania.

Nazwa	Typ	Opis
CustomizedRecoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7< = SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.
CustomizedRecoverable+ProtectedSubscription	string	Oznacza, że magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7< = SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.
CustomizedRecoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7< = SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.
Purgeable	string	Określa stan magazynu, w którym usunięcie jest operacją nieodwracalną, bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
Recoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
Recoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w okresie przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
Recoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

Nazwa	Typ	Opis
cert_transparency	boolean	Wskazuje, czy certyfikaty wygenerowane w ramach tych zasad powinny być publikowane w dziennikach przezroczystości certyfikatów.
cty	string	Typ certyfikatu obsługiwany przez dostawcę (opcjonalnie); na przykład "OV-SSL", "EV-SSL"
name	string	Nazwa obiektu wystawcy, do których odwołuje się odwołanie lub nazwy zarezerwowane; na przykład "Self" lub "Unknown".

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName.

Nazwa	Typ	Opis
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Typ pary kluczy, która ma być używana dla certyfikatu.

Nazwa	Typ	Opis
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Właściwości pary kluczy kopii zapasowej certyfikatu.

Nazwa	Typ	Opis
crv	JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName.
exportable	boolean	Wskazuje, czy klucz prywatny można wyeksportować. Zasady wydania należy podać podczas tworzenia pierwszej wersji klucza możliwego do wyeksportowania.
key_size	integer	Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA.
kty	JsonWebKeyType	Typ pary kluczy, która ma być używana dla certyfikatu.
reuse_key	boolean	Wskazuje, czy ta sama para kluczy będzie używana podczas odnawiania certyfikatu.

KeyUsageType

Definiuje sposób użycia klucza certyfikatu.

Nazwa	Typ	Opis
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

LifetimeAction

Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.

Nazwa	Typ	Opis
action	Action	Akcja, która zostanie wykonana.
trigger	Trigger	Warunek, który wykona akcję.

SecretProperties

Właściwości klucza kopii zapasowej certyfikatu.

Nazwa	Typ	Opis
contentType	string	Typ nośnika (typ MIME).

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Nazwa	Typ	Opis
dns_names	string[]	Nazwy domen.
emails	string[]	Email adresy.
upns	string[]	Główne nazwy użytkowników.

Trigger

Warunek, który ma zostać spełniony, aby wykonać akcję.

Nazwa	Typ	Opis
days_before_expiry	integer	Dni przed wygaśnięciem, aby spróbować odnowić. Wartość powinna być z zakresu od 1 do validity_in_months pomnożona przez 27. Jeśli validity_in_months wynosi 36, wartość powinna należeć do przedziału od 1 do 972 (36 * 27).
lifetime_percentage	integer	Procent okresu istnienia, w którym ma być wyzwalany. Wartość powinna należeć do przedziału od 1 do 99.

X509CertificateProperties

Właściwości składnika X509 certyfikatu.

Nazwa	Typ	Opis
ekus	string[]	Ulepszone użycie klucza.
key_usage	KeyUsageType[]	Definiuje sposób użycia klucza certyfikatu.
sans	SubjectAlternativeNames	Alternatywne nazwy podmiotu.
subject	string	Nazwa podmiotu. Powinna być prawidłową nazwą wyróżniającą X509.
validity_months	integer	Czas trwania certyfikatu jest ważny w miesiącach.

Udostępnij za pośrednictwem