Condividi tramite


Insieme di credenziali/chiavi Microsoft.KeyVault 2021-04-01-preview

Osservazioni

Per indicazioni sull'uso di insiemi di credenziali delle chiavi per i valori sicuri, vedere Gestire i segreti usando Bicep.

Per una guida introduttiva sulla creazione di un segreto, vedere Avvio rapido: Impostare e recuperare un segreto da Azure Key Vault usando un modello di Resource Manager.

Per una guida introduttiva sulla creazione di una chiave, vedere Avvio rapido: Creare un insieme di credenziali delle chiavi di Azure e una chiave usando il modello di Resource Manager.

Definizione di risorsa Bicep

Il tipo di risorsa insiemi di credenziali/chiavi può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.KeyVault/vaults/keys, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

Azione

Nome Descrizione Valore
digitare Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole. 'Notify'
'Rotate'

KeyAttributes

Nome Descrizione Valore
Abilitato Determina se l'oggetto è abilitato o meno. Bool
Exp Data di scadenza in secondi dal 1970-01-01T00:00:00Z. Int
nbf Non prima della data in secondi dal 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nome Descrizione Valore

KeyProperties

Nome Descrizione Valore
Attributi Attributi della chiave. KeyAttributes
curveName Nome della curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matrice di stringhe contenente uno dei seguenti elementi:
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Dimensione della chiave in bit. Ad esempio: 2048, 3072 o 4096 per RSA. Int
kty Tipo della chiave. Per i valori validi, vedere JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
rotationPolicy Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto RotationPolicy

KeyRotationPolicyAttributes

Nome Descrizione Valore
expiryTime Ora di scadenza per la nuova versione della chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrizione Valore
azione Azione della durata dei criteri di rotazione delle chiaviAction. 'azione
Grilletto Trigger della durata dei criteri di rotazione delle chiaviAction. trigger

Microsoft.KeyVault/vaults/keys

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-zA-Z0-9-]{1,127}$ (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: insiemi di credenziali
proprietà Proprietà della chiave da creare. KeyProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

RotationPolicy

Nome Descrizione Valore
Attributi Attributi dei criteri di rotazione delle chiavi. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions per l'azione di rotazione delle chiavi. LifetimeAction[]

Grilletto

Nome Descrizione Valore
timeAfterCreate Durata del tempo dopo la creazione della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda
timeBeforeExpiry Durata dell'ora prima della scadenza della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda

Esempi di utilizzo

Esempi di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti contengono esempi Bicep per la distribuzione di questo tipo di risorsa.

Bicep File Descrizione
crittografia dell'account di archiviazione di Azure con chiave gestita dal cliente Questo modello distribuisce un account di archiviazione con una chiave gestita dal cliente per la crittografia generata e inserita in un insieme di credenziali delle chiavi.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa insiemi di credenziali/chiavi può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.KeyVault/vaults/keys, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

Azione

Nome Descrizione Valore
digitare Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole. 'Notify'
'Rotate'

KeyAttributes

Nome Descrizione Valore
Abilitato Determina se l'oggetto è abilitato o meno. Bool
Exp Data di scadenza in secondi dal 1970-01-01T00:00:00Z. Int
nbf Non prima della data in secondi dal 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nome Descrizione Valore

KeyProperties

Nome Descrizione Valore
Attributi Attributi della chiave. KeyAttributes
curveName Nome della curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matrice di stringhe contenente uno dei seguenti elementi:
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Dimensione della chiave in bit. Ad esempio: 2048, 3072 o 4096 per RSA. Int
kty Tipo della chiave. Per i valori validi, vedere JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
rotationPolicy Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto RotationPolicy

KeyRotationPolicyAttributes

Nome Descrizione Valore
expiryTime Ora di scadenza per la nuova versione della chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrizione Valore
azione Azione della durata dei criteri di rotazione delle chiaviAction. 'azione
Grilletto Trigger della durata dei criteri di rotazione delle chiaviAction. trigger

Microsoft.KeyVault/vaults/keys

Nome Descrizione Valore
apiVersion Versione dell'API '2021-04-01-preview'
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-zA-Z0-9-]{1,127}$ (obbligatorio)
proprietà Proprietà della chiave da creare. KeyProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.KeyVault/vaults/keys'

RotationPolicy

Nome Descrizione Valore
Attributi Attributi dei criteri di rotazione delle chiavi. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions per l'azione di rotazione delle chiavi. LifetimeAction[]

Grilletto

Nome Descrizione Valore
timeAfterCreate Durata del tempo dopo la creazione della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda
timeBeforeExpiry Durata dell'ora prima della scadenza della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda

Esempi di utilizzo

Modelli di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.

Sagoma Descrizione
crittografia dell'account di archiviazione di Azure con chiave gestita dal cliente

Distribuire in Azure
Questo modello distribuisce un account di archiviazione con una chiave gestita dal cliente per la crittografia generata e inserita in un insieme di credenziali delle chiavi.
Creare una chiave in Azure KeyVault

Distribuire in Azure
Questo modulo consente di creare una chiave in un insieme di credenziali delle chiavi esistente.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa insiemi di credenziali/chiavi può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.KeyVault/vaults/keys, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

Azione

Nome Descrizione Valore
digitare Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole. 'Notify'
'Rotate'

KeyAttributes

Nome Descrizione Valore
Abilitato Determina se l'oggetto è abilitato o meno. Bool
Exp Data di scadenza in secondi dal 1970-01-01T00:00:00Z. Int
nbf Non prima della data in secondi dal 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nome Descrizione Valore

KeyProperties

Nome Descrizione Valore
Attributi Attributi della chiave. KeyAttributes
curveName Nome della curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matrice di stringhe contenente uno dei seguenti elementi:
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Dimensione della chiave in bit. Ad esempio: 2048, 3072 o 4096 per RSA. Int
kty Tipo della chiave. Per i valori validi, vedere JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
rotationPolicy Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto RotationPolicy

KeyRotationPolicyAttributes

Nome Descrizione Valore
expiryTime Ora di scadenza per la nuova versione della chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrizione Valore
azione Azione della durata dei criteri di rotazione delle chiaviAction. 'azione
Grilletto Trigger della durata dei criteri di rotazione delle chiaviAction. trigger

Microsoft.KeyVault/vaults/keys

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-zA-Z0-9-]{1,127}$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: insiemi di credenziali
proprietà Proprietà della chiave da creare. KeyProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.KeyVault/vaults/keys@2021-04-01-preview"

RotationPolicy

Nome Descrizione Valore
Attributi Attributi dei criteri di rotazione delle chiavi. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions per l'azione di rotazione delle chiavi. LifetimeAction[]

Grilletto

Nome Descrizione Valore
timeAfterCreate Durata del tempo dopo la creazione della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda
timeBeforeExpiry Durata dell'ora prima della scadenza della chiave per ruotare la chiave. Deve essere in formato ISO8601. Ad esempio: 'P90D', 'P1Y'. corda