Compartir a través de

Microsoft.KeyVault managedHSMs 2020-04-01-preview

  • Artículo

Definición de recursos de Bicep

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

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@2020-04-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      '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[]
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"
'Standard_B1' (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre Descripción Valor
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

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:

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": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "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[]
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"
'Standard_B1' (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre Descripción Valor
apiVersion La versión de api '2020-04-01-preview'
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"

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

Implementación en Azure 		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@2020-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"
      ]
      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[]
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"
'Standard_B1' (obligatorio)

Microsoft.KeyVault/managedHSMs

Nombre Descripción Valor
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@2020-04-01-preview"