Update Certificate Policy - Update Certificate Policy
証明書のポリシーを更新します。
証明書ポリシーで指定されたメンバーを設定します。 他のユーザーは null のままにします。 この操作には、証明書/更新アクセス許可が必要です。
PATCH {vaultBaseUrl}/certificates/{certificate-name}/policy?api-version=7.4
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
certificate-name
|
path | True |
string |
指定されたコンテナー内の証明書の名前。 |
vault
|
path | True |
string |
コンテナー名 (例: https://myvault.vault.azure.net)。 |
api-version
|
query | True |
string |
クライアント API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
attributes |
証明書の属性。 |
|
issuer |
証明書の X509 コンポーネントの発行者のパラメーター。 |
|
key_props |
証明書をバックアップするキーのプロパティ。 |
|
lifetime_actions |
証明書の有効期間中にKey Vaultによって実行されるアクション。 |
|
secret_props |
証明書をバックアップするシークレットのプロパティ。 |
|
x509_props |
証明書の X509 コンポーネントのプロパティ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
証明書ポリシー |
|
Other Status Codes |
操作Key Vault失敗した理由を説明するエラー応答です。 |
例
UpdateCertificatePolicy
Sample Request
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
{
"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
}
}
定義
名前 | 説明 |
---|---|
Action |
実行されるアクション。 |
Certificate |
証明書管理属性。 |
Certificate |
証明書の管理ポリシー。 |
Certificate |
アクションの種類。 |
Deletion |
現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。 |
Error |
キー コンテナー サーバー エラー。 |
Issuer |
証明書の X509 コンポーネントの発行者のパラメーター。 |
Json |
楕円曲線名。 有効な値については、「JsonWebKeyCurveName」を参照してください。 |
Json |
証明書に使用するキー ペアの種類。 |
Key |
証明書をバックアップするキー ペアのプロパティ。 |
Key |
証明書のキーの使用方法を定義します。 |
Key |
キー コンテナーのエラー例外。 |
Lifetime |
証明書の有効期間中にKey Vaultによって実行されるアクションとそのトリガー。 |
Secret |
証明書をバックアップするキーのプロパティ。 |
Subject |
X509 オブジェクトのサブジェクト代替名。 |
Trigger |
アクションを実行するために満たす条件。 |
X509Certificate |
証明書の X509 コンポーネントのプロパティ。 |
Action
実行されるアクション。
名前 | 型 | 説明 |
---|---|---|
action_type |
アクションの種類。 |
CertificateAttributes
証明書管理属性。
名前 | 型 | 説明 |
---|---|---|
created |
integer |
UTC での作成時刻。 |
enabled |
boolean |
オブジェクトが有効かどうかを判断します。 |
exp |
integer |
UTC の有効期限。 |
nbf |
integer |
UTC の日付より前ではありません。 |
recoverableDays |
integer |
softDelete data retention days。 softDelete が有効な場合は 、値は >=7、 <=90 である必要があります。それ以外の場合は 0 です。 |
recoveryLevel |
現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。 |
|
updated |
integer |
UTC の最終更新時刻。 |
CertificatePolicy
証明書の管理ポリシー。
名前 | 型 | 説明 |
---|---|---|
attributes |
証明書の属性。 |
|
id |
string |
証明書 ID。 |
issuer |
証明書の X509 コンポーネントの発行者のパラメーター。 |
|
key_props |
証明書をバックアップするキーのプロパティ。 |
|
lifetime_actions |
証明書の有効期間中にKey Vaultによって実行されるアクション。 |
|
secret_props |
証明書をバックアップするシークレットのプロパティ。 |
|
x509_props |
証明書の X509 コンポーネントのプロパティ。 |
CertificatePolicyAction
アクションの種類。
名前 | 型 | 説明 |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
string |
DeletionRecoveryLevel
現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。
名前 | 型 | 説明 |
---|---|---|
CustomizedRecoverable |
string |
即時および永続的な削除を行わずに削除を回復できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合は消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。 |
CustomizedRecoverable+ProtectedSubscription |
string |
7<= SoftDeleteRetentionInDays < 90 の場合に、削除が回復可能、即時および完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。 このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。 |
CustomizedRecoverable+Purgeable |
string |
削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7< = SoftDeleteRetentionInDays < 90 の場合の消去)。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。 |
Purgeable |
string |
復旧の可能性のない、削除が元に戻せない操作であるコンテナーの状態を示します。 このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。 |
Recoverable |
string |
即時および永続的な削除 (消去) を行わずに削除を復旧できるコンテナーの状態を示します。 このレベルでは、リテンション期間 (90 日間) の間、およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します |
Recoverable+ProtectedSubscription |
string |
コンテナーとサブスクリプションの状態を示します。この状態では、保持期間内 (90 日間)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができない状態を示します。 回復されていない場合、システムは90日後にそれを完全に削除します |
Recoverable+Purgeable |
string |
削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します |
Error
キー コンテナー サーバー エラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
innererror |
キー コンテナー サーバー エラー。 |
|
message |
string |
エラー メッセージ。 |
IssuerParameters
証明書の X509 コンポーネントの発行者のパラメーター。
名前 | 型 | 説明 |
---|---|---|
cert_transparency |
boolean |
このポリシーで生成された証明書を証明書透過性ログに発行する必要があるかどうかを示します。 |
cty |
string |
プロバイダーでサポートされている証明書の種類 (省略可能)。;例: "OV-SSL"、"EV-SSL" |
name |
string |
参照されている発行者オブジェクトまたは予約名の名前。たとえば、'Self' や 'Unknown' などです。 |
JsonWebKeyCurveName
楕円曲線名。 有効な値については、「JsonWebKeyCurveName」を参照してください。
名前 | 型 | 説明 |
---|---|---|
P-256 |
string |
|
P-256K |
string |
|
P-384 |
string |
|
P-521 |
string |
JsonWebKeyType
証明書に使用するキー ペアの種類。
名前 | 型 | 説明 |
---|---|---|
EC |
string |
|
EC-HSM |
string |
|
RSA |
string |
|
RSA-HSM |
string |
|
oct |
string |
|
oct-HSM |
string |
KeyProperties
証明書をバックアップするキー ペアのプロパティ。
名前 | 型 | 説明 |
---|---|---|
crv |
楕円曲線名。 有効な値については、「JsonWebKeyCurveName」を参照してください。 |
|
exportable |
boolean |
秘密キーをエクスポートできるかどうかを示します。 エクスポート可能なキーの最初のバージョンを作成するときは、リリース ポリシーを指定する必要があります。 |
key_size |
integer |
キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 |
kty |
証明書に使用するキー ペアの種類。 |
|
reuse_key |
boolean |
証明書の更新時に同じキー ペアを使用するかどうかを示します。 |
KeyUsageType
証明書のキーの使用方法を定義します。
名前 | 型 | 説明 |
---|---|---|
cRLSign |
string |
|
dataEncipherment |
string |
|
decipherOnly |
string |
|
digitalSignature |
string |
|
encipherOnly |
string |
|
keyAgreement |
string |
|
keyCertSign |
string |
|
keyEncipherment |
string |
|
nonRepudiation |
string |
KeyVaultError
キー コンテナーのエラー例外。
名前 | 型 | 説明 |
---|---|---|
error |
キー コンテナー サーバー エラー。 |
LifetimeAction
証明書の有効期間中にKey Vaultによって実行されるアクションとそのトリガー。
名前 | 型 | 説明 |
---|---|---|
action |
実行されるアクション。 |
|
trigger |
アクションを実行する条件。 |
SecretProperties
証明書をバックアップするキーのプロパティ。
名前 | 型 | 説明 |
---|---|---|
contentType |
string |
メディアの種類 (MIME の種類)。 |
SubjectAlternativeNames
X509 オブジェクトのサブジェクト代替名。
名前 | 型 | 説明 |
---|---|---|
dns_names |
string[] |
ドメイン名。 |
emails |
string[] |
メール アドレス。 |
upns |
string[] |
ユーザー プリンシパル名。 |
Trigger
アクションを実行するために満たす条件。
名前 | 型 | 説明 |
---|---|---|
days_before_expiry |
integer |
更新を試みる有効期限の前の日数。 値は 1 ~ validity_in_months 27 を乗算する必要があります。 validity_in_monthsが 36 の場合、値は 1 から 972 (36 * 27) の間である必要があります。 |
lifetime_percentage |
integer |
トリガーする有効期間の割合。 値は 1 から 99 の間である必要があります。 |
X509CertificateProperties
証明書の X509 コンポーネントのプロパティ。
名前 | 型 | 説明 |
---|---|---|
ekus |
string[] |
拡張キーの使用法。 |
key_usage |
証明書のキーの使用方法を定義します。 |
|
sans |
サブジェクトの別名。 |
|
subject |
string |
サブジェクト名。 有効な X509 識別名である必要があります。 |
validity_months |
integer |
証明書が有効な期間 (月単位)。 |