Resolución de errores de plantilla no válida

  • Artículo

En este artículo se describe cómo resolver errores de plantilla no válida en archivos de Bicep y plantillas de Azure Resource Manager. El error se produce por varios motivos, como un error de sintaxis, un valor de parámetro no válido o una dependencia circular.

Síntoma

Al implementar una plantilla, recibe un error que indica:

Code=InvalidTemplate
Message=<varies>

El mensaje de error depende del tipo de error.

Causa

Este error puede tener distintos orígenes. Normalmente implican un error estructural o de sintaxis en la plantilla.

Solución 1: error de sintaxis

Si recibe un mensaje de error que indica que la plantilla no superó la validación, puede que esta tenga un problema de sintaxis.

Code=InvalidTemplate
Message=Deployment template validation failed

Pueden producirse errores de sintaxis porque las expresiones de la plantilla tienen muchos elementos. Por ejemplo, la asignación de nombres en una cuenta de almacenamiento incluye pares de comillas simples o dobles, llaves, corchetes y paréntesis. Las expresiones también contienen funciones y caracteres como signos de dólar, comas y puntos.

name: 'storage${uniqueString(resourceGroup().id)}'

Si recibe este tipo de error, examine meticulosamente la sintaxis de la expresión. Para identificar errores de plantilla, puede usar Visual Studio Code con la extensión Bicep más reciente o con la extensión Herramientas de Azure Resource Manager.

Solución 2: longitudes de segmentos incorrectas

Cuando el nombre del recurso no tiene el formato correcto, se produce otro error de plantilla no válida. Para resolver ese error, consulte Resolución de errores de no coincidencia de nombre y tipo.

Solución 3: el parámetro no es válido

Puede especificar los valores permitidos de un parámetro en una plantilla. Durante la implementación, si proporciona un valor que no es un valor permitido, recibe un mensaje de error similar al siguiente:

Code=InvalidTemplate;
Message=Deployment template validation failed: 'The provided value {parameter value}
for the template parameter {parameter name} is not valid. The parameter value is not
part of the allowed values

Compruebe la plantilla para conocer los valores permitidos del parámetro y use un valor permitido durante la implementación. Para más información, consulte los valores permitidos para Bicep o las plantillas de Resource Manager.

Solución 4: hay demasiados grupos de recursos de destino

Puede que vea este error en implementaciones anteriores porque estaba limitado a cinco grupos de recursos de destino en una sola implementación. En mayo de 2020 ese límite se ha aumentado a 800 grupos de recursos. Para más información, consulte cómo realizar la implementación en varios grupos de recursos de Bicep o plantillas de Resource Manager.

Solución 5: se detectó una dependencia circular

Este error se recibe cuando los recursos dependen unos de otros de una forma que impide que se inicie la implementación. Una combinación de interdependencias hace que dos o más recursos esperen otros recursos que también están esperando. Por ejemplo, resource1 depende de resource3 , resource2 depende de resource1 y resource3 depende de resource2. Para resolver este problema, normalmente se eliminan las dependencias innecesarias.

Bicep crea una dependencia implícita cuando un recurso usa el nombre simbólico de otro recurso. Normalmente, no necesario una dependencia explícita que use dependsOn. Para más información, consulte las dependencias de Bicep.

Para resolver una dependencia circular:

  1. En la plantilla, busque el recurso identificado en la dependencia circular.
  2. Para ese recurso, examine la propiedad dependsOn y todos los usos de las funcionesreference o resourceId para ver de qué recursos depende.
  3. Examine esos recursos para ver de qué recursos dependen. Siga las dependencias hasta que observe un recurso que dependa del recurso original.
  4. En el caso de los recursos que intervienen en la dependencia circular, examine meticulosamente todos los usos de la propiedad dependsOn para identificar las dependencias que no sean necesarias. Para solucionar problemas de la implementación, quite las dependencias circulares. En lugar de eliminar el código, puede usar comentarios para que el código no se ejecute durante la siguiente implementación. Puede usar comentarios de una sola línea (//) o comentarios de varias líneas (/* ... */) en plantillas de ARM o archivos de Bicep.
  5. Vuelva a implementar la plantilla.

La eliminación de valores de la propiedad dependsOn puede provocar que aparezcan errores al implementar la plantilla. Si recibe un error, vuelva a agregar la dependencia a la plantilla. Si usó comentarios para omitir el código de la plantilla, puede quitar los comentarios para restaurar el código.

Si con ese enfoque no se soluciona la dependencia circular, considere la posibilidad de mover parte de la lógica de implementación a recursos secundarios (por ejemplo, extensiones o valores de configuración). Configure esos recursos secundarios para que se implementen después de los recursos que intervienen en la dependencia circular. Por ejemplo, suponga que va a implementar dos máquinas virtuales pero debe establecer propiedades en cada una que hagan referencia a la otra. Puede implementarlas en el orden siguiente:

  1. vm1
  2. vm2
  3. La extensión en vm1 depende de vm1 y vm2. La extensión establece valores en vm1 que obtiene de vm2.
  4. La extensión en vm2 depende de vm1 y vm2. La extensión establece valores en vm2 que obtiene de vm1.

El mismo enfoque funciona para las aplicaciones de App Service. Considere la posibilidad de mover los valores de configuración a un recurso secundario del recurso de aplicación. Puede implementar dos aplicaciones web en el orden siguiente:

  1. webapp1
  2. webapp2
  3. La configuración de webapp1 depende de webapp1 y webapp2. Contiene la configuración de aplicación con valores de webapp2.
  4. La configuración de webapp2 depende de webapp1 y webapp2. Contiene la configuración de aplicación con valores de webapp1.

Solución 6: Validar la sintaxis de las plantillas exportadas

Después de implementar recursos en Azure, puede exportar el JSON de la plantilla de ARM y modificarlo para otras implementaciones. Debe validar la plantilla exportada para comprobar la sintaxis correcta antes de usarla para implementar recursos.

Puede exportar una plantilla desde el portal, la CLI de Azure o Azure PowerShell. Existen recomendaciones tanto si ha exportado la plantilla desde el recurso o grupo de recursos, como desde el historial de implementación.

Después de exportar una plantilla de ARM, puede descompilar la plantilla JSON en Bicep. A continuación, use los procedimientos recomendados y el linter para validar el código.

Para obtener más información, consulte los siguientes artículos: