Microsoft.KeyVault-kluizen/sleutels

Artikel
12/21/2024

Opmerkingen

Zie Geheimen beheren met Bicepvoor hulp bij het gebruik van sleutelkluizen voor veilige waarden.

Zie Quickstart: Een geheim instellen en ophalen uit Azure Key Vault met behulp van een ARM-sjabloonvoor een quickstart over het maken van een geheim.

Zie Quickstart: Een Azure-sleutelkluis en een sleutel maken met behulp van een ARM-sjabloonvoor een quickstart over het maken van een sleutel.

Bicep-resourcedefinitie

Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.KeyVault/kluizen/sleutels wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Actie

Naam	Beschrijving	Waarde
type	Het type actie.	'waarschuwen' 'draaien'

KeyAttributes

Naam	Beschrijving	Waarde
Ingeschakeld	Bepaalt of het object al dan niet is ingeschakeld.	Bool
Exp	Vervaldatum in seconden sinds 1970-01-01T00:00:00Z.	Int
Exporteerbaar	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd.	Bool
nbf	Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Naam	Beschrijving	Waarde

KeyProperties

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van de sleutel.	KeyAttributes-
curveName	De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Tekenreeksmatrix met een van de volgende waarden: 'ontsleutelen' 'versleutelen' 'importeren' 'release' 'teken' 'unwrapKey' 'verifiëren' 'wrapKey'
keySize	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.	Int
kty	Het type sleutel. Zie JsonWebKeyType voor geldige waarden.	"EG" 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Beleid voor sleutelrelease in reactie. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	KeyReleasePolicy-
rotationPolicy	Beleid voor sleutelrotatie als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	RotationPolicy-

KeyReleasePolicy

Naam	Beschrijving	Waarde
contentType	Inhoudstype en versie van beleid voor sleutelrelease	snaar
gegevens	Blob-codering van de beleidsregels waaronder de sleutel kan worden vrijgegeven.	snaar

KeyRotationPolicyAttributes

Naam	Beschrijving	Waarde
verlooptijd	De verlooptijd voor de nieuwe sleutelversie. Deze moet de indeling ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

LifetimeAction

Naam	Beschrijving	Waarde
actie	De actie van levensduur van sleutelrotatiebeleid.	actie-
trekker	De trigger van levensduur van sleutelrotatiebeleid.	trigger-

Microsoft.KeyVault/vaults/keys

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Patroon = `^[a-zA-Z0-9-]{1,127}$` (vereist)
ouder	In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.	Symbolische naam voor resource van het type: kluizen
Eigenschappen	De eigenschappen van de sleutel die moeten worden gemaakt.	KeyProperties- (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

RotationPolicy

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van sleutelrotatiebeleid.	KeyRotationPolicyAttributes-
lifetimeActions	De lifetimeActions voor sleutelrotatieactie.	LifetimeAction[]

Trekker

Naam	Beschrijving	Waarde
timeAfterCreate	De tijdsduur na het maken van de sleutel om de sleutel te draaien. Het is alleen van toepassing op draaien. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar
timeBeforeExpiry	De tijdsduur voordat de sleutel verloopt om te draaien of op de hoogte te stellen. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand	Beschrijving
Azure Storage-accountversleuteling met door de klant beheerde sleutel	Met deze sjabloon wordt een opslagaccount geïmplementeerd met een door de klant beheerde sleutel voor versleuteling die wordt gegenereerd en in een sleutelkluis wordt geplaatst.

Resourcedefinitie van ARM-sjabloon

Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.KeyVault/vaults/keys wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Actie

Naam	Beschrijving	Waarde
type	Het type actie.	'waarschuwen' 'draaien'

KeyAttributes

Naam	Beschrijving	Waarde
Ingeschakeld	Bepaalt of het object al dan niet is ingeschakeld.	Bool
Exp	Vervaldatum in seconden sinds 1970-01-01T00:00:00Z.	Int
Exporteerbaar	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd.	Bool
nbf	Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Naam	Beschrijving	Waarde

KeyProperties

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van de sleutel.	KeyAttributes-
curveName	De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Tekenreeksmatrix met een van de volgende waarden: 'ontsleutelen' 'versleutelen' 'importeren' 'release' 'teken' 'unwrapKey' 'verifiëren' 'wrapKey'
keySize	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.	Int
kty	Het type sleutel. Zie JsonWebKeyType voor geldige waarden.	"EG" 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Beleid voor sleutelrelease in reactie. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	KeyReleasePolicy-
rotationPolicy	Beleid voor sleutelrotatie als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	RotationPolicy-

KeyReleasePolicy

Naam	Beschrijving	Waarde
contentType	Inhoudstype en versie van beleid voor sleutelrelease	snaar
gegevens	Blob-codering van de beleidsregels waaronder de sleutel kan worden vrijgegeven.	snaar

KeyRotationPolicyAttributes

Naam	Beschrijving	Waarde
verlooptijd	De verlooptijd voor de nieuwe sleutelversie. Deze moet de indeling ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

LifetimeAction

Naam	Beschrijving	Waarde
actie	De actie van levensduur van sleutelrotatiebeleid.	actie-
trekker	De trigger van levensduur van sleutelrotatiebeleid.	trigger-

Microsoft.KeyVault/vaults/keys

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2024-04-01-preview'
naam	De resourcenaam	snaar Beperkingen: Patroon = `^[a-zA-Z0-9-]{1,127}$` (vereist)
Eigenschappen	De eigenschappen van de sleutel die moeten worden gemaakt.	KeyProperties- (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type	Het resourcetype	'Microsoft.KeyVault/vaults/keys'

RotationPolicy

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van sleutelrotatiebeleid.	KeyRotationPolicyAttributes-
lifetimeActions	De lifetimeActions voor sleutelrotatieactie.	LifetimeAction[]

Trekker

Naam	Beschrijving	Waarde
timeAfterCreate	De tijdsduur na het maken van de sleutel om de sleutel te draaien. Het is alleen van toepassing op draaien. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar
timeBeforeExpiry	De tijdsduur voordat de sleutel verloopt om te draaien of op de hoogte te stellen. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Azure Storage-accountversleuteling met door de klant beheerde sleutel	Met deze sjabloon wordt een opslagaccount geïmplementeerd met een door de klant beheerde sleutel voor versleuteling die wordt gegenereerd en in een sleutelkluis wordt geplaatst.
Een sleutel maken in Azure KeyVault	Met deze module kunt u een sleutel maken in een bestaande KeyVault.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:

resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.KeyVault/kluizen/sleutels wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2024-04-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

Eigenschapswaarden

Actie

Naam	Beschrijving	Waarde
type	Het type actie.	'waarschuwen' 'draaien'

KeyAttributes

Naam	Beschrijving	Waarde
Ingeschakeld	Bepaalt of het object al dan niet is ingeschakeld.	Bool
Exp	Vervaldatum in seconden sinds 1970-01-01T00:00:00Z.	Int
Exporteerbaar	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd.	Bool
nbf	Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Naam	Beschrijving	Waarde

KeyProperties

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van de sleutel.	KeyAttributes-
curveName	De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Tekenreeksmatrix met een van de volgende waarden: 'ontsleutelen' 'versleutelen' 'importeren' 'release' 'teken' 'unwrapKey' 'verifiëren' 'wrapKey'
keySize	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.	Int
kty	Het type sleutel. Zie JsonWebKeyType voor geldige waarden.	"EG" 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Beleid voor sleutelrelease in reactie. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	KeyReleasePolicy-
rotationPolicy	Beleid voor sleutelrotatie als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten als leeg	RotationPolicy-

KeyReleasePolicy

Naam	Beschrijving	Waarde
contentType	Inhoudstype en versie van beleid voor sleutelrelease	snaar
gegevens	Blob-codering van de beleidsregels waaronder de sleutel kan worden vrijgegeven.	snaar

KeyRotationPolicyAttributes

Naam	Beschrijving	Waarde
verlooptijd	De verlooptijd voor de nieuwe sleutelversie. Deze moet de indeling ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

LifetimeAction

Naam	Beschrijving	Waarde
actie	De actie van levensduur van sleutelrotatiebeleid.	actie-
trekker	De trigger van levensduur van sleutelrotatiebeleid.	trigger-

Microsoft.KeyVault/vaults/keys

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Patroon = `^[a-zA-Z0-9-]{1,127}$` (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: kluizen
Eigenschappen	De eigenschappen van de sleutel die moeten worden gemaakt.	KeyProperties- (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden.
type	Het resourcetype	"Microsoft.KeyVault/vaults/keys@2024-04-01-preview"

RotationPolicy

Naam	Beschrijving	Waarde
Kenmerken	De kenmerken van sleutelrotatiebeleid.	KeyRotationPolicyAttributes-
lifetimeActions	De lifetimeActions voor sleutelrotatieactie.	LifetimeAction[]

Trekker

Naam	Beschrijving	Waarde
timeAfterCreate	De tijdsduur na het maken van de sleutel om de sleutel te draaien. Het is alleen van toepassing op draaien. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar
timeBeforeExpiry	De tijdsduur voordat de sleutel verloopt om te draaien of op de hoogte te stellen. Deze heeft een ISO 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'.	snaar

Delen via

Microsoft.KeyVault-kluizen/sleutels

Opmerkingen

Bicep-resourcedefinitie

Resource-indeling

Eigenschapswaarden

Actie

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Trekker

Quickstart-voorbeelden

Resourcedefinitie van ARM-sjabloon

Resource-indeling

Eigenschapswaarden

Actie

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Trekker

Quickstart-sjablonen

Resourcedefinitie van Terraform (AzAPI-provider)

Resource-indeling

Eigenschapswaarden

Actie

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Trekker

Feedback

Aanvullende resources