Microsoft.KeyVault managedHSMs 2021-04-01-preview

Artikel
04/20/2024

Bicep-Ressourcendefinition

Der Ressourcentyp managedHSMs kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/managedHSMs-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-04-01-preview' = {
  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'
  }
}

Eigenschaftswerte

managedHSMs

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname	Zeichenfolge (erforderlich)
location	Der unterstützte Azure-Standort, an dem der verwaltete HSM-Pool erstellt werden soll.	Zeichenfolge
tags	Ressourcentags	Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku	SKU-Details	ManagedHsmSku
properties	Eigenschaften des verwalteten HSM	ManagedHsmProperties

ManagedHsmProperties

Name	BESCHREIBUNG	Wert
createMode	Der Erstellungsmodus, der angibt, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.	"Standard" "wiederherstellen"
enablePurgeProtection	Eigenschaft, die angibt, ob der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf true festlegen, wird der Schutz vor der Bereinigung für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der Verwaltete HSM-Dienst kann eine harte, unwiederbringliche Löschung initiieren. Die Aktivierung dieser Funktionalität kann nicht rückgängig gemacht werden.	bool
enableSoftDelete	Eigenschaft, um anzugeben, ob die Funktion "vorläufiges Löschen" für diesen verwalteten HSM-Pool aktiviert ist. Vorläufiges Löschen ist standardmäßig für alle verwalteten HSMs aktiviert und unveränderlich.	bool
initialAdminObjectIds	Array der anfänglichen Administratorobjekt-IDs für diesen verwalteten hsm-Pool.	string[]
networkAcls	Regeln für den Zugriff auf den Schlüsseltresor von bestimmten Netzwerkstandorten aus.	MhsmNetworkRuleSet
publicNetworkAccess	Steuern der Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.	"Deaktiviert" "Aktiviert"
softDeleteRetentionInDays	Vorläufig gelöschte Datenaufbewahrungstage. Wenn Sie ein HSM oder einen Schlüssel löschen, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederherstellbar. Sie akzeptiert Werte zwischen 7 und 90.	INT
tenantId	Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Zeichenfolge Einschränkungen: Min. Länge = 36 Maximale Länge = 36 Muster = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

MhsmNetworkRuleSet

Name	BESCHREIBUNG	Wert
Umgehung	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, ist der Standardwert "AzureServices".	"AzureServices" "Keine"
Defaultaction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Verweigern"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

MhsmipRule

Name	BESCHREIBUNG	Wert
value	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).	Zeichenfolge (erforderlich)

MhsmVirtualNetworkRule

Name	BESCHREIBUNG	Wert
id	Vollständige Ressourcen-ID eines VNET-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnet1".	Zeichenfolge (erforderlich)

ManagedHsmSku

Name	BESCHREIBUNG	Wert
family	SKU-Familie des verwalteten HSM-Pools	"B" (erforderlich)
name	SKU des verwalteten HSM-Pools	"Custom_B32" "Custom_B6" "Standard_B1" (erforderlich)

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen eines azure Key Vault Managed HSM	Mit dieser Vorlage wird ein azure Key Vault Managed HSM erstellt.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp managedHSMs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/managedHSMs-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2021-04-01-preview",
  "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"
  }
}

Eigenschaftswerte

managedHSMs

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.KeyVault/managedHSMs"
apiVersion	Die Ressourcen-API-Version	"2021-04-01-preview"
name	Der Ressourcenname	Zeichenfolge (erforderlich)
location	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.	Zeichenfolge
tags	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku	SKU-Details	ManagedHsmSku
properties	Eigenschaften des verwalteten HSM	ManagedHsmProperties

ManagedHsmProperties

Name	BESCHREIBUNG	Wert
createMode	Der Erstellungsmodus, um anzugeben, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.	"Standard" "Wiederherstellen"
enablePurgeProtection	Eigenschaft, die angibt, ob der Schutz vor Löschung für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf true festlegen, wird der Schutz vor der Bereinigung für diesen verwalteten HSM-Pool und seinen Inhalt aktiviert. Nur der verwaltete HSM-Dienst kann eine harte, unwiederbringliche Löschung initiieren. Die Aktivierung dieser Funktionalität ist nicht rückgängig gemacht.	bool
enableSoftDelete	Eigenschaft, um anzugeben, ob die Funktion "vorläufiges Löschen" für diesen verwalteten HSM-Pool aktiviert ist. Vorläufiges Löschen ist standardmäßig für alle verwalteten HSMs aktiviert und unveränderlich.	bool
initialAdminObjectIds	Array der anfänglichen Administratorobjekt-IDs für diesen verwalteten hsm-Pool.	string[]
networkAcls	Regeln für die Barrierefreiheit des Schlüsseltresors von bestimmten Netzwerkstandorten aus.	MhsmNetworkRuleSet
publicNetworkAccess	Steuern Sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.	"Deaktiviert" "Aktiviert"
softDeleteRetentionInDays	Vorläufig gelöschte Datenaufbewahrungstage. Wenn Sie ein HSM oder einen Schlüssel löschen, kann er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederhergestellt werden. Sie akzeptiert Werte zwischen 7 und 90.	INT
tenantId	Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Zeichenfolge Einschränkungen: Min Länge = 36 Maximale Länge = 36 Muster = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

MhsmNetworkRuleSet

Name	BESCHREIBUNG	Wert
Umgehung	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".	"AzureServices" "Keine"
Defaultaction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Verweigern"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

MhsmipRule

Name	BESCHREIBUNG	Wert
value	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).	Zeichenfolge (erforderlich)

MhsmVirtualNetworkRule

Name	BESCHREIBUNG	Wert
id	Vollständige Ressourcen-ID eines VNET-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnet1".	Zeichenfolge (erforderlich)

ManagedHsmSku

Name	BESCHREIBUNG	Wert
family	SKU-Familie des verwalteten HSM-Pools	"B" (erforderlich)
name	SKU des verwalteten HSM-Pools	"Custom_B32" "Custom_B6" "Standard_B1" (erforderlich)

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen eines azure Key Vault Managed HSM	Mit dieser Vorlage wird ein azure Key Vault Managed HSM erstellt.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp managedHSMs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/managedHSMs-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2021-04-01-preview"
  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"
    }
  })
}

Eigenschaftswerte

managedHSMs

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.KeyVault/managedHSMs@2021-04-01-preview"
name	Der Ressourcenname	Zeichenfolge (erforderlich)
location	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.	Zeichenfolge
parent_id	Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe.	Zeichenfolge (erforderlich)
tags	Ressourcentags	Wörterbuch der Tagnamen und -werte.
sku	SKU-Details	ManagedHsmSku
properties	Eigenschaften des verwalteten HSM	ManagedHsmProperties

ManagedHsmProperties

Name	BESCHREIBUNG	Wert
createMode	Der Erstellungsmodus, um anzugeben, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.	"default" "wiederherstellen"
enablePurgeProtection	Eigenschaft, die angibt, ob der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf true festlegen, wird der Schutz vor der Bereinigung für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der Verwaltete HSM-Dienst kann eine harte, unwiederbringliche Löschung initiieren. Die Aktivierung dieser Funktionalität kann nicht rückgängig gemacht werden.	bool
enableSoftDelete	Eigenschaft, um anzugeben, ob die Funktion "vorläufiges Löschen" für diesen verwalteten HSM-Pool aktiviert ist. Vorläufiges Löschen ist standardmäßig für alle verwalteten HSMs aktiviert und unveränderlich.	bool
initialAdminObjectIds	Array der anfänglichen Administratorobjekt-IDs für diesen verwalteten hsm-Pool.	string[]
networkAcls	Regeln für den Zugriff auf den Schlüsseltresor von bestimmten Netzwerkstandorten aus.	MhsmNetworkRuleSet
publicNetworkAccess	Steuern der Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.	"Deaktiviert" "Aktiviert"
softDeleteRetentionInDays	Vorläufig gelöschte Datenaufbewahrungstage. Wenn Sie ein HSM oder einen Schlüssel löschen, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederherstellbar. Sie akzeptiert Werte zwischen 7 und 90.	INT
tenantId	Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Zeichenfolge Einschränkungen: Min. Länge = 36 Maximale Länge = 36 Muster = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

MhsmNetworkRuleSet

Name	BESCHREIBUNG	Wert
Umgehung	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, ist der Standardwert "AzureServices".	"AzureServices" "None"
Defaultaction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Verweigern"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

MhsmipRule

Name	BESCHREIBUNG	Wert
value	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).	Zeichenfolge (erforderlich)

MhsmVirtualNetworkRule

Name	BESCHREIBUNG	Wert
id	Vollständige Ressourcen-ID eines VNET-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".	Zeichenfolge (erforderlich)

ManagedHsmSku

Name	BESCHREIBUNG	Wert
family	SKU-Familie des verwalteten HSM-Pools	"B" (erforderlich)
name	SKU des verwalteten HSM-Pools	"Custom_B32" "Custom_B6" "Standard_B1" (erforderlich)

Freigeben über

Microsoft.KeyVault managedHSMs 2021-04-01-preview

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

managedHSMs

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Schnellstartvorlagen

Ressourcendefinition mit einer ARM-Vorlage

Ressourcenformat

Eigenschaftswerte

managedHSMs

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Schnellstartvorlagen

Terraform (AzAPI-Anbieter) Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

managedHSMs

ManagedHsmProperties

MhsmNetworkRuleSet

MhsmipRule

MhsmVirtualNetworkRule

ManagedHsmSku

Feedback

Zusätzliche Ressourcen