Door Microsoft.KeyVault beheerdeHSM's 2021-10-01

Artikel
12/28/2022

Bicep-resourcedefinitie

Het resourcetype beheerdeHSM's kan worden geïmplementeerd voor:

Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.KeyVault/managedHSMs-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'B'
    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'
  }
}

Eigenschapswaarden

beheerdeHSM's

Naam	Description	Waarde
naam	De resourcenaam	tekenreeks (vereist)
location	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.	tekenreeks
tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku	SKU-details	ManagedHsmSku
properties	Eigenschappen van de beheerde HSM	ManagedHsmProperties

ManagedHsmProperties

Naam	Description	Waarde
createMode	De modus maken om aan te geven of de resource wordt gemaakt of wordt hersteld vanuit een verwijderde resource.	'standaard' 'herstellen'
enablePurgeProtection	Eigenschap die aangeeft of beveiliging tegen opschonen is ingeschakeld voor deze beheerde HSM-pool. Als u deze eigenschap instelt op true, activeert u beveiliging tegen opschonen voor deze beheerde HSM-pool en de bijbehorende inhoud. Alleen de beheerde HSM-service kan een harde, onherstelbare verwijdering initiëren. De instelling is alleen effectief als voorlopig verwijderen ook is ingeschakeld. Het inschakelen van deze functionaliteit kan niet ongedaan worden gesteld.	booleaans
enableSoftDelete	Eigenschap om op te geven of de functionaliteit 'voorlopig verwijderen' is ingeschakeld voor deze beheerde HSM-pool. Als deze niet is ingesteld op een waarde (true of false) bij het maken van een nieuwe beheerde HSM-pool, wordt deze standaard ingesteld op true. Zodra deze is ingesteld op waar, kan deze niet meer worden teruggezet naar onwaar.	booleaans
initialAdminObjectIds	Matrix met initiële beheerdersobject-id's voor deze beheerde hsm-pool.	tekenreeks[]
networkAcls	Regels voor de toegankelijkheid van de sleutelkluis vanaf specifieke netwerklocaties.	MhsmNetworkRuleSet
publicNetworkAccess	Machtigingen beheren voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.	'Uitgeschakeld' Ingeschakeld
softDeleteRetentionInDays	softDelete dagen voor gegevensretentie. Het accepteert >=7 en <=90.	int
tenantId	De Tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen voor de beheerde HSM-pool.	tekenreeks

MhsmNetworkRuleSet

Naam	Description	Waarde
Rondweg	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.	'AzureServices' 'Geen'
defaultAction	De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.	'Toestaan' 'Weigeren'
ipRules	De lijst met IP-adresregels.	MhsmipRule[]
virtualNetworkRules	De lijst met regels voor virtuele netwerken.	MhsmVirtualNetworkRule[]

MhsmipRule

Naam	Description	Waarde
waarde	Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).	tekenreeks (vereist)

MhsmVirtualNetworkRule

Naam	Description	Waarde
id	Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	tekenreeks (vereist)

ManagedHsmSku

Naam	Description	Waarde
gezin	SKU-familie van de beheerde HSM-pool	'B' (vereist)
naam	SKU van de beheerde HSM-pool	'Custom_B32' 'Standard_B1' (vereist)

Snelstartsjablonen

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

Template	Beschrijving
Een door Azure Key Vault beheerde HSM maken	Met deze sjabloon maakt u een Azure Key Vault Managed HSM.

Resourcedefinitie van ARM-sjabloon

Het resourcetype beheerdeHSM's kan worden geïmplementeerd in:

Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.KeyVault/managedHSMs-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "family": "B",
    "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"
  }
}

Eigenschapswaarden

beheerdeHSM's

Naam	Description	Waarde
type	Het resourcetype	'Microsoft.KeyVault/managedHSMs'
apiVersion	De resource-API-versie	'2021-10-01'
naam	De resourcenaam	tekenreeks (vereist)
location	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.	tekenreeks
tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku	SKU-details	ManagedHsmSku
properties	Eigenschappen van de beheerde HSM	ManagedHsmProperties

ManagedHsmProperties

Naam	Description	Waarde
createMode	De maakmodus om aan te geven of de resource wordt gemaakt of wordt hersteld van een verwijderde resource.	'default' 'herstellen'
enablePurgeProtection	Eigenschap die aangeeft of beveiliging tegen opschonen is ingeschakeld voor deze beheerde HSM-pool. Als u deze eigenschap instelt op true, wordt beveiliging tegen het opschonen van deze beheerde HSM-pool en de bijbehorende inhoud geactiveerd. Alleen de beheerde HSM-service kan een harde, onherstelbare verwijdering initiëren. De instelling is alleen effectief als voorlopig verwijderen ook is ingeschakeld. Het inschakelen van deze functionaliteit kan niet ongedaan worden gemaakt.	booleaans
enableSoftDelete	Eigenschap om op te geven of de functionaliteit 'voorlopig verwijderen' is ingeschakeld voor deze beheerde HSM-pool. Als deze niet is ingesteld op een waarde (true of false) bij het maken van een nieuwe beheerde HSM-pool, wordt deze standaard ingesteld op true. Zodra deze is ingesteld op true, kan deze niet meer worden teruggezet naar false.	booleaans
initialAdminObjectIds	Matrix van initiële beheerdersobject-id's voor deze beheerde hsm-pool.	tekenreeks[]
networkAcls	Regels voor de toegankelijkheid van de sleutelkluis vanaf specifieke netwerklocaties.	MhsmNetworkRuleSet
publicNetworkAccess	Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.	'Uitgeschakeld' Ingeschakeld
softDeleteRetentionInDays	softDelete dagen voor gegevensretentie. Het accepteert >=7 en <=90.	int
tenantId	De Azure Active Directory-tenant-id die moet worden gebruikt voor het verifiëren van aanvragen voor de beheerde HSM-pool.	tekenreeks

MhsmNetworkRuleSet

Naam	Description	Waarde
Rondweg	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.	'AzureServices' 'Geen'
defaultAction	De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.	'Toestaan' 'Weigeren'
ipRules	De lijst met IP-adresregels.	MhsmipRule[]
virtualNetworkRules	De lijst met regels voor virtuele netwerken.	MhsmVirtualNetworkRule[]

MhsmipRule

Naam	Description	Waarde
waarde	Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).	tekenreeks (vereist)

MhsmVirtualNetworkRule

Naam	Description	Waarde
id	Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	tekenreeks (vereist)

ManagedHsmSku

Naam	Description	Waarde
gezin	SKU-familie van de beheerde HSM-pool	'B' (vereist)
naam	SKU van de beheerde HSM-pool	'Custom_B32' 'Standard_B1' (vereist)

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template	Beschrijving
Een door Azure Key Vault beheerde HSM maken	Met deze sjabloon wordt een Azure Key Vault Managed HSM gemaakt.

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype beheerdeHSM's kan worden geïmplementeerd voor:

Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.KeyVault/managedHSMs-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2021-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
    }
    sku = {
      family = "B"
      name = "string"
    }
  })
}

Eigenschapswaarden

beheerdeHSM's

Naam	Description	Waarde
type	Het resourcetype	"Microsoft.KeyVault/managedHSMs@2021-10-01"
naam	De resourcenaam	tekenreeks (vereist)
location	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.	tekenreeks
parent_id	Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep.	tekenreeks (vereist)
tags	Resourcetags	Woordenlijst met tagnamen en -waarden.
sku	SKU-details	ManagedHsmSku
properties	Eigenschappen van de beheerde HSM	ManagedHsmProperties

ManagedHsmProperties

Naam	Description	Waarde
createMode	De modus maken om aan te geven of de resource wordt gemaakt of wordt hersteld vanuit een verwijderde resource.	"standaard" "herstellen"
enablePurgeProtection	Eigenschap die aangeeft of beveiliging tegen opschonen is ingeschakeld voor deze beheerde HSM-pool. Als u deze eigenschap instelt op true, activeert u beveiliging tegen opschonen voor deze beheerde HSM-pool en de bijbehorende inhoud. Alleen de beheerde HSM-service kan een harde, onherstelbare verwijdering initiëren. De instelling is alleen effectief als voorlopig verwijderen ook is ingeschakeld. Het inschakelen van deze functionaliteit kan niet ongedaan worden gesteld.	booleaans
enableSoftDelete	Eigenschap om op te geven of de functionaliteit 'voorlopig verwijderen' is ingeschakeld voor deze beheerde HSM-pool. Als deze niet is ingesteld op een waarde (true of false) bij het maken van een nieuwe beheerde HSM-pool, wordt deze standaard ingesteld op true. Zodra deze is ingesteld op waar, kan deze niet meer worden teruggezet naar onwaar.	booleaans
initialAdminObjectIds	Matrix met initiële beheerdersobject-id's voor deze beheerde hsm-pool.	tekenreeks[]
networkAcls	Regels voor de toegankelijkheid van de sleutelkluis vanaf specifieke netwerklocaties.	MhsmNetworkRuleSet
publicNetworkAccess	Machtigingen beheren voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.	"Uitgeschakeld" "Ingeschakeld"
softDeleteRetentionInDays	softDelete dagen voor gegevensretentie. Het accepteert >=7 en <=90.	int
tenantId	De Tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen voor de beheerde HSM-pool.	tekenreeks

MhsmNetworkRuleSet

Naam	Description	Waarde
Rondweg	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.	"AzureServices" "Geen"
defaultAction	De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.	"Toestaan" "Weigeren"
ipRules	De lijst met IP-adresregels.	MhsmipRule[]
virtualNetworkRules	De lijst met regels voor virtuele netwerken.	MhsmVirtualNetworkRule[]

MhsmipRule

Naam	Description	Waarde
waarde	Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).	tekenreeks (vereist)

MhsmVirtualNetworkRule

Naam	Description	Waarde
id	Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	tekenreeks (vereist)

ManagedHsmSku

Naam	Description	Waarde
gezin	SKU-familie van de beheerde HSM-pool	"B" (vereist)
naam	SKU van de beheerde HSM-pool	"Custom_B32" "Standard_B1" (vereist)

Door Microsoft.KeyVault beheerdeHSM's 2021-10-01

Bicep-resourcedefinitie

Resource-indeling

Eigenschapswaarden

beheerdeHSM's

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Snelstartsjablonen

Resourcedefinitie van ARM-sjabloon

Resource-indeling

Eigenschapswaarden

beheerdeHSM's

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Snelstartsjablonen

Terraform-resourcedefinitie (AzAPI-provider)

Resource-indeling

Eigenschapswaarden

beheerdeHSM's

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Aanvullende resources

Aanvullende resources