Get Key Rotation Policy - Get Key Rotation Policy

Referencia

Service:: Key Vault

API Version:: 7.4

Listák egy kulcsra vonatkozó szabályzatot.
A GetKeyRotationPolicy művelet a megadott kulcsházirend-erőforrásokat adja vissza a megadott kulcstartóban. Ehhez a művelethez kulcsok/lekérési engedély szükséges.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
key-name	path	True	string	A kulcs neve egy adott kulcstartóban.
vaultBaseUrl	path	True	string	A tároló neve, például https://myvault.vault.azure.net.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	KeyRotationPolicy	A kulcsrotálási szabályzat.
Other Status Codes	KeyVaultError	Key Vault hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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

Definíciók

Name	Description
ActionType	A művelet típusa. Az értéket a kis- és nagybetűk érzéketlenül kell összehasonlítani.
Error	A Key Vault-kiszolgáló hibája.
KeyRotationPolicy	Kulcs felügyeleti szabályzata.
KeyRotationPolicyAttributes	A kulcsrotálási szabályzat attribútumai.
KeyVaultError	A key vault hibakivétele.
LifetimeActions	Művelet és annak eseményindítója, amelyet Key Vault hajt végre egy kulcs élettartama során.
LifetimeActionsTrigger	A művelet végrehajtásához teljesítendő feltétel.
LifetimeActionsType	A végrehajtandó művelet.

ActionType

A művelet típusa. Az értéket a kis- és nagybetűk érzéketlenül kell összehasonlítani.

Name	Típus	Description
Notify	string	Event Grid-események aktiválása. Alapértelmezés szerint 30 nappal a lejárat előtt. csak Key Vault.
Rotate	string	Forgassa el a kulcsot a kulcsszabályzat alapján.

Error

A Key Vault-kiszolgáló hibája.

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A Key Vault-kiszolgáló hibája.
message	string	A hibaüzenet.

KeyRotationPolicy

Kulcs felügyeleti szabályzata.

Name	Típus	Description
attributes	KeyRotationPolicyAttributes	A kulcsrotálási szabályzat attribútumai.
id	string	A kulcsházirend azonosítója.
lifetimeActions	LifetimeActions[]	Az Key Vault által a kulcs élettartama során végrehajtandó műveletek. Előzetes verzióban a lifetimeActions legfeljebb két elemet tartalmazhat: egyet forgatásra, egyet értesítésre. Az értesítési idő alapértelmezés szerint 30 nappal a lejárat előtt lesz, és nem konfigurálható.

KeyRotationPolicyAttributes

A kulcsrotálási szabályzat attribútumai.

Name	Típus	Description
created	integer	A kulcsrotálási szabályzat időpontot hozott létre UTC-ben.
expiryTime	string	A expiryTime az új kulcsverzióra lesz alkalmazva. Legalább 28 napnak kell lennie. Iso 8601 formátumban lesz. Példák: 90 nap: P90D, 3 hónap: P3M, 48 óra: PT48H, 1 év és 10 nap: P1Y10D
updated	integer	A kulcsrotálási szabályzat utolsó frissítési időpontja UTC-ben.

KeyVaultError

A key vault hibakivétele.

Name	Típus	Description
error	Error	A Key Vault-kiszolgáló hibája.

LifetimeActions

Művelet és annak eseményindítója, amelyet Key Vault hajt végre egy kulcs élettartama során.

Name	Típus	Description
action	LifetimeActionsType	A végrehajtandó művelet.
trigger	LifetimeActionsTrigger	A műveletet végrehajtó feltétel.

LifetimeActionsTrigger

A művelet végrehajtásához teljesítendő feltétel.

Name	Típus	Description
timeAfterCreate	string	A létrehozás utáni idő az elforgatás megkísérléséhez. Csak forgatásra vonatkozik. Iso 8601-es időtartam formátumban lesz. Példa: 90 nap: "P90D"
timeBeforeExpiry	string	A lejárat előtti idő a forgatási vagy értesítési kísérlethez. Iso 8601-es időtartam formátumban lesz. Példa: 90 nap: "P90D"

LifetimeActionsType

A végrehajtandó művelet.

Name	Típus	Description
type	ActionType	A művelet típusa. Az értéket a kis- és nagybetűk érzéketlenül kell összehasonlítani.

Megosztás a következőn keresztül: