Get Certificate Policy - Get Certificate Policy

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Lista a política de um certificado.
A operação GetCertificatePolicy retorna os recursos de política de certificado especificados no cofre de chaves especificado. Essa operação requer a permissão de obtenção/certificados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
certificate-name	path	True	string	O nome do certificado em um determinado cofre de chaves.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo, https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	CertificatePolicy	A política de certificado.
Other Status Codes	KeyVaultError	Resposta de erro do Key Vault descrevendo por que a operação falhou.

Exemplos

GetCertificatePolicy

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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
  }
}

Definições

Nome	Description
Action	A ação que será executada.
CertificateAttributes	Os atributos de gerenciamento de certificado.
CertificatePolicy	Política de gerenciamento para um certificado.
CertificatePolicyAction	O tipo da ação.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
JsonWebKeyCurveName	Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
JsonWebKeyType	O tipo de par de chaves a ser usado para o certificado.
KeyProperties	Propriedades do par de chaves que faz backup de um certificado.
KeyUsageType	Define como a chave do certificado pode ser usada.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeAction	Ação e seu gatilho que serão executados pelo Key Vault ao longo do tempo de vida de um certificado.
SecretProperties	Propriedades da chave que faz backup de um certificado.
SubjectAlternativeNames	Os nomes alternativos de assunto de um objeto X509.
Trigger	Uma condição a ser atendida para que uma ação seja executada.
X509CertificateProperties	Propriedades do componente X509 de um certificado.

Action

Objeto

A ação que será executada.

Nome	Tipo	Description
action_type	CertificatePolicyAction	O tipo da ação.

CertificateAttributes

Objeto

Os atributos de gerenciamento de certificado.

Nome	Tipo	Description
created	integer (unixtime)	Hora de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer (unixtime)	Data de expiração em UTC.
nbf	integer (unixtime)	Não antes da data em UTC.
recoverableDays	integer (int32)	dias de retenção de dados softDelete. O valor deve ser >=7 e <=90 quando softDelete habilitado, caso contrário 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.
updated	integer (unixtime)	Hora da última atualização em UTC.

CertificatePolicy

Objeto

Política de gerenciamento para um certificado.

Nome	Tipo	Description
attributes	CertificateAttributes	Os atributos de certificado.
id	string	A ID do certificado.
issuer	IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
key_props	KeyProperties	Propriedades da chave que faz backup de um certificado.
lifetime_actions	LifetimeAction[]	Ações que serão executadas pelo Key Vault ao longo do tempo de vida de um certificado.
secret_props	SecretProperties	Propriedades do segredo que faz backup de um certificado.
x509_props	X509CertificateProperties	Propriedades do componente X509 de um certificado.

CertificatePolicyAction

Enumeração

O tipo da ação.

Valor	Description
AutoRenew
EmailContacts

DeletionRecoveryLevel

Enumeração

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.

Valor	Description
CustomizedRecoverable	Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda estiver disponível.
CustomizedRecoverable+ProtectedSubscription	Indica um cofre e um estado de assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada.
CustomizedRecoverable+Purgeable	Indica um estado de cofre no qual a exclusão é recuperável e que também permite exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada.
Purgeable	Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível de entidade ou superior (cofre, grupo de recursos, assinatura etc.)
Recoverable	Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription	Indica um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+Purgeable	Indica um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado

Error

Objeto

O erro do servidor do cofre de chaves.

Nome	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

IssuerParameters

Objeto

Parâmetros para o emissor do componente X509 de um certificado.

Nome	Tipo	Description
cert_transparency	boolean	Indica se os certificados gerados nessa política devem ser publicados nos logs de transparência do certificado.
cty	string	Tipo de certificado com suporte do provedor (opcional); por exemplo, 'OV-SSL', 'EV-SSL'
name	string	Nome do objeto emissor referenciado ou nomes reservados; por exemplo, 'Self' ou 'Unknown'.

JsonWebKeyCurveName

Enumeração

Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.

Valor	Description
P-256
P-256K
P-384
P-521

JsonWebKeyType

Enumeração

O tipo de par de chaves a ser usado para o certificado.

Valor	Description
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Objeto

Propriedades do par de chaves que faz backup de um certificado.

Nome	Tipo	Description
crv	JsonWebKeyCurveName	Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
exportable	boolean	Indica se a chave privada pode ser exportada. A política de versão deve ser fornecida ao criar a primeira versão de uma chave exportável.
key_size	integer (int32)	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.
kty	JsonWebKeyType	O tipo de par de chaves a ser usado para o certificado.
reuse_key	boolean	Indica se o mesmo par de chaves será usado na renovação do certificado.

KeyUsageType

Enumeração

Define como a chave do certificado pode ser usada.

Valor	Description
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Objeto

A exceção de erro do cofre de chaves.

Nome	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

LifetimeAction

Objeto

Ação e seu gatilho que serão executados pelo Key Vault ao longo do tempo de vida de um certificado.

Nome	Tipo	Description
action	Action	A ação que será executada.
trigger	Trigger	A condição que executará a ação.

SecretProperties

Objeto

Propriedades da chave que faz backup de um certificado.

Nome	Tipo	Description
contentType	string	O tipo de mídia (tipo MIME).

SubjectAlternativeNames

Objeto

Os nomes alternativos de assunto de um objeto X509.

Nome	Tipo	Description
dns_names	string[]	Nomes de domínio.
emails	string[]	Endereços de email.
upns	string[]	Nomes de entidade de usuário.

Trigger

Objeto

Uma condição a ser atendida para que uma ação seja executada.

Nome	Tipo	Description
days_before_expiry	integer (int32)	Dias antes da expiração para tentar a renovação. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months for 36, o valor deverá estar entre 1 e 972 (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Percentual de tempo de vida no qual disparar. O valor deve estar entre 1 e 99.

X509CertificateProperties

Objeto

Propriedades do componente X509 de um certificado.

Nome	Tipo	Description
ekus	string[]	O uso aprimorado da chave.
key_usage	KeyUsageType[]	Define como a chave do certificado pode ser usada.
sans	SubjectAlternativeNames	Os nomes alternativos do assunto.
subject	string	O nome da entidade. Deve ser um nome X509 diferenciado válido.
validity_months	integer (int32) minimum: 0	A duração em que o certificado é válido em meses.

Compartilhar via

Get Certificate Policy - Get Certificate Policy

Parâmetros de URI

Respostas

Exemplos

GetCertificatePolicy

Solicitação de exemplo

Resposta de exemplo

Definições

Action

CertificateAttributes

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties