Microsoft.KeyVault managedHSMs 2022-02-02-01-preview

Artikel
12/20/2024

Bicep-Ressourcendefinition

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

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 die folgende Bicep hinzu.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2022-02-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'
  }
}

Eigenschaftswerte

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 Bereinigung für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf "true" festlegen, wird der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der verwaltete HSM-Dienst kann eine schwer wiederhergestellte Löschung initiieren. Das Aktivieren dieser Funktionalität ist unumkehrbar.	Bool
enableSoftDelete	Eigenschaft, die angibt, 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 kann unveränderlich sein.	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.	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, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederhergestellt. Es akzeptiert Werte zwischen 7 und 90.	Int
tenantId	Die Azure Active Directory-Mandanten-ID, die für die Authentifizierung von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Schnur Zwänge: Min. Länge = 36 Maximale Länge = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Name	Beschreibung	Wert

ManagedHsmSku

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

MhsmipRule

Name	Beschreibung	Wert
Wert	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)

MhsmNetworkRuleSet

Name	Beschreibung	Wert
Umgehungsstraße	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".	"AzureServices" 'None'
defaultAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Ablehnen"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

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)

Microsoft.KeyVault/managedHSMs

Name	Beschreibung	Wert
Ort	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.	Schnur
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Eigenschaften des verwalteten HSM	ManagedHsmProperties-
Sku	SKU-Details	ManagedHsmSku-
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei	Beschreibung
Erstellen eines vom Azure Key Vault verwalteten HSM-	Diese Vorlage erstellt ein von Azure Key Vault verwaltetes HSM.

ARM-Vorlagenressourcendefinition

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

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": "2022-02-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"
  }
}

Eigenschaftswerte

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 Bereinigung für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf "true" festlegen, wird der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der verwaltete HSM-Dienst kann eine schwer wiederhergestellte Löschung initiieren. Das Aktivieren dieser Funktionalität ist unumkehrbar.	Bool
enableSoftDelete	Eigenschaft, die angibt, 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 kann unveränderlich sein.	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.	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, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederhergestellt. Es akzeptiert Werte zwischen 7 und 90.	Int
tenantId	Die Azure Active Directory-Mandanten-ID, die für die Authentifizierung von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Schnur Zwänge: Min. Länge = 36 Maximale Länge = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Name	Beschreibung	Wert

ManagedHsmSku

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

MhsmipRule

Name	Beschreibung	Wert
Wert	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)

MhsmNetworkRuleSet

Name	Beschreibung	Wert
Umgehungsstraße	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".	"AzureServices" 'None'
defaultAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Ablehnen"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

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)

Microsoft.KeyVault/managedHSMs

Name	Beschreibung	Wert
apiVersion	Die API-Version	"2022-02-01-preview"
Ort	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.	Schnur
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Eigenschaften des verwalteten HSM	ManagedHsmProperties-
Sku	SKU-Details	ManagedHsmSku-
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art	Der Ressourcentyp	"Microsoft.KeyVault/managedHSMs"

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen eines vom Azure Key Vault verwalteten HSM-	Diese Vorlage erstellt ein von Azure Key Vault verwaltetes HSM.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

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

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 Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2022-02-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"
    }
  })
}

Eigenschaftswerte

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 Bereinigung für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf "true" festlegen, wird der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der verwaltete HSM-Dienst kann eine schwer wiederhergestellte Löschung initiieren. Das Aktivieren dieser Funktionalität ist unumkehrbar.	Bool
enableSoftDelete	Eigenschaft, die angibt, 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 kann unveränderlich sein.	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.	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, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederhergestellt. Es akzeptiert Werte zwischen 7 und 90.	Int
tenantId	Die Azure Active Directory-Mandanten-ID, die für die Authentifizierung von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.	Schnur Zwänge: Min. Länge = 36 Maximale Länge = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Name	Beschreibung	Wert

ManagedHsmSku

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

MhsmipRule

Name	Beschreibung	Wert
Wert	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)

MhsmNetworkRuleSet

Name	Beschreibung	Wert
Umgehungsstraße	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".	"AzureServices" 'None'
defaultAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.	"Zulassen" "Ablehnen"
ipRules	Die Liste der IP-Adressregeln.	MhsmipRule[]
virtualNetworkRules	Die Liste der Regeln für virtuelle Netzwerke.	MhsmVirtualNetworkRule[]

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)

Microsoft.KeyVault/managedHSMs

Name	Beschreibung	Wert
Ort	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.	Schnur
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Eigenschaften des verwalteten HSM	ManagedHsmProperties-
Sku	SKU-Details	ManagedHsmSku-
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Art	Der Ressourcentyp	"Microsoft.KeyVault/managedHSMs@2022-02-01-preview"

Freigeben über

Microsoft.KeyVault managedHSMs 2022-02-02-01-preview

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

Schnellstartbeispiele

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

Feedback

Zusätzliche Ressourcen