Delen via

Set-AzKeyVaultKeyRotationPolicy

Module:
Az.KeyVault Module

Hiermee stelt u het beleid voor sleutelrotatie in voor de opgegeven sleutel in Key Vault.

Syntax

ByVaultName (Standaard) 

Set-AzKeyVaultKeyRotationPolicy
    [-VaultName] <String>
    [-Name] <String>
    [-ExpiresIn <String>]
    [-KeyRotationLifetimeAction <PSKeyRotationLifetimeAction[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByRotationPolicyFileViaVaultName 

Set-AzKeyVaultKeyRotationPolicy
    [-VaultName] <String>
    [-Name] <String>
    -PolicyPath <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKeyInputObject 

Set-AzKeyVaultKeyRotationPolicy
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [-ExpiresIn <String>]
    [-KeyRotationLifetimeAction <PSKeyRotationLifetimeAction[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByRotationPolicyFileViaKeyInputObject 

Set-AzKeyVaultKeyRotationPolicy
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    -PolicyPath <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKeyRotationPolicyInputObject 

Set-AzKeyVaultKeyRotationPolicy
    [-KeyRotationPolicy] <PSKeyRotationPolicy>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Voor deze cmdlet is de machtiging voor het bijwerken van de sleutel vereist. Het retourneert een sleutelrotatiebeleid voor de opgegeven sleutel.

Voorbeelden

Voorbeeld 1: Hiermee stelt u sleutelrotatiebeleid in op JSON-bestand

<#
rotation_policy.json
{
    "lifetimeActions": [
      {
        "trigger": {
          "timeAfterCreate": "P18M",
          "timeBeforeExpiry": null
        },
        "action": {
          "type": "Rotate"
        }
      },
      {
        "trigger": {
          "timeBeforeExpiry": "P30D"
        },
        "action": {
          "type": "Notify"
        }
      }
    ],
    "attributes": {
      "expiryTime": "P2Y"
    }
  }
#>
Set-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key -PolicyPath rotation_policy.json

Id              : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy
VaultName       : test-kv
KeyName         : test-keyAM +00:00
LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]}
ExpiresIn       : P2Y
CreatedOn       : 12/10/2021 3:21:51 AM +00:00
UpdatedOn       : 6/9/2022 7:43:27

Met deze opdrachten stelt u het rotatiebeleid van de sleutel test-key per JSON-bestand in.

Voorbeeld 2: Hiermee stelt u de verlooptijd van het sleutelrotatiebeleid in

Set-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key -ExpiresIn P2Y

Id              : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy
VaultName       : test-kv
KeyName         : test-keyAM +00:00
LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]}
ExpiresIn       : P2Y
CreatedOn       : 12/10/2021 3:21:51 AM +00:00
UpdatedOn       : 6/9/2022 7:43:27

Met deze opdrachten wordt de verlooptijd ingesteld op de nieuwe sleutelversie van test-key 2 jaar.

Voorbeeld 3: Stelt sleutelrotatiebeleid in via piping

Get-AzKeyVaultKey -VaultName test-kv -Name test-key | Set-AzKeyVaultKeyRotationPolicy -KeyRotationLifetimeAction @{Action = "Rotate"; TimeBeforeExpiry = "P18M"}

Id              : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy
VaultName       : test-kv
KeyName         : test-key
LifetimeActions : {[Action: Rotate, TimeAfterCreate: , TimeBeforeExpiry: P18M], [Action: Notify, TimeAfterCreate: ,
                  TimeBeforeExpiry: P30D]}
ExpiresIn       : P2Y
CreatedOn       : 12/10/2021 3:21:51 AM +00:00
UpdatedOn       : 6/9/2022 8:10:43 AM +00:00

Met deze opdrachten stelt u de duur in voordat de vervaldatum wordt uitgevoerd om te proberen te draaien test-key als 18 maanden.

Voorbeeld 4: Sleutelrotatiebeleid naar een andere sleutel kopiëren via PSKeyRotationPolicy-object

$policy = Get-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key1
$policy.KeyName = "test-key2"
$policy | Set-AzKeyVaultKeyRotationPolicy

Id              : https://test-kv.vault.azure.net/keys/test-key2/rotationpolicy
VaultName       : test-kv
KeyName         : test-key2
LifetimeActions : {[Action: Rotate, TimeAfterCreate: , TimeBeforeExpiry: P18M], [Action: Notify, TimeAfterCreate: ,
                  TimeBeforeExpiry: P30D]}
ExpiresIn       : P2Y
CreatedOn       : 6/9/2022 8:26:35 AM +00:00
UpdatedOn       : 6/9/2022 8:26:35 AM +00:00

Met deze opdrachten kopieert u het sleutelrotatiebeleid test-key1 naar de sleutel test-key2.

Parameters

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Parametereigenschappen

Type:IAzureContextContainer
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:AzContext, AzureRmContext, AzureCredential

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ExpiresIn

De vervaldatum wordt toegepast op de nieuwe sleutelversie. Het moet ten minste 28 dagen zijn. Het heeft een ISO 8601-indeling. Voorbeelden: 90 dagen: P90D, 3 maanden: P3M, 48 uur: PT48H, 1 jaar en 10 dagen: P1Y10D.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByVaultName
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
ByKeyInputObject
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

Sleutelobject

Parametereigenschappen

Type:PSKeyVaultKeyIdentityItem
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Key

Parametersets

ByKeyInputObject
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
SetByRotationPolicyFileViaKeyInputObject
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-KeyRotationLifetimeAction

PSKeyRotationLifetimeAction-object.

Parametereigenschappen

Type:

PSKeyRotationLifetimeAction[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByVaultName
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
ByKeyInputObject
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-KeyRotationPolicy

PSKeyRotationPolicy-object.

Parametereigenschappen

Type:PSKeyRotationPolicy
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByKeyRotationPolicyInputObject
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Name

Sleutelnaam.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Sleutelnaam

Parametersets

ByVaultName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
SetByRotationPolicyFileViaVaultName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PolicyPath

Een pad naar het rotatiebeleidsbestand dat JSON-beleidsdefinitie bevat.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

SetByRotationPolicyFileViaVaultName
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
SetByRotationPolicyFileViaKeyInputObject
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-VaultName

Kluisnaam.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByVaultName
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
SetByRotationPolicyFileViaVaultName
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSKeyRotationPolicy

PSKeyVaultKeyIdentityItem

Uitvoerwaarden

PSKeyRotationPolicy