Delete Certificate - Delete Certificate

サービス:: Key Vault

API バージョン:: 7.4

指定したキーコンテナーから証明書を削除します。
関連付けられているポリシーと共に、証明書オブジェクトのすべてのバージョンを削除します。証明書オブジェクトの個々のバージョンを削除するには、証明書の削除を使用できません。この操作には、証明書/削除アクセス許可が必要です。

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

URI パラメーター

名前	/	必須	型	説明
certificate-name	path	True	string	証明書の名前。
vaultBaseUrl	path	True	string	コンテナー名 (`https://myvault.vault.azure.net`など)。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	DeletedCertificateBundle	削除された証明書。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明する Key Vault エラー応答。

例

DeleteCertificate

要求のサンプル

HTTP

DELETE https://myvault.vault.azure.net//certificates/importCert01?api-version=7.4

応答のサンプル

状態コード:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/importCert01",
  "deletedDate": 1493938558,
  "scheduledPurgeDate": 1501714558,
  "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "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": 1493938557,
    "updated": 1493938557,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/importCert01/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": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938557,
      "updated": 1493938557
    }
  }
}

定義

名前	説明
Action	実行されるアクション。
CertificateAttributes	証明書管理属性。
CertificatePolicy	証明書の管理ポリシー。
CertificatePolicyAction	アクションの種類。
DeletedCertificateBundle	以前の ID、属性、およびそのタグ、および削除されるタイミングに関する情報で構成される削除済み証明書。
DeletionRecoveryLevel	現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーが証明書を完全に削除できます。それ以外の場合、リテンション期間の終了時に証明書を消去できるのはシステムだけです。
Error	キーコンテナーサーバーエラー。
IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
JsonWebKeyCurveName	楕円曲線の名前。有効な値については、JsonWebKeyCurveName を参照してください。
JsonWebKeyType	証明書に使用するキーペアの種類。
KeyProperties	証明書をバッキングするキーペアのプロパティ。
KeyUsageType	証明書のキーの使用方法を定義します。
KeyVaultError	キーコンテナーのエラー例外。
LifetimeAction	証明書の有効期間中に Key Vault によって実行されるアクションとそのトリガー。
SecretProperties	証明書をバッキングするキーのプロパティ。
SubjectAlternativeNames	X509 オブジェクトのサブジェクト代替名。
Trigger	アクションを実行するために満たす条件。
X509CertificateProperties	証明書の X509 コンポーネントのプロパティ。

Action

Object

実行されるアクション。

名前	型	説明
action_type	CertificatePolicyAction	アクションの種類。

CertificateAttributes

Object

証明書管理属性。

名前	型	説明
created	integer (unixtime)	UTC での作成時刻。
enabled	boolean	オブジェクトが有効かどうかを判断します。
exp	integer (unixtime)	有効期限 (UTC)。
nbf	integer (unixtime)	UTC の日付より前ではありません。
recoverableDays	integer (int32)	softDelete データ保有日数。 softDelete が有効な場合は、値は =7 >、<=90 である必要があります。それ以外の場合は 0 です。
recoveryLevel	DeletionRecoveryLevel	現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーが証明書を完全に削除できます。それ以外の場合、リテンション期間の終了時に証明書を消去できるのはシステムだけです。
updated	integer (unixtime)	UTC での最終更新時刻。

CertificatePolicy

Object

証明書の管理ポリシー。

名前	型	説明
attributes	CertificateAttributes	証明書の属性。
id	string	証明書 ID。
issuer	IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
key_props	KeyProperties	証明書をバッキングするキーのプロパティ。
lifetime_actions	LifetimeAction[]	証明書の有効期間中に Key Vault によって実行されるアクション。
secret_props	SecretProperties	証明書をバックアップするシークレットのプロパティ。
x509_props	X509CertificateProperties	証明書の X509 コンポーネントのプロパティ。

CertificatePolicyAction

列挙

アクションの種類。

値	説明
AutoRenew
EmailContacts

DeletedCertificateBundle

Object

以前の ID、属性、およびそのタグ、および削除されるタイミングに関する情報で構成される削除済み証明書。

名前	型	説明
attributes	CertificateAttributes	証明書の属性。
cer	string (byte)	x509 証明書の CER コンテンツ。
contentType	string	シークレットのコンテンツタイプ。例えば。 'application/x-pem-file' または 'application/x-pkcs12',
deletedDate	integer (unixtime)	証明書が削除された時刻 (UTC)
id	string	証明書 ID。
kid	string	キー ID。
policy	CertificatePolicy	管理ポリシー。
recoveryId	string	削除された証明書を識別して回復するために使用される回復オブジェクトの URL。
scheduledPurgeDate	integer (unixtime)	証明書の消去がスケジュールされている時刻 (UTC)
sid	string	シークレット ID。
tags	object	キーと値のペアの形式のアプリケーション固有のメタデータ
x5t	string (base64url)	証明書の拇印。

DeletionRecoveryLevel

列挙

現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーが証明書を完全に削除できます。それ以外の場合、リテンション期間の終了時に証明書を消去できるのはシステムだけです。

値	説明
CustomizedRecoverable	即時および永続的な削除を行わずに削除を復旧できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable+ProtectedSubscription	7<= SoftDeleteRetentionInDays < 90 の場合に、削除が回復可能、即時削除、完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。
CustomizedRecoverable+Purgeable	削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、消去操作が要求されていないか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。
Purgeable	削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。このレベルは、削除操作に対して使用できる保護に対応しません。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます
Recoverable	即時削除と完全削除 (消去) なしで削除が復旧可能なコンテナーの状態を示します。このレベルでは、リテンション期間 (90 日) の間、およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。システムは、90日後に完全に削除します(回復されていない場合)
Recoverable+ProtectedSubscription	コンテナーとサブスクリプションの状態を示します。この状態では、削除がリテンション期間内 (90 日以内)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことはできません。システムは、90日後に完全に削除します(回復されていない場合)
Recoverable+Purgeable	削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、リテンション期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。システムは、90日後に完全に削除します(回復されていない場合)

Error

Object

キーコンテナーサーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

IssuerParameters

Object

証明書の X509 コンポーネントの発行者のパラメーター。

名前	型	説明
cert_transparency	boolean	このポリシーで生成された証明書を証明書の透過性ログに発行する必要があるかどうかを示します。
cty	string	プロバイダーでサポートされている証明書の種類 (省略可能);例: "OV-SSL"、"EV-SSL"
name	string	参照先の発行者オブジェクトまたは予約名の名前。たとえば、'Self' や 'Unknown' などです。

JsonWebKeyCurveName

列挙

楕円曲線の名前。有効な値については、JsonWebKeyCurveName を参照してください。

値	説明
P-256
P-256K
P-384
P-521

JsonWebKeyType

列挙

証明書に使用するキーペアの種類。

値	説明
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Object

証明書をバッキングするキーペアのプロパティ。

名前	型	説明
crv	JsonWebKeyCurveName	楕円曲線の名前。有効な値については、JsonWebKeyCurveName を参照してください。
exportable	boolean	秘密キーをエクスポートできるかどうかを示します。エクスポート可能なキーの最初のバージョンを作成するときは、リリースポリシーを指定する必要があります。
key_size	integer (int32)	キーサイズ (ビット単位)。たとえば、RSA の場合は 2048、3072、4096 などです。
kty	JsonWebKeyType	証明書に使用するキーペアの種類。
reuse_key	boolean	証明書の更新時に同じキーペアが使用されるかどうかを示します。

KeyUsageType

列挙

証明書のキーの使用方法を定義します。

値	説明
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Object

キーコンテナーのエラー例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

LifetimeAction

Object

証明書の有効期間中に Key Vault によって実行されるアクションとそのトリガー。

名前	型	説明
action	Action	実行されるアクション。
trigger	Trigger	アクションを実行する条件。

SecretProperties

Object

証明書をバッキングするキーのプロパティ。

名前	型	説明
contentType	string	メディアの種類 (MIME の種類)。

SubjectAlternativeNames

Object

X509 オブジェクトのサブジェクト代替名。

名前	型	説明
dns_names	string[]	ドメイン名。
emails	string[]	電子メールアドレス。
upns	string[]	ユーザープリンシパル名。

Trigger

Object

アクションを実行するために満たす条件。

名前	型	説明
days_before_expiry	integer (int32)	更新を試みる有効期限の前の日数。値は 1 から validity_in_months に 27 を乗算する必要があります。 validity_in_monthsが 36 の場合、値は 1 から 972 (36 * 27) の間である必要があります。
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	トリガーする有効期間の割合。値は 1 から 99 の間である必要があります。

X509CertificateProperties

Object

証明書の X509 コンポーネントのプロパティ。

名前	型	説明
ekus	string[]	拡張キーの使用法。
key_usage	KeyUsageType[]	証明書のキーの使用方法を定義します。
sans	SubjectAlternativeNames	サブジェクトの別名。
subject	string	サブジェクト名。有効な X509 識別名である必要があります。
validity_months	integer (int32) minimum: 0	証明書が有効な期間 (月単位)。

次の方法で共有

Delete Certificate - Delete Certificate

URI パラメーター

応答

例

DeleteCertificate

要求のサンプル

応答のサンプル

定義

Action

CertificateAttributes

CertificatePolicy

CertificatePolicyAction

DeletedCertificateBundle

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties