Compartilhar via

Microsoft.GuestConfiguration guestConfigurationAssignments 2020-06-25

  • Artigo

Definição de recurso do Bicep

O tipo de recurso guestConfigurationAssignments 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.GuestConfiguration/guestConfigurationAssignments, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: '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: 'string'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {}
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {}
    ]
  }
}

Valores de propriedade

AssignmentInfo

Nome Descrição Valor
configuração Informações sobre a configuração. ConfigurationInfo

AssignmentReport

Nome Descrição Valor
designação Detalhes de configuração da atribuição de configuração de convidado. AssignmentInfo
Recursos A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada. AssignmentReportResource []
Vm Informações sobre a VM. VMInfo

AssignmentReportResource

Nome Descrição Valor
Razões Motivo de conformidade e código de motivo para um recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Nome Descrição Valor

ConfigurationInfo

Nome Descrição Valor

ConfigurationParameter

Nome Descrição Valor
nome Nome do parâmetro de configuração. corda
valor Valor do parâmetro de configuração. corda

ConfigurationSetting

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Se true – novas configurações baixadas do serviço de pull têm permissão para substituir as antigas no nó de destino. Caso contrário, false Bool
configurationMode Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. 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. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15. int
rebootIfNeeded Defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você precisará reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização é promulgada por algo diferente de DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot. Bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de pull. O valor padrão é 30. int

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A origem que iniciou a atribuição de configuração de convidado. Ex: Azure Policy corda
guestConfiguration A configuração de convidado a ser atribuída. GuestConfigurationNavigation
latestAssignmentReport Último relatório de atribuição de configuração de convidado relatado. AssignmentReport
vmssVMList A lista de dados de conformidade da VM para VMSS VmssvmInfo []

GuestConfigurationNavigation

Nome Descrição Valor
assignmentType 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'
configurationParameter Os parâmetros de configuração para a configuração de convidado. ConfigurationParameter []
configurationProtectedParameter Os parâmetros de configuração protegidos para a configuração de convidado. ConfigurationParameter []
configurationSetting A configuração da configuração do convidado. configurationSetting
contentHash Hash combinado do pacote de configuração de convidado e dos parâmetros de configuração. corda
contentUri Uri do armazenamento em que o pacote de configuração de convidado é carregado. corda
tipo Tipo de configuração de convidado. Por exemplo:DSC 'DSC'
nome Nome da configuração de convidado. corda
Versão Versão da configuração de convidado. corda

Microsoft.GuestConfiguration/guestConfigurationAssignments

Nome Descrição Valor
localização Região em que a VM está localizada. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da atribuição de configuração de convidado. GuestConfigurationAssignmentProperties
â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 .

VMInfo

Nome Descrição Valor

VmssvmInfo

Nome Descrição Valor

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
VMs do IIS & de VM do SQL Server 2014 Crie 1 ou 2 Servidores Web do Windows 2012 R2 do IIS e um SQL Server 2014 de back-end na VNET.
VM do Windows com de linha de base segura do Azure O modelo cria uma máquina virtual executando o Windows Server em uma nova rede virtual, com um endereço IP público. Depois que o computador for implantado, a extensão de configuração de convidado será instalada e a linha de base segura do Azure para Windows Server será aplicada. Se a configuração dos computadores descompassar, você poderá aplicar novamente as configurações implantando o modelo novamente.

Definição de recurso de modelo do ARM

O tipo de recurso guestConfigurationAssignments 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.GuestConfiguration/guestConfigurationAssignments, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2020-06-25",
  "name": "string",
  "location": "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": "string",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {
        }
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {
      }
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Valores de propriedade

AssignmentInfo

Nome Descrição Valor
configuração Informações sobre a configuração. ConfigurationInfo

AssignmentReport

Nome Descrição Valor
designação Detalhes de configuração da atribuição de configuração de convidado. AssignmentInfo
Recursos A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada. AssignmentReportResource []
Vm Informações sobre a VM. VMInfo

AssignmentReportResource

Nome Descrição Valor
Razões Motivo de conformidade e código de motivo para um recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Nome Descrição Valor

ConfigurationInfo

Nome Descrição Valor

ConfigurationParameter

Nome Descrição Valor
nome Nome do parâmetro de configuração. corda
valor Valor do parâmetro de configuração. corda

ConfigurationSetting

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Se true – novas configurações baixadas do serviço de pull têm permissão para substituir as antigas no nó de destino. Caso contrário, false Bool
configurationMode Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. 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. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15. int
rebootIfNeeded Defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você precisará reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização é promulgada por algo diferente de DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot. Bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de pull. O valor padrão é 30. int

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A origem que iniciou a atribuição de configuração de convidado. Ex: Azure Policy corda
guestConfiguration A configuração de convidado a ser atribuída. GuestConfigurationNavigation
latestAssignmentReport Último relatório de atribuição de configuração de convidado relatado. AssignmentReport
vmssVMList A lista de dados de conformidade da VM para VMSS VmssvmInfo []

GuestConfigurationNavigation

Nome Descrição Valor
assignmentType 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'
configurationParameter Os parâmetros de configuração para a configuração de convidado. ConfigurationParameter []
configurationProtectedParameter Os parâmetros de configuração protegidos para a configuração de convidado. ConfigurationParameter []
configurationSetting A configuração da configuração do convidado. configurationSetting
contentHash Hash combinado do pacote de configuração de convidado e dos parâmetros de configuração. corda
contentUri Uri do armazenamento em que o pacote de configuração de convidado é carregado. corda
tipo Tipo de configuração de convidado. Por exemplo:DSC 'DSC'
nome Nome da configuração de convidado. corda
Versão Versão da configuração de convidado. corda

Microsoft.GuestConfiguration/guestConfigurationAssignments

Nome Descrição Valor
apiVersion A versão da API '2020-06-25'
localização Região em que a VM está localizada. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da atribuição de configuração de convidado. GuestConfigurationAssignmentProperties
tipo O tipo de recurso 'Microsoft.GuestConfiguration/guestConfigurationAssignments'

VMInfo

Nome Descrição Valor

VmssvmInfo

Nome Descrição Valor

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
VMs do IIS & de VM do SQL Server 2014

Implantar no Azure 		Crie 1 ou 2 Servidores Web do Windows 2012 R2 do IIS e um SQL Server 2014 de back-end na VNET.
VM do Windows com de linha de base segura do Azure

Implantar no Azure 		O modelo cria uma máquina virtual executando o Windows Server em uma nova rede virtual, com um endereço IP público. Depois que o computador for implantado, a extensão de configuração de convidado será instalada e a linha de base segura do Azure para Windows Server será aplicada. Se a configuração dos computadores descompassar, você poderá aplicar novamente as configurações implantando o modelo novamente.

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

O tipo de recurso guestConfigurationAssignments 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.GuestConfiguration/guestConfigurationAssignments, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25"
  name = "string"
  parent_id = "string"
  location = "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 = "string"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {
          }
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {
        }
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Valores de propriedade

AssignmentInfo

Nome Descrição Valor
configuração Informações sobre a configuração. ConfigurationInfo

AssignmentReport

Nome Descrição Valor
designação Detalhes de configuração da atribuição de configuração de convidado. AssignmentInfo
Recursos A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada. AssignmentReportResource []
Vm Informações sobre a VM. VMInfo

AssignmentReportResource

Nome Descrição Valor
Razões Motivo de conformidade e código de motivo para um recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Nome Descrição Valor

ConfigurationInfo

Nome Descrição Valor

ConfigurationParameter

Nome Descrição Valor
nome Nome do parâmetro de configuração. corda
valor Valor do parâmetro de configuração. corda

ConfigurationSetting

Nome Descrição Valor
actionAfterReboot Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Se true – novas configurações baixadas do serviço de pull têm permissão para substituir as antigas no nó de destino. Caso contrário, false Bool
configurationMode Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. 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. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15. int
rebootIfNeeded Defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você precisará reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização é promulgada por algo diferente de DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot. Bool
refreshFrequencyMins O intervalo de tempo, em minutos, em que o LCM verifica um serviço de pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de pull. O valor padrão é 30. int

GuestConfigurationAssignmentProperties

Nome Descrição Valor
contexto A origem que iniciou a atribuição de configuração de convidado. Ex: Azure Policy corda
guestConfiguration A configuração de convidado a ser atribuída. GuestConfigurationNavigation
latestAssignmentReport Último relatório de atribuição de configuração de convidado relatado. AssignmentReport
vmssVMList A lista de dados de conformidade da VM para VMSS VmssvmInfo []

GuestConfigurationNavigation

Nome Descrição Valor
assignmentType 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'
configurationParameter Os parâmetros de configuração para a configuração de convidado. ConfigurationParameter []
configurationProtectedParameter Os parâmetros de configuração protegidos para a configuração de convidado. ConfigurationParameter []
configurationSetting A configuração da configuração do convidado. configurationSetting
contentHash Hash combinado do pacote de configuração de convidado e dos parâmetros de configuração. corda
contentUri Uri do armazenamento em que o pacote de configuração de convidado é carregado. corda
tipo Tipo de configuração de convidado. Por exemplo:DSC 'DSC'
nome Nome da configuração de convidado. corda
Versão Versão da configuração de convidado. corda

Microsoft.GuestConfiguration/guestConfigurationAssignments

Nome Descrição Valor
localização Região em que a VM está localizada. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades Propriedades da atribuição de configuração de convidado. GuestConfigurationAssignmentProperties
tipo O tipo de recurso "Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25"

VMInfo

Nome Descrição Valor

VmssvmInfo

Nome Descrição Valor