Get Key Rotation Policy - Get Key Rotation Policy

服務:

Key Vault

API 版本:

7.4

清單 金鑰的原則。
GetKeyRotationPolicy 作業會傳回指定金鑰保存庫中的指定金鑰原則資源。 此作業需要金鑰/取得許可權。

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

URI 參數

名稱	位於	必要	類型	Description
key-name	path	True	string	指定金鑰保存庫中的金鑰名稱。
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	KeyRotationPolicy	密鑰輪替原則。
Other Status Codes	KeyVaultError	金鑰保存庫 錯誤回應，描述作業失敗的原因。

範例

GetKeyRotationPolicy

範例要求

HTTP

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

範例回覆

狀態碼:

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
  }
}

定義

名稱	Description
ActionType	動作的類型。 此值應該不區分大小寫地進行比較。
Error	金鑰儲存庫伺服器錯誤。
KeyRotationPolicy	金鑰的管理原則。
KeyRotationPolicyAttributes	密鑰輪替原則屬性。
KeyVaultError	金鑰保存庫錯誤例外狀況。
LifetimeActions	動作及其觸發程式，將在金鑰存留期內 金鑰保存庫 執行。
LifetimeActionsTrigger	要執行動作的條件。
LifetimeActionsType	將執行的動作。

ActionType

動作的類型。 此值應該不區分大小寫地進行比較。

名稱	類型	Description
Notify	string	觸發事件方格事件。 默認為到期前 30 天。 僅 金鑰保存庫。
Rotate	string	根據金鑰原則輪替金鑰。

Error

金鑰儲存庫伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	金鑰儲存庫伺服器錯誤。
message	string	錯誤訊息。

KeyRotationPolicy

金鑰的管理原則。

名稱	類型	Description
attributes	KeyRotationPolicyAttributes	密鑰輪替原則屬性。
id	string	金鑰原則識別碼。
lifetimeActions	LifetimeActions[]	金鑰保存庫 在金鑰存留期內執行的動作。 針對預覽，lifetimeActions 最多只能有兩個專案：一個用於旋轉，一個用於通知。 通知時間預設為到期前 30 天，而且無法設定。

KeyRotationPolicyAttributes

密鑰輪替原則屬性。

名稱	類型	Description
created	integer	密鑰輪替原則會以 UTC 建立時間。
expiryTime	string	expiryTime 將會套用至新的金鑰版本。 它至少應為 28 天。 其格式為 ISO 8601。 範例：90 天：P90D、3 個月：P3M、48 小時：PT48H、1 年和 10 天：P1Y10D
updated	integer	金鑰輪替原則的上次更新日期為 UTC。

KeyVaultError

金鑰保存庫錯誤例外狀況。

名稱	類型	Description
error	Error	金鑰儲存庫伺服器錯誤。

LifetimeActions

動作及其觸發程式，將在金鑰存留期內 金鑰保存庫 執行。

名稱	類型	Description
action	LifetimeActionsType	將執行的動作。
trigger	LifetimeActionsTrigger	將執行動作的條件。

LifetimeActionsTrigger

要執行動作的條件。

名稱	類型	Description
timeAfterCreate	string	建立后嘗試旋轉的時間。 它只適用於旋轉。 其格式為 ISO 8601。 範例：90 天：“P90D”
timeBeforeExpiry	string	嘗試輪替或通知到期前的時間。 其格式為 ISO 8601。 範例：90 天：“P90D”

LifetimeActionsType

將執行的動作。

名稱	類型	Description
type	ActionType	動作的類型。 此值應該不區分大小寫地進行比較。