Get Keys - Get Keys

Hizmet:: Key Vault

API Sürümü:: 2025-07-01

Belirtilen kasadaki anahtarları listeleyin.
Key Vault'taki anahtarların listesini, depolanan anahtarın ortak bölümünü içeren JSON Web Anahtarı yapıları olarak 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=2025-07-01

İsteğe bağlı parametrelerle:

GET {vaultBaseUrl}/keys?api-version=2025-07-01&maxresults={maxresults}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
maxresults	query		integer (int32) minimum: 1 maximum: 25	Bir sayfada döndürülecek maksimum sonuç sayısı. Belirtilmezse, hizmet en fazla 25 sonuç döndürür.

Yanıtlar

Name	Tür	Description
200 OK	KeyListResult	İstek başarılı oldu.
Other Status Codes	KeyVaultError	Beklenmeyen bir hata yanıtı.

Güvenlik

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
https://vault.azure.net/.default

Örnekler

GetKeys

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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 sertifikalar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa, sertifika ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; Aksi takdirde, bekletme aralığının sonunda sertifikayı yalnızca sistem temizleyebilir.
Error
KeyAttestation	Temel kanıtlama bilgileri.
KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
KeyItem	Anahtar meta verilerini içeren anahtar öğe.
KeyListResult	Anahtar listesi sonucu.
KeyVaultError	Anahtar kasası hata özel durumu.

DeletionRecoveryLevel

Listeleme

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

Değer	Description
Purgeable	Silme işleminin, kurtarma olasılığı olmadan geri döndürülemez bir işlem olduğu bir kasa durumunu belirtir. Bu düzey, bir Delete işlemine karşı koruma sağlanmamasına karşılık gelir; varlık düzeyinde veya daha yüksek bir Silme işlemi kabul edildiğinde veriler geri alınamaz bir şekilde kaybolur (kasa, kaynak grubu, abonelik vb.)
Recoverable+Purgeable	Silme işleminin kurtarılabilir olduğu ve aynı zamanda anında ve kalıcı silmeye (yani temizlemeye) izin veren bir kasa durumunu belirtir. Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmazsa 90 gün sonra kalıcı olarak silecektir
Recoverable	Silme işleminin anında ve kalıcı silme (yani 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ılmazsa 90 gün sonra kalıcı olarak silecektir
Recoverable+ProtectedSubscription	Silme işleminin saklama aralığı (90 gün) içinde kurtarılabildiği, anında ve kalıcı silmeye (yani temizlemeye) izin verilmeyen ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasa ve abonelik durumunu belirtir. Sistem, kurtarılmazsa 90 gün sonra kalıcı olarak silecektir
CustomizedRecoverable+Purgeable	Silme işleminin kurtarılabilir olduğu ve aynı zamanda anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı sırasında silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable	Silme işleminin anında ve kalıcı silme olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı sırasında ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription	Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (yani temizleme) izin verilmeyen ve 7 = SoftDeleteRetentionInDays << 90 olduğunda aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasa ve abonelik durumunu belirtir. Bu düzey, saklama aralığı sırasında silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediği gerçeğini yansıtır.

Error

Object

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

KeyAttestation

Object

Temel kanıtlama bilgileri.

Name	Tür	Description
certificatePemFile	string (base64url)	Kanıtlama doğrulaması için kullanılan, PEM biçiminde sertifikalar içeren base64url kodlu bir dize.
privateKeyAttestation	string (base64url)	Özel anahtara karşılık gelen base64url dizesi olarak kodlanmış kanıtlama blobu baytları.
publicKeyAttestation	string (base64url)	Asimetrik anahtar durumunda ortak anahtara karşılık gelen base64url dizesi olarak kodlanmış kanıtlama blobu baytları.
version	string	Tasdik sürümü.

KeyAttributes

Object

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

Name	Tür	Description
attestation	KeyAttestation	Anahtar veya anahtar sürümü kanıtlama bilgileri.
created	integer (unixtime)	UTC'de oluşturma zamanı.
enabled	boolean	Nesnenin etkinleştirilip etkinleştirilmediğini belirler.
exp	integer (unixtime)	UTC'de son kullanma tarihi.
exportable	boolean	Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir. Dışarı aktarılabilir bir anahtarın ilk sürümü oluşturulurken yayın ilkesi sağlanmalıdır.
hsmPlatform	string	Temel HSM Platformu.
nbf	integer (unixtime)	UTC'deki tarihten önce değil.
recoverableDays	integer (int32)	softDelete veri saklama günleri. SoftDelete etkinleştirildiğinde değer =7 ve >=90, 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, bekletme aralığının sonunda anahtarı yalnızca sistem temizleyebilir.
updated	integer (unixtime)	UTC'de son güncelleme zamanı.

KeyItem

Object

Anahtar meta verilerini içeren anahtar öğe.

Name	Tür	Description
attributes	KeyAttributes	Anahtar yönetim öznitelikleri.
kid	string	Anahtar tanımlayıcısı.
managed	boolean	Anahtarın ömrü anahtar kasası tarafından yönetiliyorsa True değerini belirler. Bu, sertifikayı destekleyen bir anahtarsa, yönetilen doğru olacaktır.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özel meta veriler.

KeyListResult

Object

Anahtar listesi sonucu.

Name	Tür	Description
nextLink	string	Bir 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 bir yanıt iletisi.

KeyVaultError

Object

Anahtar kasası hata özel durumu.

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