Partilhar via


Get Secret Versions - Get Secret Versions

Listar todas as versões do segredo especificado.
O identificador de segredo completo e os atributos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

GET {vaultBaseUrl}/secrets/{secret-name}/versions?api-version=7.4
GET {vaultBaseUrl}/secrets/{secret-name}/versions?maxresults={maxresults}&api-version=7.4

Parâmetros do URI

Name Em Necessário Tipo Description
secret-name
path True

string

O nome do segredo.

vaultBaseUrl
path True

string

O nome do cofre, por exemplo https://myvault.vault.azure.net.

api-version
query True

string

Versão da API de Cliente.

maxresults
query

integer

int32

Número máximo de resultados a devolver numa página. Se não for especificado, o serviço devolverá até 25 resultados.

Respostas

Name Tipo Description
200 OK

SecretListResult

Uma mensagem de resposta que contém uma lista de segredos juntamente com uma ligação para a página seguinte de segredos.

Other Status Codes

KeyVaultError

Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

GetSecretVersions

Sample Request

GET https://myvault.vault.azure.net//secrets/listsecretversionstest/versions?maxresults=1&api-version=7.4

Sample Response

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a",
      "attributes": {
        "enabled": true,
        "created": 1481851699,
        "updated": 1481851699
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definições

Name Description
DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.

Error

O erro do servidor do cofre de chaves.

KeyVaultError

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

SecretAttributes

Os atributos de gestão de segredos.

SecretItem

O item secreto que contém metadados secretos.

SecretListResult

O resultado da lista de segredos.

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.

Name Tipo Description
CustomizedRecoverable

string

Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível.

CustomizedRecoverable+ProtectedSubscription

string

Indica um cofre e estado de subscrição no qual a eliminação é recuperável, imediata e permanente (ou seja, remoção) não é permitida e em que a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder ser cancelada.

CustomizedRecoverable+Purgeable

string

Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada.

Purgeable

string

Indica um estado do cofre em que a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível não corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são irremediavelmente perdidos ao aceitar uma operação Delete ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.)

Recoverable

string

Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado

Recoverable+ProtectedSubscription

string

Indica um estado do cofre e da subscrição em que a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado

Recoverable+Purgeable

string

Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado

Error

O erro do servidor do cofre de chaves.

Name 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.

KeyVaultError

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

Name Tipo Description
error

Error

O erro do servidor do cofre de chaves.

SecretAttributes

Os atributos de gestão de segredos.

Name Tipo Description
created

integer

Tempo de criação em UTC.

enabled

boolean

Determina se o objeto está ativado.

exp

integer

Data de expiração em UTC.

nbf

integer

Não antes da data em UTC.

recoverableDays

integer

softDelete data retention days. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário 0.

recoveryLevel

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.

updated

integer

Hora da última atualização em UTC.

SecretItem

O item secreto que contém metadados secretos.

Name Tipo Description
attributes

SecretAttributes

Os atributos de gestão de segredos.

contentType

string

Tipo do valor do segredo, como uma palavra-passe.

id

string

Identificador secreto.

managed

boolean

Verdadeiro se a duração do segredo for gerida pelo cofre de chaves. Se esta for uma chave que suporta um certificado, a gestão será verdadeira.

tags

object

Metadados específicos da aplicação na forma de pares chave-valor.

SecretListResult

O resultado da lista de segredos.

Name Tipo Description
nextLink

string

O URL para obter o próximo conjunto de segredos.

value

SecretItem[]

Uma mensagem de resposta que contém uma lista de segredos no cofre de chaves juntamente com uma ligação para a página seguinte de segredos.