Condividi tramite

Microsoft.KeyVault managedHSMs 2021-04-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa managedHSMs 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/managedHSMs, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-04-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

ManagedHsmProperties

Nome Descrizione Valore
createMode Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata. 'default'
'recover'
enablePurgeProtection Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo pool di moduli di protezione hardware gestito. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione per questo pool di moduli di protezione hardware gestito e il relativo contenuto. Solo il servizio HSM gestito può avviare un'eliminazione irreversibile e dura. L'abilitazione di questa funzionalità è irreversibile. Bool
enableSoftDelete Proprietà per specificare se la funzionalità di eliminazione temporanea è abilitata per questo pool di moduli di protezione hardware gestito. L'eliminazione temporanea è abilitata per impostazione predefinita per tutti i moduli di protezione hardware gestiti ed è non modificabile. Bool
initialAdminObjectIds Matrice di ID oggetto administrators iniziali per questo pool di moduli di protezione hardware gestito. string[]
networkAcls Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici. MhsmNetworkRuleSet
publicNetworkAccess Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche. 'Disabilitato'
'Enabled'
softDeleteRetentionInDays Giorni di conservazione dei dati eliminati soft. Quando si elimina un modulo di protezione hardware o una chiave, rimarrà recuperabile per il periodo di conservazione configurato o per un periodo predefinito di 90 giorni. Accetta valori compresi tra 7 e 90. Int
tenantId ID tenant di Azure Active Directory che deve essere usato per autenticare le richieste al pool di moduli di protezione hardware gestito. corda

Vincoli:
Lunghezza minima = 36
Lunghezza massima = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrizione Valore

ManagedHsmSku

Nome Descrizione Valore
famiglia Famiglia di SKU del pool di moduli di protezione hardware gestito 'B' (obbligatorio)
nome SKU del pool di moduli di protezione hardware gestito 'Custom_B32'
'Custom_B6'
'Standard_B1' (obbligatorio)

MhsmipRule

Nome Descrizione Valore
valore Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78). stringa (obbligatorio)

MhsmNetworkRuleSet

Nome Descrizione Valore
circonvallazione Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices". 'AzureServices'
'Nessuno'
defaultAction Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass. 'Consenti'
'Deny'
ipRules Elenco delle regole degli indirizzi IP. MhsmipRule[]
virtualNetworkRules Elenco delle regole di rete virtuale. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrizione Valore
Id ID risorsa completo di una subnet di rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". stringa (obbligatorio)

Microsoft.KeyVault/managedHSMs

Nome Descrizione Valore
ubicazione Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà del modulo di protezione hardware gestito ManagedHsmProperties
Sku Dettagli SKU managedHsmSku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File Descrizione
Creare un modulo di protezione hardware gestito di Azure Key Vault Questo modello crea un modulo di protezione hardware gestito di Azure Key Vault.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa managedHSMs 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/managedHSMs, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

ManagedHsmProperties

Nome Descrizione Valore
createMode Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata. 'default'
'recover'
enablePurgeProtection Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo pool di moduli di protezione hardware gestito. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione per questo pool di moduli di protezione hardware gestito e il relativo contenuto. Solo il servizio HSM gestito può avviare un'eliminazione irreversibile e dura. L'abilitazione di questa funzionalità è irreversibile. Bool
enableSoftDelete Proprietà per specificare se la funzionalità di eliminazione temporanea è abilitata per questo pool di moduli di protezione hardware gestito. L'eliminazione temporanea è abilitata per impostazione predefinita per tutti i moduli di protezione hardware gestiti ed è non modificabile. Bool
initialAdminObjectIds Matrice di ID oggetto administrators iniziali per questo pool di moduli di protezione hardware gestito. string[]
networkAcls Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici. MhsmNetworkRuleSet
publicNetworkAccess Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche. 'Disabilitato'
'Enabled'
softDeleteRetentionInDays Giorni di conservazione dei dati eliminati soft. Quando si elimina un modulo di protezione hardware o una chiave, rimarrà recuperabile per il periodo di conservazione configurato o per un periodo predefinito di 90 giorni. Accetta valori compresi tra 7 e 90. Int
tenantId ID tenant di Azure Active Directory che deve essere usato per autenticare le richieste al pool di moduli di protezione hardware gestito. corda

Vincoli:
Lunghezza minima = 36
Lunghezza massima = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrizione Valore

ManagedHsmSku

Nome Descrizione Valore
famiglia Famiglia di SKU del pool di moduli di protezione hardware gestito 'B' (obbligatorio)
nome SKU del pool di moduli di protezione hardware gestito 'Custom_B32'
'Custom_B6'
'Standard_B1' (obbligatorio)

MhsmipRule

Nome Descrizione Valore
valore Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78). stringa (obbligatorio)

MhsmNetworkRuleSet

Nome Descrizione Valore
circonvallazione Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices". 'AzureServices'
'Nessuno'
defaultAction Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass. 'Consenti'
'Deny'
ipRules Elenco delle regole degli indirizzi IP. MhsmipRule[]
virtualNetworkRules Elenco delle regole di rete virtuale. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrizione Valore
Id ID risorsa completo di una subnet di rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". stringa (obbligatorio)

Microsoft.KeyVault/managedHSMs

Nome Descrizione Valore
apiVersion Versione dell'API '2021-04-01-preview'
ubicazione Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà del modulo di protezione hardware gestito ManagedHsmProperties
Sku Dettagli SKU managedHsmSku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.KeyVault/managedHSMs'

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
Creare un modulo di protezione hardware gestito di Azure Key Vault

Distribuire in Azure 		Questo modello crea un modulo di protezione hardware gestito di Azure Key Vault.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa managedHSMs 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/managedHSMs, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2021-04-01-preview"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

Valori delle proprietà

ManagedHsmProperties

Nome Descrizione Valore
createMode Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata. 'default'
'recover'
enablePurgeProtection Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo pool di moduli di protezione hardware gestito. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione per questo pool di moduli di protezione hardware gestito e il relativo contenuto. Solo il servizio HSM gestito può avviare un'eliminazione irreversibile e dura. L'abilitazione di questa funzionalità è irreversibile. Bool
enableSoftDelete Proprietà per specificare se la funzionalità di eliminazione temporanea è abilitata per questo pool di moduli di protezione hardware gestito. L'eliminazione temporanea è abilitata per impostazione predefinita per tutti i moduli di protezione hardware gestiti ed è non modificabile. Bool
initialAdminObjectIds Matrice di ID oggetto administrators iniziali per questo pool di moduli di protezione hardware gestito. string[]
networkAcls Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici. MhsmNetworkRuleSet
publicNetworkAccess Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche. 'Disabilitato'
'Enabled'
softDeleteRetentionInDays Giorni di conservazione dei dati eliminati soft. Quando si elimina un modulo di protezione hardware o una chiave, rimarrà recuperabile per il periodo di conservazione configurato o per un periodo predefinito di 90 giorni. Accetta valori compresi tra 7 e 90. Int
tenantId ID tenant di Azure Active Directory che deve essere usato per autenticare le richieste al pool di moduli di protezione hardware gestito. corda

Vincoli:
Lunghezza minima = 36
Lunghezza massima = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrizione Valore

ManagedHsmSku

Nome Descrizione Valore
famiglia Famiglia di SKU del pool di moduli di protezione hardware gestito 'B' (obbligatorio)
nome SKU del pool di moduli di protezione hardware gestito 'Custom_B32'
'Custom_B6'
'Standard_B1' (obbligatorio)

MhsmipRule

Nome Descrizione Valore
valore Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78). stringa (obbligatorio)

MhsmNetworkRuleSet

Nome Descrizione Valore
circonvallazione Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices". 'AzureServices'
'Nessuno'
defaultAction Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass. 'Consenti'
'Deny'
ipRules Elenco delle regole degli indirizzi IP. MhsmipRule[]
virtualNetworkRules Elenco delle regole di rete virtuale. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrizione Valore
Id ID risorsa completo di una subnet di rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". stringa (obbligatorio)

Microsoft.KeyVault/managedHSMs

Nome Descrizione Valore
ubicazione Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà del modulo di protezione hardware gestito ManagedHsmProperties
Sku Dettagli SKU managedHsmSku
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.KeyVault/managedHSMs@2021-04-01-preview"