Partilhar via


Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Definição de recurso bicep

O tipo de recurso de configuração de hóspedes é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir a margem para este recurso. Consulte o âmbito de aplicação dos recursos de extensão em Bicep.

Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.

Formato de recursos

Para criar um recurso Microsoft.GuestConfiguration/guestConfigurationAssignments, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationSetting: {
        actionAfterReboot: 'string'
        allowModuleOverwrite: bool
        configurationMode: 'string'
        configurationModeFrequencyMins: int
        rebootIfNeeded: bool
        refreshFrequencyMins: int
      }
      contentHash: 'string'
      contentUri: 'string'
      kind: 'DSC'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {
            }
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {
      }
    ]
  }
}

Valores imobiliários

guestConfigurationAssignments

Nome Descrição Valor
name O nome do recurso corda (necessária)
localização Região onde está localizado o VM. string
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implantação. Recurso de destino

Para a Bicep, desaprote esta propriedade para o nome simbólico do recurso para aplicar o recurso de extensão.
propriedades Propriedades da atribuição de configuração do Hóspede. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A fonte que iniciou a atribuição de configuração de hóspedes. Ex: Azure Policy string
configuração convidado A configuração do hóspede para atribuir. GuestConfigurationNavigation
mais recentesAssignmentReport Último relatório de atribuição de configuração de hóspedes. Relatório de Atribuição
vmssVMList A lista de dados de conformidade vm para VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrição Valor
tipo de atribuição Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Auditoria'
'DeployAndAutoCorrect'
configuraçãoParametro Os parâmetros de configuração para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoParameterproteted Os parâmetros de configuração protegidos para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoSetting A definição de configuração para a configuração do convidado. ConfiguraçãoS
contentHash Hash combinado do pacote de configuração do convidado e parâmetros de configuração. string
conteúdoUri Uri do armazenamento onde o pacote de configuração do hóspede é carregado. string
tipo Tipo a configuração do convidado. Por exemplo: DSC 'DSC'
name Nome da configuração do hóspede. string
versão Versão da configuração do convidado. string

ConfiguraçãoParametro

Nome Descrição Valor
name Nome do parâmetro de configuração. string
valor Valor do parâmetro de configuração. string

ConfiguraçãoS

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após um reboot durante a aplicação de uma configuração. Os valores possíveis são ContinuaConfiguration e StopConfiguration 'Continuar aConfiguration'
'StopConfiguration'
permitirModuleOverwrite Se for verdade - novas configurações descarregadas do serviço pull são permitidas para substituir as antigas no nó-alvo. Caso contrário, falso bool
configuraçãoMode Especifica como o LCM (Configuration Manager Local) aplica efetivamente a configuração aos nós-alvo. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Com que frequência, em minutos, a configuração atual é verificada e aplicada. Esta propriedade é ignorada se a propriedade ConfigurationMode estiver definida para ApplyOnly. O valor predefinido é 15. int
rebootIfNeed Descreva isto para reiniciar automaticamente o nó depois de ser aplicada uma configuração que requer reinicialização. Caso contrário, terá de reiniciar manualmente o nó para qualquer configuração que o exija. O valor predefinido é false. Para utilizar esta definição quando uma condição de reinicialização for decretada por algo diferente do DSC (tal como o Instalador do Windows), combine esta definição com o módulo xPendingReboot. bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de puxar para obter configurações atualizadas. Este valor é ignorado se o LCM não estiver configurado no modo de puxar. O valor predefinido é 30. int

Relatório de Atribuição

Nome Descrição Valor
atribuição Detalhes de configuração da atribuição de configuração do hóspede. AtribuiçãoInfo
resources A lista de recursos para os quais a atribuição de configuração de hóspedes é verificada. AtribuiçãoReportResource[]
cm Informação sobre o VM. VMInfo

AtribuiçãoInfo

Nome Descrição Valor
configuração Informação sobre a configuração. ConfiguraçãoInfo

ConfiguraçãoInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

AtribuiçãoReportResource

Nome Descrição Valor
razões Conformidade razão e código de razão para um recurso. AtribuiçãoReportResourceComplianceReason[]

AtribuiçãoReportResourceComplianceReason

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VMInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VmssvmInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

Modelos de início rápido

Os seguintes modelos de arranque rápido implementam este tipo de recurso.

Modelo Descrição
Windows VM com linha de base segura Azure

Implementar no Azure
O modelo cria uma máquina virtual que executa o Windows Server numa nova rede virtual, com um endereço IP público. Uma vez implantada a máquina, a extensão de configuração do hóspede é instalada e a linha de base segura Azure para o Windows Server é aplicada. Se a configuração das máquinas derivar, pode voltar a aplicar as definições implantando novamente o modelo.

Definição de recurso de modelo DE ARM

O tipo de recurso de configuração de hóspedes é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir a margem para este recurso. Consulte o âmbito de aplicação dos recursos de extensão nos modelos ARM.

Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.

Formato de recursos

Para criar um recurso Microsoft.GuestConfiguration/guestConfigurationAssignments, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2021-01-25",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationSetting": {
        "actionAfterReboot": "string",
        "allowModuleOverwrite": "bool",
        "configurationMode": "string",
        "configurationModeFrequencyMins": "int",
        "rebootIfNeeded": "bool",
        "refreshFrequencyMins": "int"
      },
      "contentHash": "string",
      "contentUri": "string",
      "kind": "DSC",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {}
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {}
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Valores imobiliários

guestConfigurationAssignments

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion A versão api de recurso '2021-01-25'
name O nome do recurso corda (necessária)
localização Região onde está localizado o VM. string
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implantação. Recurso de destino

Para o JSON, desaprote o valor para o nome completo do recurso para aplicar o recurso de extensão .
propriedades Propriedades da atribuição de configuração do Hóspede. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A fonte que iniciou a atribuição de configuração de hóspedes. Ex: Azure Policy string
configuração convidado A configuração do hóspede para atribuir. GuestConfigurationNavigation
mais recentesAssignmentReport Último relatório de atribuição de configuração de hóspedes. Relatório de Atribuição
vmssVMList A lista de dados de conformidade vm para VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrição Valor
tipo de atribuição Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Auditoria'
'DeployAndAutoCorrect'
configuraçãoParametro Os parâmetros de configuração para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoParameterproteted Os parâmetros de configuração protegidos para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoSetting A definição de configuração para a configuração do convidado. ConfiguraçãoS
contentHash Hash combinado do pacote de configuração do convidado e parâmetros de configuração. string
conteúdoUri Uri do armazenamento onde o pacote de configuração do hóspede é carregado. string
tipo Tipo a configuração do convidado. Por exemplo: DSC 'DSC'
name Nome da configuração do hóspede. string
versão Versão da configuração do convidado. string

ConfiguraçãoParametro

Nome Descrição Valor
name Nome do parâmetro de configuração. string
valor Valor do parâmetro de configuração. string

ConfiguraçãoS

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após um reboot durante a aplicação de uma configuração. Os valores possíveis são ContinuaConfiguration e StopConfiguration 'Continuar aConfiguration'
'StopConfiguration'
permitirModuleOverwrite Se for verdade - novas configurações descarregadas do serviço pull são permitidas para substituir as antigas no nó-alvo. Caso contrário, falso bool
configuraçãoMode Especifica como o LCM (Configuration Manager Local) aplica efetivamente a configuração aos nós-alvo. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Com que frequência, em minutos, a configuração atual é verificada e aplicada. Esta propriedade é ignorada se a propriedade ConfigurationMode estiver definida para ApplyOnly. O valor predefinido é 15. int
rebootIfNeed Descreva isto para reiniciar automaticamente o nó depois de ser aplicada uma configuração que requer reinicialização. Caso contrário, terá de reiniciar manualmente o nó para qualquer configuração que o exija. O valor predefinido é false. Para utilizar esta definição quando uma condição de reinicialização for decretada por algo diferente do DSC (tal como o Instalador do Windows), combine esta definição com o módulo xPendingReboot. bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de puxar para obter configurações atualizadas. Este valor é ignorado se o LCM não estiver configurado no modo de puxar. O valor predefinido é 30. int

Relatório de Atribuição

Nome Descrição Valor
atribuição Detalhes de configuração da atribuição de configuração do hóspede. AtribuiçãoInfo
resources A lista de recursos para os quais a atribuição de configuração de hóspedes é verificada. AtribuiçãoReportResource[]
cm Informação sobre o VM. VMInfo

AtribuiçãoInfo

Nome Descrição Valor
configuração Informação sobre a configuração. ConfiguraçãoInfo

ConfiguraçãoInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

AtribuiçãoReportResource

Nome Descrição Valor
razões Conformidade razão e código de razão para um recurso. AtribuiçãoReportResourceComplianceReason[]

AtribuiçãoReportResourceComplianceReason

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VMInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VmssvmInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

Modelos de início rápido

Os seguintes modelos de arranque rápido implementam este tipo de recurso.

Modelo Descrição
Windows VM com linha de base segura Azure

Implementar no Azure
O modelo cria uma máquina virtual que executa o Windows Server numa nova rede virtual, com um endereço IP público. Uma vez implantada a máquina, a extensão de configuração do hóspede é instalada e a linha de base segura Azure para o Windows Server é aplicada. Se a configuração das máquinas derivar, pode voltar a aplicar as definições implantando novamente o modelo.

Definição de recursos Terraform (fornecedor AzAPI)

O tipo de recurso de configuração de hóspedes é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a parent_id propriedade neste recurso para definir a margem para este recurso.

Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.

Formato de recursos

Para criar um recurso Microsoft.GuestConfiguration/guestConfigurationAssignments, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      context = "string"
      guestConfiguration = {
        assignmentType = "string"
        configurationParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationProtectedParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationSetting = {
          actionAfterReboot = "string"
          allowModuleOverwrite = bool
          configurationMode = "string"
          configurationModeFrequencyMins = int
          rebootIfNeeded = bool
          refreshFrequencyMins = int
        }
        contentHash = "string"
        contentUri = "string"
        kind = "DSC"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {}
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {}
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Valores imobiliários

guestConfigurationAssignments

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
name O nome do recurso corda (necessária)
localização Região onde está localizado o VM. string
parent_id O ID do recurso para aplicar este recurso de extensão. corda (necessária)
propriedades Propriedades da atribuição de configuração do Hóspede. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A fonte que iniciou a atribuição de configuração de hóspedes. Ex: Azure Policy string
configuração convidado A configuração do hóspede para atribuir. GuestConfigurationNavigation
mais recentesAssignmentReport Último relatório de atribuição de configuração de hóspedes. Relatório de Atribuição
vmssVMList A lista de dados de conformidade vm para VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrição Valor
tipo de atribuição Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Auditoria"
"DeployAndAutoCorrect"
configuraçãoParametro Os parâmetros de configuração para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoParameterproteted Os parâmetros de configuração protegidos para a configuração do hóspede. ConfiguraçãoParameter[]
configuraçãoSetting A definição de configuração para a configuração do convidado. ConfiguraçãoS
contentHash Hash combinado do pacote de configuração do convidado e parâmetros de configuração. string
conteúdoUri Uri do armazenamento onde o pacote de configuração do hóspede é carregado. string
tipo Tipo a configuração do convidado. Por exemplo: DSC "DSC"
name Nome da configuração do hóspede. string
versão Versão da configuração do convidado. string

ConfiguraçãoParametro

Nome Descrição Valor
name Nome do parâmetro de configuração. string
valor Valor do parâmetro de configuração. string

ConfiguraçãoS

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após um reboot durante a aplicação de uma configuração. Os valores possíveis são ContinuaConfiguration e StopConfiguration "Continuar a Coniguteração"
"Parar aConfiguration"
permitirModuleOverwrite Se for verdade - novas configurações descarregadas do serviço pull são permitidas para substituir as antigas no nó-alvo. Caso contrário, falso bool
configuraçãoMode Especifica como o LCM (Configuration Manager Local) aplica efetivamente a configuração aos nós-alvo. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"ApplyOnly"
configurationModeFrequencyMins Com que frequência, em minutos, a configuração atual é verificada e aplicada. Esta propriedade é ignorada se a propriedade ConfigurationMode estiver definida para ApplyOnly. O valor predefinido é 15. int
rebootIfNeed Descreva isto para reiniciar automaticamente o nó depois de ser aplicada uma configuração que requer reinicialização. Caso contrário, terá de reiniciar manualmente o nó para qualquer configuração que o exija. O valor predefinido é false. Para utilizar esta definição quando uma condição de reinicialização for decretada por algo diferente do DSC (tal como o Instalador do Windows), combine esta definição com o módulo xPendingReboot. bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de puxar para obter configurações atualizadas. Este valor é ignorado se o LCM não estiver configurado no modo de puxar. O valor predefinido é 30. int

Relatório de Atribuição

Nome Descrição Valor
atribuição Detalhes de configuração da atribuição de configuração do hóspede. AtribuiçãoInfo
resources A lista de recursos para os quais a atribuição de configuração de hóspedes é verificada. AtribuiçãoReportResource[]
cm Informação sobre o VM. VMInfo

AtribuiçãoInfo

Nome Descrição Valor
configuração Informação sobre a configuração. ConfiguraçãoInfo

ConfiguraçãoInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

AtribuiçãoReportResource

Nome Descrição Valor
razões Conformidade razão e código de razão para um recurso. AtribuiçãoReportResourceComplianceReason[]

AtribuiçãoReportResourceComplianceReason

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VMInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.

VmssvmInfo

Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.