Compartir a través de

Implementaciones de Microsoft.Resources 2024-03-01

  • Artículo

Observaciones

Para Bicep, considere usar módulos en lugar de este tipo de recurso.

Definición de recursos de Bicep

El tipo de recurso deployments 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.Resources/deployments, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Resources/deployments@2024-03-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

DebugSetting

Nombre Descripción Valor
detailLevel Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos no son ninguno, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado no es ninguno. Al establecer este valor, considere cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o respuesta, podría exponer datos confidenciales que se recuperan a través de las operaciones de implementación. cuerda

DeploymentParameter

Nombre Descripción Valor
referencia Referencia de parámetros de Azure Key Vault. keyVaultParameterReference
valor Valor de entrada para el parámetro . cualquier

DeploymentPropertiesOrDeploymentPropertiesExtended

Nombre Descripción Valor
debugSetting Configuración de depuración de la implementación. debugSetting
expressionEvaluationOptions Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo. expressionEvaluationOptions
modo Modo que se usa para implementar recursos. Este valor puede ser Incremental o Completado. En modo incremental, los recursos se implementan sin eliminar los recursos existentes que no se incluyen en la plantilla. En modo completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no se incluyen en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos. "Completado"
'Incremental' (obligatorio)
onErrorDeployment Implementación en el comportamiento del error. OnErrorDeploymentOrOnErrorDeploymentExtended
Parámetros Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Este elemento se usa cuando desea proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada. DeploymentPropertiesParameters
parametersLink Identificador URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. ParametersLink
plantilla El contenido de la plantilla. Este elemento se usa cuando desea pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincular a una plantilla existente. Puede ser una cadena JSON con formato correcto o JObject. Use la propiedad templateLink o la propiedad template, pero no ambas. cualquier
templateLink Identificador URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas. TemplateLink

DeploymentPropertiesParameters

Nombre Descripción Valor

DeploymentTags

Nombre Descripción Valor

ExpressionEvaluationOptions

Nombre Descripción Valor
alcance Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada. 'Interno'
'NotSpecified'
'Exterior'

KeyVaultParameterReference

Nombre Descripción Valor
keyVault Referencia de Azure Key Vault. KeyVaultReference (obligatorio)
secretName Nombre del secreto de Azure Key Vault. string (obligatorio)
secretVersion Versión secreta de Azure Key Vault. cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso de Azure Key Vault. string (obligatorio)

Microsoft.Resources/deployments

Nombre Descripción Valor
ubicación Ubicación para almacenar los datos de implementación. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[-\w\._\(\)]+$ (obligatorio)
Propiedades Las propiedades de implementación. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatorio)
alcance Use al crear un recurso en un ámbito diferente del ámbito de implementación. Establezca esta propiedad en el nombre simbólico de un recurso para aplicar el recurso de extensión .
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

OnErrorDeploymentOrOnErrorDeploymentExtended

Nombre Descripción Valor
deploymentName Implementación que se va a usar en caso de error. cuerda
tipo La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment. 'LastSuccessful'
"SpecificDeployment"
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
Uri Identificador URI del archivo de parámetros. string (obligatorio)
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
identificación Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas. cuerda
queryString Cadena de consulta (por ejemplo, un token de SAS) que se va a usar con el URI templateLink. cuerda
relativePath La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, esto hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado con un URI, la implementación secundaria será una combinación de los URI primarios y relativePath. cuerda
Uri Identificador URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas. cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso deployments 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.Resources/deployments, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

DebugSetting

Nombre Descripción Valor
detailLevel Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos no son ninguno, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado no es ninguno. Al establecer este valor, considere cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o respuesta, podría exponer datos confidenciales que se recuperan a través de las operaciones de implementación. cuerda

DeploymentParameter

Nombre Descripción Valor
referencia Referencia de parámetros de Azure Key Vault. keyVaultParameterReference
valor Valor de entrada para el parámetro . cualquier

DeploymentPropertiesOrDeploymentPropertiesExtended

Nombre Descripción Valor
debugSetting Configuración de depuración de la implementación. debugSetting
expressionEvaluationOptions Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo. expressionEvaluationOptions
modo Modo que se usa para implementar recursos. Este valor puede ser Incremental o Completado. En modo incremental, los recursos se implementan sin eliminar los recursos existentes que no se incluyen en la plantilla. En modo completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no se incluyen en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos. "Completado"
'Incremental' (obligatorio)
onErrorDeployment Implementación en el comportamiento del error. OnErrorDeploymentOrOnErrorDeploymentExtended
Parámetros Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Este elemento se usa cuando desea proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada. DeploymentPropertiesParameters
parametersLink Identificador URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. ParametersLink
plantilla El contenido de la plantilla. Este elemento se usa cuando desea pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincular a una plantilla existente. Puede ser una cadena JSON con formato correcto o JObject. Use la propiedad templateLink o la propiedad template, pero no ambas. cualquier
templateLink Identificador URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas. TemplateLink

DeploymentPropertiesParameters

Nombre Descripción Valor

DeploymentTags

Nombre Descripción Valor

ExpressionEvaluationOptions

Nombre Descripción Valor
alcance Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada. 'Interno'
'NotSpecified'
'Exterior'

KeyVaultParameterReference

Nombre Descripción Valor
keyVault Referencia de Azure Key Vault. KeyVaultReference (obligatorio)
secretName Nombre del secreto de Azure Key Vault. string (obligatorio)
secretVersion Versión secreta de Azure Key Vault. cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso de Azure Key Vault. string (obligatorio)

Microsoft.Resources/deployments

Nombre Descripción Valor
apiVersion La versión de api '2024-03-01'
ubicación Ubicación para almacenar los datos de implementación. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[-\w\._\(\)]+$ (obligatorio)
Propiedades Las propiedades de implementación. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso "Microsoft.Resources/deployments"

OnErrorDeploymentOrOnErrorDeploymentExtended

Nombre Descripción Valor
deploymentName Implementación que se va a usar en caso de error. cuerda
tipo La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment. 'LastSuccessful'
"SpecificDeployment"
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
Uri Identificador URI del archivo de parámetros. string (obligatorio)
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
identificación Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas. cuerda
queryString Cadena de consulta (por ejemplo, un token de SAS) que se va a usar con el URI templateLink. cuerda
relativePath La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, esto hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado con un URI, la implementación secundaria será una combinación de los URI primarios y relativePath. cuerda
Uri Identificador URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas. cuerda

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso deployments 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.Resources/deployments, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2024-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

Valores de propiedad

DebugSetting

Nombre Descripción Valor
detailLevel Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos no son ninguno, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado no es ninguno. Al establecer este valor, considere cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o respuesta, podría exponer datos confidenciales que se recuperan a través de las operaciones de implementación. cuerda

DeploymentParameter

Nombre Descripción Valor
referencia Referencia de parámetros de Azure Key Vault. keyVaultParameterReference
valor Valor de entrada para el parámetro . cualquier

DeploymentPropertiesOrDeploymentPropertiesExtended

Nombre Descripción Valor
debugSetting Configuración de depuración de la implementación. debugSetting
expressionEvaluationOptions Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo. expressionEvaluationOptions
modo Modo que se usa para implementar recursos. Este valor puede ser Incremental o Completado. En modo incremental, los recursos se implementan sin eliminar los recursos existentes que no se incluyen en la plantilla. En modo completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no se incluyen en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos. "Completado"
'Incremental' (obligatorio)
onErrorDeployment Implementación en el comportamiento del error. OnErrorDeploymentOrOnErrorDeploymentExtended
Parámetros Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Este elemento se usa cuando desea proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada. DeploymentPropertiesParameters
parametersLink Identificador URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. ParametersLink
plantilla El contenido de la plantilla. Este elemento se usa cuando desea pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincular a una plantilla existente. Puede ser una cadena JSON con formato correcto o JObject. Use la propiedad templateLink o la propiedad template, pero no ambas. cualquier
templateLink Identificador URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas. TemplateLink

DeploymentPropertiesParameters

Nombre Descripción Valor

DeploymentTags

Nombre Descripción Valor

ExpressionEvaluationOptions

Nombre Descripción Valor
alcance Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada. 'Interno'
'NotSpecified'
'Exterior'

KeyVaultParameterReference

Nombre Descripción Valor
keyVault Referencia de Azure Key Vault. KeyVaultReference (obligatorio)
secretName Nombre del secreto de Azure Key Vault. string (obligatorio)
secretVersion Versión secreta de Azure Key Vault. cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso de Azure Key Vault. string (obligatorio)

Microsoft.Resources/deployments

Nombre Descripción Valor
ubicación Ubicación para almacenar los datos de implementación. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[-\w\._\(\)]+$ (obligatorio)
parent_id Identificador del recurso al que se va a aplicar este recurso de extensión. string (obligatorio)
Propiedades Las propiedades de implementación. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.Resources/deployments@2024-03-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Nombre Descripción Valor
deploymentName Implementación que se va a usar en caso de error. cuerda
tipo La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment. 'LastSuccessful'
"SpecificDeployment"
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
Uri Identificador URI del archivo de parámetros. string (obligatorio)
Nombre Descripción Valor
contentVersion Si se incluye, debe coincidir con ContentVersion en la plantilla. cuerda
identificación Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas. cuerda
queryString Cadena de consulta (por ejemplo, un token de SAS) que se va a usar con el URI templateLink. cuerda
relativePath La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, esto hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado con un URI, la implementación secundaria será una combinación de los URI primarios y relativePath. cuerda
Uri Identificador URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas. cuerda