Update Certificate Policy - Update Certificate Policy

Reference

Service:: Key Vault

API Version:: 7.4

Aktualizace zásady pro certifikát.
Nastavte zadané členy v zásadách certifikátů. Ostatní ponechte jako null. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizacím.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
certificate-name	path	True	string	Název certifikátu v daném trezoru.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
attributes	CertificateAttributes	Atributy certifikátu.
issuer	IssuerParameters	Parametry vystavitele komponenty X509 certifikátu.
key_props	KeyProperties	Vlastnosti klíče, který je součástí certifikátu.
lifetime_actions	LifetimeAction[]	Akce, které budou prováděny Key Vault po celou dobu životnosti certifikátu.
secret_props	SecretProperties	Vlastnosti tajného klíče, který je součástí certifikátu.
x509_props	X509CertificateProperties	Vlastnosti komponenty X509 certifikátu.

Odpovědi

Name	Typ	Description
200 OK	CertificatePolicy	Zásady certifikátů
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující příčinu selhání operace.

Příklady

UpdateCertificatePolicy

Sample Request

HTTP

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

{
  "key_props": {
    "exportable": true,
    "kty": "RSA",
    "key_size": 2048,
    "reuse_key": false
  },
  "secret_props": {
    "contentType": "application/x-pkcs12"
  },
  "x509_props": {
    "subject": "CN=KeyVaultTest",
    "ekus": [],
    "key_usage": [],
    "validity_months": 297
  },
  "lifetime_actions": [
    {
      "trigger": {
        "lifetime_percentage": 80
      },
      "action": {
        "action_type": "EmailContacts"
      }
    }
  ],
  "issuer": {
    "name": "Self"
  },
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/policy",
  "key_props": {
    "exportable": true,
    "kty": "RSA",
    "key_size": 2048,
    "reuse_key": false
  },
  "secret_props": {
    "contentType": "application/x-pkcs12"
  },
  "x509_props": {
    "subject": "CN=KeyVaultTest",
    "ekus": [],
    "key_usage": [],
    "validity_months": 297
  },
  "lifetime_actions": [
    {
      "trigger": {
        "lifetime_percentage": 80
      },
      "action": {
        "action_type": "EmailContacts"
      }
    }
  ],
  "issuer": {
    "name": "Self"
  },
  "attributes": {
    "enabled": true,
    "created": 1482188947,
    "updated": 1482188948
  }
}

Definice

Name	Description
Action	Akce, která se provede.
CertificateAttributes	Atributy správy certifikátů.
CertificatePolicy	Zásady správy pro certifikát.
CertificatePolicyAction	Typ akce.
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být certifikát trvale odstraněn uživatelem s oprávněním; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.
Error	Chyba serveru trezoru klíčů.
IssuerParameters	Parametry vystavitele komponenty X509 certifikátu.
JsonWebKeyCurveName	Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
JsonWebKeyType	Typ páru klíčů, který se má použít pro certifikát.
KeyProperties	Vlastnosti páru klíčů, které jsou součástí certifikátu.
KeyUsageType	Definuje způsob použití klíče certifikátu.
KeyVaultError	Výjimka chyby trezoru klíčů
LifetimeAction	Akce a její aktivační událost, kterou bude provádět Key Vault po celou dobu životnosti certifikátu.
SecretProperties	Vlastnosti klíče, který je součástí certifikátu.
SubjectAlternativeNames	Alternativní názvy předmětu objektu X509.
Trigger	Podmínka, která má být splněna pro provedení akce.
X509CertificateProperties	Vlastnosti komponenty X509 certifikátu.

Action

Akce, která se provede.

Name	Typ	Description
action_type	CertificatePolicyAction	Typ akce.

CertificateAttributes

Atributy správy certifikátů.

Name	Typ	Description
created	integer	Čas vytvoření ve standardu UTC.
enabled	boolean	Určuje, zda je objekt povolen.
exp	integer	Datum vypršení platnosti v UTC.
nbf	integer	Není před datem v UTC.
recoverableDays	integer	softDelete data retention days. Hodnota by měla být >=7 a <=90, pokud je povolená funkce softDelete, jinak 0.
recoveryLevel	DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být certifikát trvale odstraněn uživatelem s oprávněním; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.
updated	integer	Čas poslední aktualizace v UTC.

CertificatePolicy

Zásady správy pro certifikát.

Name	Typ	Description
attributes	CertificateAttributes	Atributy certifikátu.
id	string	ID certifikátu.
issuer	IssuerParameters	Parametry vystavitele komponenty X509 certifikátu.
key_props	KeyProperties	Vlastnosti klíče, který je součástí certifikátu.
lifetime_actions	LifetimeAction[]	Akce, které budou prováděny Key Vault po celou dobu životnosti certifikátu.
secret_props	SecretProperties	Vlastnosti tajného klíče, který je součástí certifikátu.
x509_props	X509CertificateProperties	Vlastnosti komponenty X509 certifikátu.

CertificatePolicyAction

Typ akce.

Name	Typ	Description
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být certifikát trvale odstraněn uživatelem s oprávněním; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.

Name	Typ	Description
CustomizedRecoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, pokud je 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.
CustomizedRecoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není požadována operace vyprázdnění nebo pokud není zrušeno předplatné.
Purgeable	string	Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde k nenávratné ztrátě dat.
Recoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Recoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Recoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud není požadována operace vyprázdnění nebo pokud není předplatné zrušeno. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.

Error

Chyba serveru trezoru klíčů.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

IssuerParameters

Parametry vystavitele komponenty X509 certifikátu.

Name	Typ	Description
cert_transparency	boolean	Určuje, jestli mají být certifikáty vygenerované v rámci této zásady publikovány v protokolech transparentnosti certifikátů.
cty	string	Typ certifikátu podporovaný poskytovatelem (volitelné); například OV-SSL, EV-SSL
name	string	Název objektu odkazovaného vystavitele nebo rezervovaných názvů; Například "Self" nebo "Unknown".

JsonWebKeyCurveName

Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.

Name	Typ	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Typ páru klíčů, který se má použít pro certifikát.

Name	Typ	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Vlastnosti páru klíčů, které jsou součástí certifikátu.

Name	Typ	Description
crv	JsonWebKeyCurveName	Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
exportable	boolean	Označuje, jestli je možné exportovat privátní klíč. Při vytváření první verze exportovatelného klíče je nutné zadat zásady vydané verze.
key_size	integer	Velikost klíče v bitech Například: 2048, 3072 nebo 4096 pro RSA.
kty	JsonWebKeyType	Typ páru klíčů, který se má použít pro certifikát.
reuse_key	boolean	Určuje, jestli se při prodloužení platnosti certifikátu použije stejný pár klíčů.

KeyUsageType

Definuje způsob použití klíče certifikátu.

Name	Typ	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

LifetimeAction

Akce a její aktivační událost, kterou bude provádět Key Vault po celou dobu životnosti certifikátu.

Name	Typ	Description
action	Action	Akce, která se provede.
trigger	Trigger	Podmínka, která provede akci.

SecretProperties

Vlastnosti klíče, který je součástí certifikátu.

Name	Typ	Description
contentType	string	Typ média (typ MIME).

SubjectAlternativeNames

Alternativní názvy předmětu objektu X509.

Name	Typ	Description
dns_names	string[]	Názvy domén.
emails	string[]	Email adresy.
upns	string[]	Hlavní názvy uživatelů.

Trigger

Podmínka, která má být splněna pro provedení akce.

Name	Typ	Description
days_before_expiry	integer	Počet dní před vypršením platnosti se pokusit o prodloužení platnosti. Hodnota by měla být v rozmezí od 1 do validity_in_months vynásobená hodnotou 27. Pokud je validity_in_months 36, měla by být hodnota mezi 1 a 972 (36 × 27).
lifetime_percentage	integer	Procento životnosti, při které se má aktivovat. Hodnota by měla být mezi 1 a 99.

X509CertificateProperties

Vlastnosti komponenty X509 certifikátu.

Name	Typ	Description
ekus	string[]	Rozšířené využití klíče.
key_usage	KeyUsageType[]	Definuje způsob použití klíče certifikátu.
sans	SubjectAlternativeNames	Alternativní názvy předmětu
subject	string	Název subjektu. Měl by být platný rozlišující název X509.
validity_months	integer	Doba platnosti certifikátu v měsících.