Microsoft.KeyVault managedHSMs 2023-07-01

Artículo
12/21/2024

Definición de recursos de Bicep

El tipo de recurso managedHSMs se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/managedHSMs, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2023-07-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

ManagedHsmProperties

Nombre	Descripción	Valor
createMode	Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.	'default' 'recover'
enablePurgeProtection	Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado. Si se establece esta propiedad en true, se activa la protección frente a la purga de este grupo de HSM administrado y su contenido; solo el servicio HSM administrado puede iniciar una eliminación irrecuperable e irrecuperable. Habilitar esta funcionalidad es irreversible.	Bool
enableSoftDelete	Propiedad para especificar si la funcionalidad de "eliminación temporal" está habilitada para este grupo de HSM administrado. La eliminación temporal está habilitada de forma predeterminada para todos los HSM administrados y es inmutable.	Bool
initialAdminObjectIds	Matriz de identificadores de objeto de administradores iniciales para este grupo de hsm administrado.	string[]
networkAcls	Reglas que rigen la accesibilidad del almacén de claves desde ubicaciones de red específicas.	MhsmNetworkRuleSet
publicNetworkAccess	Controle el permiso para el HSM administrado desde redes públicas.	'Deshabilitado' 'Habilitado'
Regiones	Lista de todas las regiones asociadas al grupo de hsm administrado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Días de retención de datos eliminados temporalmente. Al eliminar un HSM o una clave, permanecerá recuperable durante el período de retención configurado o durante un período predeterminado de 90 días. Acepta valores entre 7 y 90.	Int
tenantId	Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el grupo de HSM administrado.	cuerda Restricciones: Longitud mínima = 36 Longitud máxima = 36 Patrón = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Nombre	Descripción	Valor

ManagedHsmSku

Nombre	Descripción	Valor
familia	Familia de SKU del grupo de HSM administrado	'B' (obligatorio)
nombre	SKU del grupo de HSM administrado	"Custom_B32" "Custom_B6" 'Standard_B1' (obligatorio)

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).	'Ninguno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatorio)
userAssignedIdentities	Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nombre	Descripción	Valor
isPrimary	Valor booleano que indica si la región es la región primaria o una región secundaria.	Bool
nombre	Nombre de la región replicada geográficamente.	cuerda

MhsmipRule

Nombre	Descripción	Valor
valor	Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78).	string (obligatorio)

MhsmNetworkRuleSet

Nombre	Descripción	Valor
puentear	Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices".	"AzureServices" 'Ninguno'
defaultAction	Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.	'Permitir' 'Denegar'
ipRules	Lista de reglas de direcciones IP.	MhsmipRule []
virtualNetworkRules	Lista de reglas de red virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nombre	Descripción	Valor
identificación	Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".	string (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre	Descripción	Valor
identidad	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)	managedServiceIdentity
ubicación	Ubicación de Azure admitida en la que se debe crear el grupo de HSM administrado.	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades del HSM administrado	managedHsmProperties
Sku	Detalles de la SKU	managedHsmSku
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

UserAssignedIdentities

Nombre	Descripción	Valor

UserAssignedIdentity

Nombre	Descripción	Valor

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Creación de un de HSM administrado de Azure Key Vault	Esta plantilla crea un HSM administrado de Azure Key Vault.

Definición de recursos de plantilla de ARM

El tipo de recurso managedHSMs se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/managedHSMs, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

ManagedHsmProperties

Nombre	Descripción	Valor
createMode	Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.	'default' 'recover'
enablePurgeProtection	Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado. Si se establece esta propiedad en true, se activa la protección frente a la purga de este grupo de HSM administrado y su contenido; solo el servicio HSM administrado puede iniciar una eliminación irrecuperable e irrecuperable. Habilitar esta funcionalidad es irreversible.	Bool
enableSoftDelete	Propiedad para especificar si la funcionalidad de "eliminación temporal" está habilitada para este grupo de HSM administrado. La eliminación temporal está habilitada de forma predeterminada para todos los HSM administrados y es inmutable.	Bool
initialAdminObjectIds	Matriz de identificadores de objeto de administradores iniciales para este grupo de hsm administrado.	string[]
networkAcls	Reglas que rigen la accesibilidad del almacén de claves desde ubicaciones de red específicas.	MhsmNetworkRuleSet
publicNetworkAccess	Controle el permiso para el HSM administrado desde redes públicas.	'Deshabilitado' 'Habilitado'
Regiones	Lista de todas las regiones asociadas al grupo de hsm administrado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Días de retención de datos eliminados temporalmente. Al eliminar un HSM o una clave, permanecerá recuperable durante el período de retención configurado o durante un período predeterminado de 90 días. Acepta valores entre 7 y 90.	Int
tenantId	Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el grupo de HSM administrado.	cuerda Restricciones: Longitud mínima = 36 Longitud máxima = 36 Patrón = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Nombre	Descripción	Valor

ManagedHsmSku

Nombre	Descripción	Valor
familia	Familia de SKU del grupo de HSM administrado	'B' (obligatorio)
nombre	SKU del grupo de HSM administrado	"Custom_B32" "Custom_B6" 'Standard_B1' (obligatorio)

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).	'Ninguno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatorio)
userAssignedIdentities	Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nombre	Descripción	Valor
isPrimary	Valor booleano que indica si la región es la región primaria o una región secundaria.	Bool
nombre	Nombre de la región replicada geográficamente.	cuerda

MhsmipRule

Nombre	Descripción	Valor
valor	Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78).	string (obligatorio)

MhsmNetworkRuleSet

Nombre	Descripción	Valor
puentear	Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices".	"AzureServices" 'Ninguno'
defaultAction	Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.	'Permitir' 'Denegar'
ipRules	Lista de reglas de direcciones IP.	MhsmipRule []
virtualNetworkRules	Lista de reglas de red virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nombre	Descripción	Valor
identificación	Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".	string (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre	Descripción	Valor
apiVersion	La versión de api	'2023-07-01'
identidad	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)	managedServiceIdentity
ubicación	Ubicación de Azure admitida en la que se debe crear el grupo de HSM administrado.	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades del HSM administrado	managedHsmProperties
Sku	Detalles de la SKU	managedHsmSku
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.KeyVault/managedHSMs"

UserAssignedIdentities

Nombre	Descripción	Valor

UserAssignedIdentity

Nombre	Descripción	Valor

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Creación de un de HSM administrado de Azure Key Vault	Esta plantilla crea un HSM administrado de Azure Key Vault.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso managedHSMs se puede implementar con operaciones destinadas a:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/managedHSMs, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2023-07-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

Valores de propiedad

ManagedHsmProperties

Nombre	Descripción	Valor
createMode	Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.	'default' 'recover'
enablePurgeProtection	Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado. Si se establece esta propiedad en true, se activa la protección frente a la purga de este grupo de HSM administrado y su contenido; solo el servicio HSM administrado puede iniciar una eliminación irrecuperable e irrecuperable. Habilitar esta funcionalidad es irreversible.	Bool
enableSoftDelete	Propiedad para especificar si la funcionalidad de "eliminación temporal" está habilitada para este grupo de HSM administrado. La eliminación temporal está habilitada de forma predeterminada para todos los HSM administrados y es inmutable.	Bool
initialAdminObjectIds	Matriz de identificadores de objeto de administradores iniciales para este grupo de hsm administrado.	string[]
networkAcls	Reglas que rigen la accesibilidad del almacén de claves desde ubicaciones de red específicas.	MhsmNetworkRuleSet
publicNetworkAccess	Controle el permiso para el HSM administrado desde redes públicas.	'Deshabilitado' 'Habilitado'
Regiones	Lista de todas las regiones asociadas al grupo de hsm administrado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Días de retención de datos eliminados temporalmente. Al eliminar un HSM o una clave, permanecerá recuperable durante el período de retención configurado o durante un período predeterminado de 90 días. Acepta valores entre 7 y 90.	Int
tenantId	Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el grupo de HSM administrado.	cuerda Restricciones: Longitud mínima = 36 Longitud máxima = 36 Patrón = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

Nombre	Descripción	Valor

ManagedHsmSku

Nombre	Descripción	Valor
familia	Familia de SKU del grupo de HSM administrado	'B' (obligatorio)
nombre	SKU del grupo de HSM administrado	"Custom_B32" "Custom_B6" 'Standard_B1' (obligatorio)

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).	'Ninguno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatorio)
userAssignedIdentities	Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nombre	Descripción	Valor
isPrimary	Valor booleano que indica si la región es la región primaria o una región secundaria.	Bool
nombre	Nombre de la región replicada geográficamente.	cuerda

MhsmipRule

Nombre	Descripción	Valor
valor	Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78).	string (obligatorio)

MhsmNetworkRuleSet

Nombre	Descripción	Valor
puentear	Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices".	"AzureServices" 'Ninguno'
defaultAction	Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.	'Permitir' 'Denegar'
ipRules	Lista de reglas de direcciones IP.	MhsmipRule []
virtualNetworkRules	Lista de reglas de red virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nombre	Descripción	Valor
identificación	Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".	string (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre	Descripción	Valor
identidad	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)	managedServiceIdentity
ubicación	Ubicación de Azure admitida en la que se debe crear el grupo de HSM administrado.	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades del HSM administrado	managedHsmProperties
Sku	Detalles de la SKU	managedHsmSku
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.KeyVault/managedHSMs@2023-07-01"

UserAssignedIdentities

Nombre	Descripción	Valor

UserAssignedIdentity

Nombre	Descripción	Valor

Compartir a través de

Microsoft.KeyVault managedHSMs 2023-07-01

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Comentarios

Recursos adicionales