Microsoft.KeyVault/vaults/secrets - Bicep, ARM template & Terraform AzAPI reference

Definición de recursos de Bicep

El tipo de recurso vaults/secrets se puede implementar con operaciones que tienen como destino:

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.

Observaciones

Para obtener instrucciones sobre el uso de almacenes de claves para valores seguros, consulte Administración de secretos mediante Bicep.

Para ver un inicio rápido sobre cómo crear un secreto, consulte inicio rápido : Establecimiento y recuperación de un secreto de Azure Key Vault mediante una plantilla de ARM.

Para ver un inicio rápido sobre cómo crear una clave, consulte inicio rápido : Creación de un almacén de claves de Azure y una clave mediante la plantilla de ARM.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/vaults/secrets, agregue la siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2023-07-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
}

Valores de propiedad

almacenes y secretos

Nombre	Descripción	Valor
nombre	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.	string (obligatorio) Límite de caracteres: 1-127 Caracteres válidos: Caracteres alfanuméricos y guiones.
Etiquetas	Etiquetas que se asignarán al secreto.	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
padre	En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: almacenes de
Propiedades	Propiedades del secreto	SecretProperties (obligatorio)

SecretProperties

Nombre	Descripción	Valor
Atributos	Atributos del secreto.	secretAttributes
contentType	Tipo de contenido del secreto.	cuerda
valor	Valor del secreto. NOTA: "value" nunca se devolverá desde el servicio, ya que las API que usan este modelo están pensadas para su uso interno en las implementaciones de ARM. Los usuarios deben usar el servicio REST del plano de datos para la interacción con los secretos del almacén.	cuerda

SecretAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

Plantillas de inicio rápido

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

Plantilla	Descripción
Creación de un servicio API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y lo mantiene actualizado comprobando cada 4 horas.
crea un clúster de Azure Stack HCI 23H2	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
crea un clúster de Azure Stack HCI 23H2	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM mediante una dirección IP de almacenamiento personalizada.
crea un clúster de Azure Stack HCI 23H2 en el modo de redes de vínculo dual sin conmutador	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
crea un clúster de Azure Stack HCI 23H2 en Switchless-SingleLink modo de red	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
Creación de una instancia de Azure Key Vault y un secreto	Esta plantilla crea una instancia de Azure Key Vault y un secreto.
Creación de una instancia de Azure Key Vault con RBAC y un secreto	Esta plantilla crea una instancia de Azure Key Vault y un secreto. En lugar de depender de las directivas de acceso, aprovecha Azure RBAC para administrar la autorización en secretos.
Conectarse a un almacén de claves a través de un punto de conexión privado	En este ejemplo se muestra cómo usar la configuración de una red virtual y una zona DNS privada para acceder a Key Vault a través de un punto de conexión privado.
Crear un almacén de claves y una lista de secretos	Esta plantilla crea una instancia de Key Vault y una lista de secretos dentro del almacén de claves tal como se pasa junto con los parámetros.
Creación de un token de SAS de Azure Maps almacenado en una de Azure Key Vault	Esta plantilla implementa y cuenta de Azure Maps y enumera un token de Sas basado en la identidad asignada por el usuario proporcionada que se va a almacenar en un secreto de Azure Key Vault.
Creación de una instancia de Application Gateway V2 con Key Vault	Esta plantilla implementa una instancia de Application Gateway V2 en una red virtual, una identidad definida por el usuario, Key Vault, un secreto (datos de certificado) y una directiva de acceso en Key Vault y Application Gateway.
entorno de pruebas de para Azure Firewall Premium	Esta plantilla crea una directiva de Firewall Premium y firewall de Azure Firewall con características premium, como detección de inspección de intrusiones (IDPS), inspección de TLS y filtrado de categoría web
Creación de claves SSH y almacenamiento en KeyVault	Esta plantilla usa el recurso deploymentScript para generar claves ssh y almacena la clave privada en keyVault.
aplicación de funciones de Azure y una función desencadenada por HTTP	En este ejemplo se implementa una aplicación de funciones de Azure y una función desencadenada por HTTP insertada en la plantilla. También implementa un almacén de claves y rellena un secreto con la clave de host de la aplicación de funciones.
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.

Definición de recursos de plantilla de ARM

El tipo de recurso vaults/secrets se puede implementar con operaciones que tienen como destino:

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.

Observaciones

Para obtener instrucciones sobre el uso de almacenes de claves para valores seguros, consulte Administración de secretos mediante Bicep.

Para ver un inicio rápido sobre cómo crear un secreto, consulte inicio rápido : Establecimiento y recuperación de un secreto de Azure Key Vault mediante una plantilla de ARM.

Para ver un inicio rápido sobre cómo crear una clave, consulte inicio rápido : Creación de un almacén de claves de Azure y una clave mediante la plantilla de ARM.

Formato de recurso

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

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2023-07-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  }
}

Valores de propiedad

almacenes y secretos

Nombre	Descripción	Valor
tipo	El tipo de recurso	"Microsoft.KeyVault/vaults/secrets"
apiVersion	La versión de la API de recursos	'2023-07-01'
nombre	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.	string (obligatorio) Límite de caracteres: 1-127 Caracteres válidos: Caracteres alfanuméricos y guiones.
Etiquetas	Etiquetas que se asignarán al secreto.	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
Propiedades	Propiedades del secreto	SecretProperties (obligatorio)

SecretProperties

Nombre	Descripción	Valor
Atributos	Atributos del secreto.	secretAttributes
contentType	Tipo de contenido del secreto.	cuerda
valor	Valor del secreto. NOTA: "value" nunca se devolverá desde el servicio, ya que las API que usan este modelo están pensadas para su uso interno en las implementaciones de ARM. Los usuarios deben usar el servicio REST del plano de datos para la interacción con los secretos del almacén.	cuerda

SecretAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

Plantillas de inicio rápido

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

Plantilla	Descripción
Creación de un servicio API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y lo mantiene actualizado comprobando cada 4 horas.
crea un clúster de Azure Stack HCI 23H2	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
crea un clúster de Azure Stack HCI 23H2	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM mediante una dirección IP de almacenamiento personalizada.
crea un clúster de Azure Stack HCI 23H2 en el modo de redes de vínculo dual sin conmutador	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
crea un clúster de Azure Stack HCI 23H2 en Switchless-SingleLink modo de red	Esta plantilla crea un clúster de Azure Stack HCI 23H2 mediante una plantilla de ARM.
Creación de una instancia de Azure Key Vault y un secreto	Esta plantilla crea una instancia de Azure Key Vault y un secreto.
Creación de una instancia de Azure Key Vault con RBAC y un secreto	Esta plantilla crea una instancia de Azure Key Vault y un secreto. En lugar de depender de las directivas de acceso, aprovecha Azure RBAC para administrar la autorización en secretos.
Conectarse a un almacén de claves a través de un punto de conexión privado	En este ejemplo se muestra cómo usar la configuración de una red virtual y una zona DNS privada para acceder a Key Vault a través de un punto de conexión privado.
Crear un almacén de claves y una lista de secretos	Esta plantilla crea una instancia de Key Vault y una lista de secretos dentro del almacén de claves tal como se pasa junto con los parámetros.
Creación de un token de SAS de Azure Maps almacenado en una de Azure Key Vault	Esta plantilla implementa y cuenta de Azure Maps y enumera un token de Sas basado en la identidad asignada por el usuario proporcionada que se va a almacenar en un secreto de Azure Key Vault.
Creación de una instancia de Application Gateway V2 con Key Vault	Esta plantilla implementa una instancia de Application Gateway V2 en una red virtual, una identidad definida por el usuario, Key Vault, un secreto (datos de certificado) y una directiva de acceso en Key Vault y Application Gateway.
entorno de pruebas de para Azure Firewall Premium	Esta plantilla crea una directiva de Firewall Premium y firewall de Azure Firewall con características premium, como detección de inspección de intrusiones (IDPS), inspección de TLS y filtrado de categoría web
Creación de claves SSH y almacenamiento en KeyVault	Esta plantilla usa el recurso deploymentScript para generar claves ssh y almacena la clave privada en keyVault.
aplicación de funciones de Azure y una función desencadenada por HTTP	En este ejemplo se implementa una aplicación de funciones de Azure y una función desencadenada por HTTP insertada en la plantilla. También implementa un almacén de claves y rellena un secreto con la clave de host de la aplicación de funciones.
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso vaults/secrets se puede implementar con operaciones que tienen como destino:

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/vaults/secrets, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/secrets@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      contentType = "string"
      value = "string"
    }
  })
}

Valores de propiedad

almacenes y secretos

Nombre	Descripción	Valor
tipo	El tipo de recurso	"Microsoft.KeyVault/vaults/secrets@2023-07-01"
nombre	El nombre del recurso	string (obligatorio) Límite de caracteres: 1-127 Caracteres válidos: Caracteres alfanuméricos y guiones.
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: almacenes de
Etiquetas	Etiquetas que se asignarán al secreto.	Diccionario de nombres y valores de etiqueta.
Propiedades	Propiedades del secreto	SecretProperties (obligatorio)

SecretProperties

Nombre	Descripción	Valor
Atributos	Atributos del secreto.	secretAttributes
contentType	Tipo de contenido del secreto.	cuerda
valor	Valor del secreto. NOTA: "value" nunca se devolverá desde el servicio, ya que las API que usan este modelo están pensadas para su uso interno en las implementaciones de ARM. Los usuarios deben usar el servicio REST del plano de datos para la interacción con los secretos del almacén.	cuerda

SecretAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

Compartir a través de

Almacenes o secretos de Microsoft.KeyVault

Definición de recursos de Bicep

Observaciones

Formato de recurso

Valores de propiedad

almacenes y secretos

SecretProperties

SecretAttributes

Plantillas de inicio rápido

Definición de recursos de plantilla de ARM

Observaciones

Formato de recurso

Valores de propiedad

almacenes y secretos

SecretProperties

SecretAttributes

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

almacenes y secretos

SecretProperties

SecretAttributes

Comentarios

Recursos adicionales