Compartir a través de


Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Definición de recursos de Bicep

El tipo de recurso guestConfigurationAssignments es un recurso de extensión , lo que significa que puede aplicarlo a otro recurso.

Use la propiedad scope de este recurso para establecer el ámbito de este recurso. Consulte Establecer ámbito en los recursos de extensión en Bicep.

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.GuestConfiguration/guestConfigurationAssignments, agregue el siguiente bicep a la plantilla.

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 de propiedad

guestConfigurationAssignments

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
ubicación Región donde se encuentra la máquina virtual. cuerda
alcance Use al crear un recurso de extensión en un ámbito diferente del ámbito de implementación. Recurso de destino

Para Bicep, establezca esta propiedad en el nombre simbólico del recurso para aplicar el recurso de extensión .
Propiedades Propiedades de la asignación de configuración de invitado. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nombre Descripción Valor
contexto Origen que inició la asignación de configuración de invitado. Por ejemplo: Azure Policy cuerda
guestConfiguration Configuración de invitado que se va a asignar. GuestConfigurationNavigation
latestAssignmentReport Último informe de asignación de configuración de invitado notificado. AssignmentReport de
vmssVMList Lista de datos de cumplimiento de máquinas virtuales para VMSS vmssvmInfo[]

GuestConfigurationNavigation

Nombre Descripción Valor
assignmentType Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
"Auditar"
'DeployAndAutoCorrect'
configurationParameter Parámetros de configuración para la configuración de invitado. ConfigurationParameter[]
configurationProtectedParameter Parámetros de configuración protegidos para la configuración de invitado. ConfigurationParameter[]
configurationSetting El valor de configuración de la configuración de invitado. ConfigurationSetting
contentHash Hash combinado del paquete de configuración de invitado y los parámetros de configuración. cuerda
contentUri Uri del almacenamiento donde se carga el paquete de configuración de invitado. cuerda
amable Tipo de configuración de invitado. Por ejemplo: DSC 'DSC'
nombre Nombre de la configuración de invitado. cuerda
Versión Versión de la configuración de invitado. cuerda

ConfigurationParameter

Nombre Descripción Valor
nombre Nombre del parámetro de configuración. cuerda
valor Valor del parámetro de configuración. cuerda

ConfigurationSetting

Nombre Descripción Valor
actionAfterReboot Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration. 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Si es true: se permiten nuevas configuraciones descargadas desde el servicio de extracción para sobrescribir las antiguas del nodo de destino. De lo contrario, false Bool
configurationMode Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Con qué frecuencia, en minutos, se comprueba y aplica la configuración actual. Esta propiedad se omite si la propiedad ConfigurationMode está establecida en ApplyOnly. El valor predeterminado es 15. Int
rebootIfNeededed Establézcalo en true para reiniciar automáticamente el nodo después de aplicar una configuración que requiera reiniciar. De lo contrario, tendrá que reiniciar manualmente el nodo para cualquier configuración que lo requiera. El valor predeterminado es false. Para usar esta configuración cuando una condición de reinicio está aprobada por algo distinto de DSC (por ejemplo, Windows Installer), combine esta configuración con el módulo xPendingReboot. Bool
refreshFrequencyMins Intervalo de tiempo, en minutos, en el que el LCM comprueba un servicio de extracción para obtener configuraciones actualizadas. Este valor se omite si el LCM no está configurado en modo de extracción. El valor predeterminado es 30. Int

AssignmentReport

Nombre Descripción Valor
asignación Detalles de configuración de la asignación de configuración de invitado. assignmentInfo de
Recursos Lista de recursos para los que se comprueba el cumplimiento de la asignación de configuración de invitado. assignmentReportResource[]
Vm Información sobre la máquina virtual. vmInfo

AssignmentInfo

Nombre Descripción Valor
configuración Información sobre la configuración. ConfigurationInfo

ConfigurationInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

AssignmentReportResource

Nombre Descripción Valor
Razones Motivo de cumplimiento y código de motivo para un recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VMInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VmssvmInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
máquinas virtuales de IIS & máquina virtual de SQL Server 2014

Implementación en Azure
Cree 1 o 2 servidores web de Windows 2012 R2 de IIS y un back-end SQL Server 2014 en la red virtual.
máquina virtual Windows con de línea base segura de Azure

Implementación en Azure
La plantilla crea una máquina virtual que ejecuta Windows Server en una nueva red virtual, con una dirección IP pública. Una vez implementada la máquina, se instala la extensión de configuración de invitado y se aplica la línea base segura de Azure para Windows Server. Si la configuración de las máquinas se desfase, puede volver a aplicar la configuración mediante la implementación de la plantilla de nuevo.

Definición de recursos de plantilla de ARM

El tipo de recurso guestConfigurationAssignments es un recurso de extensión , lo que significa que puede aplicarlo a otro recurso.

Use la propiedad scope de este recurso para establecer el ámbito de este recurso. Consulte Establecer ámbito en los recursos de extensión en plantillas de ARM.

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.GuestConfiguration/guestConfigurationAssignments, agregue el siguiente JSON a la plantilla.

{
  "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 de propiedad

guestConfigurationAssignments

Nombre Descripción Valor
tipo El tipo de recurso 'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion La versión de la API de recursos '2021-01-25'
nombre El nombre del recurso string (obligatorio)
ubicación Región donde se encuentra la máquina virtual. cuerda
alcance Use al crear un recurso de extensión en un ámbito diferente del ámbito de implementación. Recurso de destino

En JSON, establezca el valor en el nombre completo del recurso para aplicar el recurso de extensión .
Propiedades Propiedades de la asignación de configuración de invitado. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nombre Descripción Valor
contexto Origen que inició la asignación de configuración de invitado. Por ejemplo: Azure Policy cuerda
guestConfiguration Configuración de invitado que se va a asignar. GuestConfigurationNavigation
latestAssignmentReport Último informe de asignación de configuración de invitado notificado. AssignmentReport de
vmssVMList Lista de datos de cumplimiento de máquinas virtuales para VMSS vmssvmInfo[]

GuestConfigurationNavigation

Nombre Descripción Valor
assignmentType Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
"Auditar"
'DeployAndAutoCorrect'
configurationParameter Parámetros de configuración para la configuración de invitado. ConfigurationParameter[]
configurationProtectedParameter Parámetros de configuración protegidos para la configuración de invitado. ConfigurationParameter[]
configurationSetting El valor de configuración de la configuración de invitado. ConfigurationSetting
contentHash Hash combinado del paquete de configuración de invitado y los parámetros de configuración. cuerda
contentUri Uri del almacenamiento donde se carga el paquete de configuración de invitado. cuerda
amable Tipo de configuración de invitado. Por ejemplo: DSC 'DSC'
nombre Nombre de la configuración de invitado. cuerda
Versión Versión de la configuración de invitado. cuerda

ConfigurationParameter

Nombre Descripción Valor
nombre Nombre del parámetro de configuración. cuerda
valor Valor del parámetro de configuración. cuerda

ConfigurationSetting

Nombre Descripción Valor
actionAfterReboot Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration. 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Si es true: se permiten nuevas configuraciones descargadas desde el servicio de extracción para sobrescribir las antiguas del nodo de destino. De lo contrario, false Bool
configurationMode Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Con qué frecuencia, en minutos, se comprueba y aplica la configuración actual. Esta propiedad se omite si la propiedad ConfigurationMode está establecida en ApplyOnly. El valor predeterminado es 15. Int
rebootIfNeededed Establézcalo en true para reiniciar automáticamente el nodo después de aplicar una configuración que requiera reiniciar. De lo contrario, tendrá que reiniciar manualmente el nodo para cualquier configuración que lo requiera. El valor predeterminado es false. Para usar esta configuración cuando una condición de reinicio está aprobada por algo distinto de DSC (por ejemplo, Windows Installer), combine esta configuración con el módulo xPendingReboot. Bool
refreshFrequencyMins Intervalo de tiempo, en minutos, en el que el LCM comprueba un servicio de extracción para obtener configuraciones actualizadas. Este valor se omite si el LCM no está configurado en modo de extracción. El valor predeterminado es 30. Int

AssignmentReport

Nombre Descripción Valor
asignación Detalles de configuración de la asignación de configuración de invitado. assignmentInfo de
Recursos Lista de recursos para los que se comprueba el cumplimiento de la asignación de configuración de invitado. assignmentReportResource[]
Vm Información sobre la máquina virtual. vmInfo

AssignmentInfo

Nombre Descripción Valor
configuración Información sobre la configuración. ConfigurationInfo

ConfigurationInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

AssignmentReportResource

Nombre Descripción Valor
Razones Motivo de cumplimiento y código de motivo para un recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VMInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VmssvmInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
máquinas virtuales de IIS & máquina virtual de SQL Server 2014

Implementación en Azure
Cree 1 o 2 servidores web de Windows 2012 R2 de IIS y un back-end SQL Server 2014 en la red virtual.
máquina virtual Windows con de línea base segura de Azure

Implementación en Azure
La plantilla crea una máquina virtual que ejecuta Windows Server en una nueva red virtual, con una dirección IP pública. Una vez implementada la máquina, se instala la extensión de configuración de invitado y se aplica la línea base segura de Azure para Windows Server. Si la configuración de las máquinas se desfase, puede volver a aplicar la configuración mediante la implementación de la plantilla de nuevo.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso guestConfigurationAssignments es un recurso de extensión , lo que significa que puede aplicarlo a otro recurso.

Use la propiedad parent_id de este recurso para establecer el ámbito de este recurso.

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.GuestConfiguration/guestConfigurationAssignments, agregue el siguiente terraform a la plantilla.

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 de propiedad

guestConfigurationAssignments

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
nombre El nombre del recurso string (obligatorio)
ubicación Región donde se encuentra la máquina virtual. cuerda
parent_id Identificador del recurso al que se va a aplicar este recurso de extensión. string (obligatorio)
Propiedades Propiedades de la asignación de configuración de invitado. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nombre Descripción Valor
contexto Origen que inició la asignación de configuración de invitado. Por ejemplo: Azure Policy cuerda
guestConfiguration Configuración de invitado que se va a asignar. GuestConfigurationNavigation
latestAssignmentReport Último informe de asignación de configuración de invitado notificado. AssignmentReport de
vmssVMList Lista de datos de cumplimiento de máquinas virtuales para VMSS vmssvmInfo[]

GuestConfigurationNavigation

Nombre Descripción Valor
assignmentType Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Auditar"
"DeployAndAutoCorrect"
configurationParameter Parámetros de configuración para la configuración de invitado. ConfigurationParameter[]
configurationProtectedParameter Parámetros de configuración protegidos para la configuración de invitado. ConfigurationParameter[]
configurationSetting El valor de configuración de la configuración de invitado. ConfigurationSetting
contentHash Hash combinado del paquete de configuración de invitado y los parámetros de configuración. cuerda
contentUri Uri del almacenamiento donde se carga el paquete de configuración de invitado. cuerda
amable Tipo de configuración de invitado. Por ejemplo: DSC "DSC"
nombre Nombre de la configuración de invitado. cuerda
Versión Versión de la configuración de invitado. cuerda

ConfigurationParameter

Nombre Descripción Valor
nombre Nombre del parámetro de configuración. cuerda
valor Valor del parámetro de configuración. cuerda

ConfigurationSetting

Nombre Descripción Valor
actionAfterReboot Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration. "ContinueConfiguration"
"StopConfiguration"
allowModuleOverwrite Si es true: se permiten nuevas configuraciones descargadas desde el servicio de extracción para sobrescribir las antiguas del nodo de destino. De lo contrario, false Bool
configurationMode Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"ApplyOnly"
configurationModeFrequencyMins Con qué frecuencia, en minutos, se comprueba y aplica la configuración actual. Esta propiedad se omite si la propiedad ConfigurationMode está establecida en ApplyOnly. El valor predeterminado es 15. Int
rebootIfNeededed Establézcalo en true para reiniciar automáticamente el nodo después de aplicar una configuración que requiera reiniciar. De lo contrario, tendrá que reiniciar manualmente el nodo para cualquier configuración que lo requiera. El valor predeterminado es false. Para usar esta configuración cuando una condición de reinicio está aprobada por algo distinto de DSC (por ejemplo, Windows Installer), combine esta configuración con el módulo xPendingReboot. Bool
refreshFrequencyMins Intervalo de tiempo, en minutos, en el que el LCM comprueba un servicio de extracción para obtener configuraciones actualizadas. Este valor se omite si el LCM no está configurado en modo de extracción. El valor predeterminado es 30. Int

AssignmentReport

Nombre Descripción Valor
asignación Detalles de configuración de la asignación de configuración de invitado. assignmentInfo de
Recursos Lista de recursos para los que se comprueba el cumplimiento de la asignación de configuración de invitado. assignmentReportResource[]
Vm Información sobre la máquina virtual. vmInfo

AssignmentInfo

Nombre Descripción Valor
configuración Información sobre la configuración. ConfigurationInfo

ConfigurationInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

AssignmentReportResource

Nombre Descripción Valor
Razones Motivo de cumplimiento y código de motivo para un recurso. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VMInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

VmssvmInfo

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.