Get Keys - Get Keys

Başvuru

Service:: Key Vault

API Version:: 7.4

Belirtilen kasadaki anahtarları listeleyin.
depolanan anahtarın ortak bölümünü içeren JSON Web Anahtarı yapıları olarak Key Vault anahtarların listesini alır. LIST işlemi tüm anahtar türleri için geçerlidir, ancak yanıtta yalnızca temel anahtar tanımlayıcısı, öznitelikler ve etiketler sağlanır. Bir anahtarın tek tek sürümleri yanıtta listelenmez. Bu işlem anahtarlar/liste izni gerektirir.

GET {vaultBaseUrl}/keys?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
vaultBaseUrl	path	True	string	Kasa adı, örneğin https://myvault.vault.azure.net.
api-version	query	True	string	İstemci API sürümü.
maxresults	query		integer int32	Sayfada döndürülecek en fazla sonuç sayısı. Belirtilmezse hizmet en fazla 25 sonuç döndürür.

Yanıtlar

Name	Tür	Description
200 OK	KeyListResult	Kasadaki anahtarların listesini ve sonraki anahtar sayfasını içeren bir yanıt iletisi.
Other Status Codes	KeyVaultError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı Key Vault.

Örnekler

GetKeys

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Tanımlar

Name	Description
DeletionRecoveryLevel	Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.
Error	Anahtar kasası sunucusu hatası.
KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
KeyItem	Anahtar meta verilerini içeren anahtar öğesi.
KeyListResult	Anahtar listesi sonucu.
KeyVaultError	Anahtar kasası hata özel durumu.

DeletionRecoveryLevel

Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.

Name	Tür	Description
CustomizedRecoverable	string	Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama süresi boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription	string	Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve 7<= SoftDeleteRetentionInDays < 90 olduğunda aboneliğin kendisinin kalıcı olarak iptal edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Bu düzey, bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediğini yansıtır.
CustomizedRecoverable+Purgeable	string	Silme işleminin kurtarılabilir olduğu ve anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder.
Purgeable	string	Kurtarma olasılığı olmadan silme işleminin geri alınamaz bir işlem olduğu kasa durumunu belirtir. Bu düzey, Silme işlemine karşı hiçbir korumanın mevcut olmadığına karşılık gelir; varlık düzeyinde veya daha yüksek bir düzeyde (kasa, kaynak grubu, abonelik vb.) silme işlemi kabul edildikten sonra veriler geri alınabilir bir şekilde kaybolur.
Recoverable	string	Silme işleminin anında ve kalıcı silme (temizleme) olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir. Bu düzey, saklama aralığı (90 gün) boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+ProtectedSubscription	string	Silme işleminin saklama aralığı (90 gün) içinde kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+Purgeable	string	Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye (temizleme) izin veren bir kasa durumunu belirtir. Bu düzey, temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler

Error

Anahtar kasası sunucusu hatası.

Name	Tür	Description
code	string	Hata kodu.
innererror	Error	Anahtar kasası sunucusu hatası.
message	string	Hata iletisi.

KeyAttributes

Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.

Name	Tür	Description
created	integer	Oluşturma saati : UTC.
enabled	boolean	Nesnenin etkinleştirilip etkinleştirilmediğini belirler.
exp	integer	Utc'de süre sonu tarihi.
exportable	boolean	Özel anahtarın dışarı aktarılıp aktarılmadığını gösterir. Dışarı aktarılabilir anahtarın ilk sürümü oluşturulurken yayın ilkesi sağlanmalıdır.
nbf	integer	UTC'deki tarihten önce değil.
recoverableDays	integer	softDelete veri saklama günleri. SoftDelete etkinleştirildiğinde değer =7 ve <=90 olmalıdır>, aksi takdirde 0 olmalıdır.
recoveryLevel	DeletionRecoveryLevel	Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.
updated	integer	Son güncelleştirme saati : UTC.

KeyItem

Anahtar meta verilerini içeren anahtar öğesi.

Name	Tür	Description
attributes	KeyAttributes	Anahtar yönetimi öznitelikleri.
kid	string	Anahtar tanımlayıcısı.
managed	boolean	Anahtarın yaşam süresi anahtar kasası tarafından yönetiliyorsa True. Bu bir sertifikayı destekleyen bir anahtarsa, yönetilen doğru olur.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

KeyListResult

Anahtar listesi sonucu.

Name	Tür	Description
nextLink	string	Sonraki anahtar kümesini almak için URL.
value	KeyItem[]	Anahtar kasasındaki anahtarların listesini ve sonraki anahtar sayfasının bağlantısını içeren yanıt iletisi.

KeyVaultError

Anahtar kasası hata özel durumu.

Name	Tür	Description
error	Error	Anahtar kasası sunucusu hatası.

Share via