Compartilhar via

Implantações do Microsoft.Resources 2024-03-01

  • Artigo

Observações

Para o Bicep, considere usando módulos em vez desse tipo de recurso.

Definição de recurso do Bicep

O tipo de recurso de implantações pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Resources/deployments, adicione o Bicep a seguir ao seu modelo.

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 propriedade

DebugSetting

Nome Descrição Valor
detailLevel Especifica o tipo de informação a ser registrada em log para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais recuperados por meio das operações de implantação. corda

DeploymentParameter

Nome Descrição Valor
referência Referência de parâmetro do Azure Key Vault. KeyVaultParameterReference
valor Valor de entrada para o parâmetro. qualquer

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrição Valor
debugSetting A configuração de depuração da implantação. DebugSetting
expressionEvaluationOptions Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será externo. ExpressionEvaluationOptions
modo O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer. 'Complete'
'Incremental' (obrigatório)
onErrorDeployment A implantação no comportamento de erro. OnErrorDeploymentOrOnErrorDeploymentExtended
Parâmetros Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. DeploymentPropertiesParameters
parametersLink O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. ParametersLink
modelo O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JObject ou JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. qualquer
templateLink O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. TemplateLink

DeploymentPropertiesParameters

Nome Descrição Valor

DeploymentTags

Nome Descrição Valor

ExpressionEvaluationOptions

Nome Descrição Valor
âmbito O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrição Valor
keyVault Referência do Azure Key Vault. KeyVaultReference (obrigatório)
secretName Nome do segredo do Azure Key Vault. cadeia de caracteres (obrigatório)
secretVersion Versão secreta do Azure Key Vault. corda

KeyVaultReference

Nome Descrição Valor
id ID de recurso do Azure Key Vault. cadeia de caracteres (obrigatório)

Microsoft.Resources/deployments

Nome Descrição Valor
localização O local para armazenar os dados de implantação. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[-\w\._\(\)]+$ (obrigatório)
Propriedades As propriedades de implantação. DeploymentPropertiesOrDeploymentPropertiesExtended (obrigatório)
âmbito Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrição Valor
deploymentName A implantação a ser usada no caso de erro. corda
tipo A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
URI O URI do arquivo de parâmetros. cadeia de caracteres (obrigatório)
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
id A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas. corda
queryString A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink. corda
relativePath A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai estiver vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai estiver vinculado a um URI, a implantação filho será uma combinação das URIs pai e relativePath corda
URI O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos. corda

Definição de recurso de modelo do ARM

O tipo de recurso de implantações pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Resources/deployments, adicione o JSON a seguir ao seu modelo.

{
  "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 propriedade

DebugSetting

Nome Descrição Valor
detailLevel Especifica o tipo de informação a ser registrada em log para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais recuperados por meio das operações de implantação. corda

DeploymentParameter

Nome Descrição Valor
referência Referência de parâmetro do Azure Key Vault. KeyVaultParameterReference
valor Valor de entrada para o parâmetro. qualquer

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrição Valor
debugSetting A configuração de depuração da implantação. DebugSetting
expressionEvaluationOptions Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será externo. ExpressionEvaluationOptions
modo O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer. 'Complete'
'Incremental' (obrigatório)
onErrorDeployment A implantação no comportamento de erro. OnErrorDeploymentOrOnErrorDeploymentExtended
Parâmetros Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. DeploymentPropertiesParameters
parametersLink O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. ParametersLink
modelo O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JObject ou JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. qualquer
templateLink O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. TemplateLink

DeploymentPropertiesParameters

Nome Descrição Valor

DeploymentTags

Nome Descrição Valor

ExpressionEvaluationOptions

Nome Descrição Valor
âmbito O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrição Valor
keyVault Referência do Azure Key Vault. KeyVaultReference (obrigatório)
secretName Nome do segredo do Azure Key Vault. cadeia de caracteres (obrigatório)
secretVersion Versão secreta do Azure Key Vault. corda

KeyVaultReference

Nome Descrição Valor
id ID de recurso do Azure Key Vault. cadeia de caracteres (obrigatório)

Microsoft.Resources/deployments

Nome Descrição Valor
apiVersion A versão da API '2024-03-01'
localização O local para armazenar os dados de implantação. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[-\w\._\(\)]+$ (obrigatório)
Propriedades As propriedades de implantação. DeploymentPropertiesOrDeploymentPropertiesExtended (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Resources/deployments'

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrição Valor
deploymentName A implantação a ser usada no caso de erro. corda
tipo A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
URI O URI do arquivo de parâmetros. cadeia de caracteres (obrigatório)
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
id A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas. corda
queryString A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink. corda
relativePath A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai estiver vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai estiver vinculado a um URI, a implantação filho será uma combinação das URIs pai e relativePath corda
URI O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos. corda

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de implantações pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Resources/deployments, adicione o Terraform a seguir ao seu modelo.

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 propriedade

DebugSetting

Nome Descrição Valor
detailLevel Especifica o tipo de informação a ser registrada em log para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais recuperados por meio das operações de implantação. corda

DeploymentParameter

Nome Descrição Valor
referência Referência de parâmetro do Azure Key Vault. KeyVaultParameterReference
valor Valor de entrada para o parâmetro. qualquer

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrição Valor
debugSetting A configuração de depuração da implantação. DebugSetting
expressionEvaluationOptions Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será externo. ExpressionEvaluationOptions
modo O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer. 'Complete'
'Incremental' (obrigatório)
onErrorDeployment A implantação no comportamento de erro. OnErrorDeploymentOrOnErrorDeploymentExtended
Parâmetros Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. DeploymentPropertiesParameters
parametersLink O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. ParametersLink
modelo O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JObject ou JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. qualquer
templateLink O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. TemplateLink

DeploymentPropertiesParameters

Nome Descrição Valor

DeploymentTags

Nome Descrição Valor

ExpressionEvaluationOptions

Nome Descrição Valor
âmbito O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrição Valor
keyVault Referência do Azure Key Vault. KeyVaultReference (obrigatório)
secretName Nome do segredo do Azure Key Vault. cadeia de caracteres (obrigatório)
secretVersion Versão secreta do Azure Key Vault. corda

KeyVaultReference

Nome Descrição Valor
id ID de recurso do Azure Key Vault. cadeia de caracteres (obrigatório)

Microsoft.Resources/deployments

Nome Descrição Valor
localização O local para armazenar os dados de implantação. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[-\w\._\(\)]+$ (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades As propriedades de implantação. DeploymentPropertiesOrDeploymentPropertiesExtended (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Resources/deployments@2024-03-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrição Valor
deploymentName A implantação a ser usada no caso de erro. corda
tipo A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
URI O URI do arquivo de parâmetros. cadeia de caracteres (obrigatório)
Nome Descrição Valor
contentVersion Se incluído, deverá corresponder ao ContentVersion no modelo. corda
id A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas. corda
queryString A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink. corda
relativePath A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai estiver vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai estiver vinculado a um URI, a implantação filho será uma combinação das URIs pai e relativePath corda
URI O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos. corda