Get Key Rotation Policy - Get Key Rotation Policy

Başvuru

Service:: Key Vault

API Version:: 7.4

Bir anahtar için ilkeyi Listeler.
GetKeyRotationPolicy işlemi, belirtilen anahtar kasasındaki belirtilen anahtar ilkesi kaynaklarını döndürür. Bu işlem anahtarlar/alma izni gerektirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
key-name	path	True	string	Belirli bir anahtar kasasındaki anahtarın adı.
vaultBaseUrl	path	True	string	Kasa adı, örneğin https://myvault.vault.azure.net.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	KeyRotationPolicy	Anahtar döndürme ilkesi.
Other Status Codes	KeyVaultError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı Key Vault.

Örnekler

GetKeyRotationPolicy

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys/key01/rotationpolicy?api-version=7.4

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/keys/key01/rotationpolicy",
  "lifetimeActions": [
    {
      "trigger": {
        "timeAfterCreate": "P90D"
      },
      "action": {
        "type": "Rotate"
      }
    },
    {
      "trigger": {
        "timeBeforeExpiry": "P30D"
      },
      "action": {
        "type": "Notify"
      }
    }
  ],
  "attributes": {
    "expiryTime": "P2Y",
    "created": 1482188947,
    "updated": 1482188948
  }
}

Tanımlar

Name	Description
ActionType	Eylemin türü. Değer büyük/küçük harfe duyarsız olarak karşılaştırılmalıdır.
Error	Anahtar kasası sunucusu hatası.
KeyRotationPolicy	Bir anahtar için yönetim ilkesi.
KeyRotationPolicyAttributes	Anahtar döndürme ilkesi öznitelikleri.
KeyVaultError	Anahtar kasası hata özel durumu.
LifetimeActions	Bir anahtarın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylem ve tetikleyicisi.
LifetimeActionsTrigger	Bir eylemin yürütülmesi için karşılanacak bir koşul.
LifetimeActionsType	Yürütülecek eylem.

ActionType

Eylemin türü. Değer büyük/küçük harfe duyarsız olarak karşılaştırılmalıdır.

Name	Tür	Description
Notify	string	Event Grid olaylarını tetikleme. Bitiş tarihinden 30 gün önce varsayılan olarak kullanılır. Yalnızca Key Vault.
Rotate	string	Anahtarı anahtar ilkesine göre döndürün.

Error

Anahtar kasası sunucusu hatası.

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

KeyRotationPolicy

Bir anahtar için yönetim ilkesi.

Name	Tür	Description
attributes	KeyRotationPolicyAttributes	Anahtar döndürme ilkesi öznitelikleri.
id	string	Anahtar ilkesi kimliği.
lifetimeActions	LifetimeActions[]	Bir anahtarın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylemler. Önizleme için lifetimeActions en fazla iki öğeye sahip olabilir: biri döndürmek için, biri bildirim için. Bildirim süresi varsayılan olarak süre dolmadan 30 gün önce olur ve yapılandırılamaz.

KeyRotationPolicyAttributes

Anahtar döndürme ilkesi öznitelikleri.

Name	Tür	Description
created	integer	Anahtar döndürme ilkesi UTC'de saat oluşturdu.
expiryTime	string	expiryTime yeni anahtar sürümüne uygulanır. En az 28 gün olmalıdır. ISO 8601 Biçiminde olacaktır. Örnekler: 90 gün: P90D, 3 ay: P3M, 48 saat: PT48H, 1 yıl ve 10 gün: P1Y10D
updated	integer	Anahtar döndürme ilkesinin son güncelleştirme saati (UTC).

KeyVaultError

Anahtar kasası hata özel durumu.

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

LifetimeActions

Bir anahtarın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylem ve tetikleyicisi.

Name	Tür	Description
action	LifetimeActionsType	Yürütülecek eylem.
trigger	LifetimeActionsTrigger	Eylemi yürütecek koşul.

LifetimeActionsTrigger

Bir eylemin yürütülmesi için karşılanacak bir koşul.

Name	Tür	Description
timeAfterCreate	string	Oluşturma işleminden sonra döndürmeye çalışılan süre. Yalnızca döndürmek için geçerlidir. ISO 8601 süre biçiminde olacaktır. Örnek: 90 gün: "P90D"
timeBeforeExpiry	string	Döndürmeyi veya bildirmeyi deneme süresi dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örnek: 90 gün: "P90D"

LifetimeActionsType

Yürütülecek eylem.

Name	Tür	Description
type	ActionType	Eylemin türü. Değer büyük/küçük harfe duyarsız olarak karşılaştırılmalıdır.