Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20

• Últimas
• 2022-01-25
• 2021-01-25
• 2020-06-25
• 2018-11-20
• 2018-06-30-preview
• 2018-01-20-preview

Definição de recursos do bíceps

O tipo de recurso guestConfigurationAssignments é um recurso de extensão , o que significa que você pode aplicá-lo a outro recurso.

Use a propriedade scope neste recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão no Bicep.

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

Formato do recurso

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

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20' = {
  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'
    }
    vmssVMList: [
      {
      }
    ]
  }
}

Valores de propriedade

guestConfigurationAssignments

Designação	Descrição	Valor
Designação	O nome do recurso	string (obrigatório)
Localização	Região onde a VM está localizada.	string
Âmbito de aplicação	Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação.	Recurso de destino Para Bicep, defina essa propriedade como o nome simbólico do recurso para aplicar o recurso de extensão .
propriedades	Propriedades da atribuição de configuração de convidado.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Designação	Descrição	Valor
Contexto	A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure	string
guestConfiguration	A configuração de convidado a ser atribuída.	GuestConfigurationNavigation
vmssVMList	A lista de dados de conformidade de VM para VMSS	VmssvmInfo []

GuestConfigurationNavigation

Designação	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'
configurationParâmetro	Os parâmetros de configuração para a configuração do convidado.	ConfigurationParameter[]
configurationProtectedParameter	Os parâmetros de configuração protegidos para a configuração de convidado.	ConfigurationParameter[]
configuraçãoDefinição	A definição de configuração para a configuração do convidado.	ConfigurationSetting
contentHash	Hash combinado do pacote de configuração do convidado e dos parâmetros de configuração.	string
contentUri	Uri do armazenamento onde o pacote de configuração de convidado é carregado.	string
tipo	Tipo de configuração de convidado. Por exemplo:DSC	«DSC»
Designação	Nome da configuração do convidado.	string
Versão	Versão da configuração do convidado.	string

ConfigurationParameter

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

ConfiguraçãoDefinição

Designação	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	'ContinuarConfiguração' 'StopConfiguration'
allowModuleOverwrite	Se verdadeiro - novas configurações baixadas do serviço pull têm permissão para substituir as antigas no nó de destino. Caso contrário, falso	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'
configuraçãoModeFrequencyMins	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ê terá que 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 for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.	Bool
refreshFrequencyMins	O intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 30.	Int

VmssvmInfo

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

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	Crie 1 ou 2 servidores Web IIS Windows 2012 R2 e um SQL Server 2014 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 a máquina for implantada, 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 das máquinas se desviar, você poderá reaplicar as configurações implantando o modelo novamente.

Definição de recurso de modelo ARM

O tipo de recurso guestConfigurationAssignments é um recurso de extensão , o que significa que você pode aplicá-lo a outro recurso.

Use a propriedade scope neste recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão em modelos ARM.

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

Formato do recurso

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

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2018-11-20",
  "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"
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Valores de propriedade

guestConfigurationAssignments

Designação	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion	A versão da api de recursos	'2018-11-20'
Designação	O nome do recurso	string (obrigatório)
Localização	Região onde a VM está localizada.	string
Âmbito de aplicação	Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação.	Recurso de destino Para JSON, defina o valor como o nome completo do recurso para aplicar o de recurso de extensão de .
propriedades	Propriedades da atribuição de configuração de convidado.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Designação	Descrição	Valor
Contexto	A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure	string
guestConfiguration	A configuração de convidado a ser atribuída.	GuestConfigurationNavigation
vmssVMList	A lista de dados de conformidade de VM para VMSS	VmssvmInfo []

GuestConfigurationNavigation

Designação	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'
configurationParâmetro	Os parâmetros de configuração para a configuração do convidado.	ConfigurationParameter[]
configurationProtectedParameter	Os parâmetros de configuração protegidos para a configuração de convidado.	ConfigurationParameter[]
configuraçãoDefinição	A definição de configuração para a configuração do convidado.	ConfigurationSetting
contentHash	Hash combinado do pacote de configuração do convidado e dos parâmetros de configuração.	string
contentUri	Uri do armazenamento onde o pacote de configuração de convidado é carregado.	string
tipo	Tipo de configuração de convidado. Por exemplo:DSC	«DSC»
Designação	Nome da configuração do convidado.	string
Versão	Versão da configuração do convidado.	string

ConfigurationParameter

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

ConfiguraçãoDefinição

Designação	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	'ContinuarConfiguração' 'StopConfiguration'
allowModuleOverwrite	Se verdadeiro - novas configurações baixadas do serviço pull têm permissão para substituir as antigas no nó de destino. Caso contrário, falso	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'
configuraçãoModeFrequencyMins	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ê terá que 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 for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.	Bool
refreshFrequencyMins	O intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 30.	Int

VmssvmInfo

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

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	Crie 1 ou 2 servidores Web IIS Windows 2012 R2 e um SQL Server 2014 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 a máquina for implantada, 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 das máquinas se desviar, você poderá reaplicar as configurações implantando o modelo novamente.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso guestConfigurationAssignments é um recurso de extensão , o que significa que você pode aplicá-lo a outro recurso.

Use a propriedade parent_id neste recurso para definir o escopo desse recurso.

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
  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"
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Valores de propriedade

guestConfigurationAssignments

Designação	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
Designação	O nome do recurso	string (obrigatório)
Localização	Região onde a VM está localizada.	string
parent_id	A ID do recurso ao qual aplicar esse recurso de extensão.	string (obrigatório)
propriedades	Propriedades da atribuição de configuração de convidado.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Designação	Descrição	Valor
Contexto	A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure	string
guestConfiguration	A configuração de convidado a ser atribuída.	GuestConfigurationNavigation
vmssVMList	A lista de dados de conformidade de VM para VMSS	VmssvmInfo []

GuestConfigurationNavigation

Designação	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"
configurationParâmetro	Os parâmetros de configuração para a configuração do convidado.	ConfigurationParameter[]
configurationProtectedParameter	Os parâmetros de configuração protegidos para a configuração de convidado.	ConfigurationParameter[]
configuraçãoDefinição	A definição de configuração para a configuração do convidado.	ConfigurationSetting
contentHash	Hash combinado do pacote de configuração do convidado e dos parâmetros de configuração.	string
contentUri	Uri do armazenamento onde o pacote de configuração de convidado é carregado.	string
tipo	Tipo de configuração de convidado. Por exemplo:DSC	"DSC"
Designação	Nome da configuração do convidado.	string
Versão	Versão da configuração do convidado.	string

ConfigurationParameter

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

ConfiguraçãoDefinição

Designação	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	"ContinuarConfiguração" "StopConfiguration"
allowModuleOverwrite	Se verdadeiro - novas configurações baixadas do serviço pull têm permissão para substituir as antigas no nó de destino. Caso contrário, falso	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"
configuraçãoModeFrequencyMins	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ê terá que 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 for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.	Bool
refreshFrequencyMins	O intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 30.	Int

VmssvmInfo

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