Insieme di credenziali/chiavi Microsoft.KeyVault 2022-11-01
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:
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@2022-11-01' = {
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'
}
}
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 |
esportabile | Indica se la chiave privata può essere esportata. | Bool |
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' 'release' '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' |
release_policy | Criteri di rilascio chiave in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | KeyReleasePolicy |
rotationPolicy | Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | RotationPolicy |
KeyReleasePolicy
Nome | Descrizione | Valore |
---|---|---|
contentType | Tipo di contenuto e versione dei criteri di rilascio della chiave | corda |
dati | Codifica BLOB delle regole dei criteri in base alle quali è possibile rilasciare la chiave. | corda |
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. Si applica solo alla rotazione. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |
timeBeforeExpiry | Durata del tempo prima della scadenza della chiave per ruotare o notificare. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |
Esempi di avvio rapido
Gli esempi di avvio rapido seguenti distribuiscono 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:
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": "2022-11-01",
"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"
}
}
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 |
esportabile | Indica se la chiave privata può essere esportata. | Bool |
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' 'release' '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' |
release_policy | Criteri di rilascio chiave in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | KeyReleasePolicy |
rotationPolicy | Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | RotationPolicy |
KeyReleasePolicy
Nome | Descrizione | Valore |
---|---|---|
contentType | Tipo di contenuto e versione dei criteri di rilascio della chiave | corda |
dati | Codifica BLOB delle regole dei criteri in base alle quali è possibile rilasciare la chiave. | corda |
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 | '2022-11-01' |
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. Si applica solo alla rotazione. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |
timeBeforeExpiry | Durata del tempo prima della scadenza della chiave per ruotare o notificare. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Sagoma | 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. |
Creare una chiave in Azure KeyVault |
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@2022-11-01"
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"
}
}
]
}
}
})
}
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 |
esportabile | Indica se la chiave privata può essere esportata. | Bool |
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' 'release' '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' |
release_policy | Criteri di rilascio chiave in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | KeyReleasePolicy |
rotationPolicy | Criteri di rotazione delle chiavi in risposta. Verrà usato sia per l'output che per l'input. Omesso se vuoto | RotationPolicy |
KeyReleasePolicy
Nome | Descrizione | Valore |
---|---|---|
contentType | Tipo di contenuto e versione dei criteri di rilascio della chiave | corda |
dati | Codifica BLOB delle regole dei criteri in base alle quali è possibile rilasciare la chiave. | corda |
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@2022-11-01" |
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. Si applica solo alla rotazione. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |
timeBeforeExpiry | Durata del tempo prima della scadenza della chiave per ruotare o notificare. Sarà nel formato di durata ISO 8601. Ad esempio: 'P90D', 'P1Y'. | corda |