Get Certificate Policy - Get Certificate Policy

服务:

Key Vault

API 版本:

7.4

列出证书的策略。
GetCertificatePolicy作返回指定密钥保管库中的指定证书策略资源。 此作需要证书/获取权限。

GET {vaultBaseUrl}/certificates/{certificate-name}/policy?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	CertificatePolicy	证书策略。
Other Status Codes	KeyVaultError	Key Vault 错误响应，描述作失败的原因。

示例

GetCertificatePolicy

示例请求

HTTP

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

示例响应

状态代码:

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": "Unknown"
  },
  "attributes": {
    "enabled": true,
    "created": 1482188947,
    "updated": 1482188947
  }
}

定义

名称	说明
Action	将执行的作。
CertificateAttributes	证书管理属性。
CertificatePolicy	证书的管理策略。
CertificatePolicyAction	作的类型。
DeletionRecoveryLevel	反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。
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	反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。
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

DeletionRecoveryLevel

枚举

反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。

值	说明
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	证书的有效期（以月为单位）。