Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20

Статья
10/19/2024

Определение ресурсов Bicep

Тип ресурса guestConfigurationAssignments является ресурсом расширения, что означает, что его можно применить к другому ресурсу.

Используйте свойство scope в этом ресурсе, чтобы задать область для этого ресурса. См. раздел Настройка области для ресурсов расширения в Bicep.

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.GuestConfiguration/guestConfigurationAssignments, добавьте следующий Bicep в шаблон.

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: [
      {
      }
    ]
  }
}

Значения свойств

guestConfigurationAssignments

Имя	Описание	Ценность
имя	Имя ресурса	строка (обязательно)
местоположение	Регион, в котором находится виртуальная машина.	струна
размах	Используется при создании ресурса расширения в области, отличной от области развертывания.	Целевой ресурс Для Bicep задайте для этого свойства символическое имя ресурса, чтобы применить ресурс расширения .
свойства	Свойства назначения гостевой конфигурации.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Имя	Описание	Ценность
контекст	Источник, инициирующий назначение гостевой конфигурации. Например: политика Azure	струна
guestConfiguration	Назначаемая гостевая конфигурация.	GuestConfigurationNavigation
vmssVMList	Список данных о соответствии виртуальных машин для VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Имя	Описание	Ценность
assignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.	ApplyAndAutoCorrect "ApplyAndMonitor" Аудит DeployAndAutoCorrect
configurationParameter	Параметры конфигурации гостевой конфигурации.	ConfigurationParameter[]
configurationProtectedParameter	Защищенные параметры конфигурации для гостевой конфигурации.	ConfigurationParameter[]
configurationSetting	Параметр конфигурации для гостевой конфигурации.	ConfigurationSetting
contentHash	Объединенный хэш пакета гостевой конфигурации и параметров конфигурации.	струна
contentUri	Uri хранилища, в котором отправляется пакет гостевой конфигурации.	струна
добрый	Тип гостевой конфигурации. Например:DSC	DSC
имя	Имя гостевой конфигурации.	струна
Версия	Версия гостевой конфигурации.	струна

ConfigurationParameter

Имя	Описание	Ценность
имя	Имя параметра конфигурации.	струна
ценность	Значение параметра конфигурации.	струна

ConfigurationSetting

Имя	Описание	Ценность
actionAfterReboot	Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration	'ContinueConfiguration' StopConfiguration
allowModuleOverwrite	Если значение true — новые конфигурации, скачанные из службы извлечения, могут перезаписать старые конфигурации на целевом узле. В противном случае — значение false	bool
configurationMode	Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.	ApplyAndAutoCorrect "ApplyAndMonitor" ApplyOnly
configurationModeFrequencyMins	Как часто текущая конфигурация проверяется и применяется в минутах. Это свойство игнорируется, если для свойства ConfigurationMode задано значение ApplyOnly. Значение по умолчанию — 15.	int
перезагрузкаIfNeed	Установите для этого значение true, чтобы автоматически перезагрузить узел после настройки, требующей перезагрузки. В противном случае необходимо вручную перезагрузить узел для любой конфигурации, требующей ее. Значение по умолчанию — false. Чтобы использовать этот параметр при принятии условия перезагрузки, отличном от DSC (например, установщика Windows), объедините этот параметр с модулем xPendingReboot.	bool
refreshFrequencyMins	Интервал времени в минутах, в течение которого LCM проверяет службу извлечения, чтобы получить обновленные конфигурации. Это значение игнорируется, если LCM не настроен в режиме извлечения. Значение по умолчанию — 30.	int

VmssvmInfo

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
виртуальные машины IIS & виртуальной машины SQL Server 2014 развертывание	Создайте веб-серверы Windows 2012 R2 с 1 или 2 IIS и один серверный сервер SQL Server 2014 в виртуальной сети.
виртуальной машине Windows с безопасной базы данных Azure развертывание	Шаблон создает виртуальную машину под управлением Windows Server в новой виртуальной сети с общедоступным IP-адресом. После развертывания компьютера устанавливается расширение гостевой конфигурации и применяется безопасный базовый план Azure для Windows Server. При перемещении конфигурации компьютеров можно повторно применить параметры, развернув шаблон еще раз.

Шаблон

Описание

виртуальные машины IIS & виртуальной машины SQL Server 2014

развертывание

Создайте веб-серверы Windows 2012 R2 с 1 или 2 IIS и один серверный сервер SQL Server 2014 в виртуальной сети.

виртуальной машине Windows с безопасной базы данных Azure

развертывание

Шаблон создает виртуальную машину под управлением Windows Server в новой виртуальной сети с общедоступным IP-адресом. После развертывания компьютера устанавливается расширение гостевой конфигурации и применяется безопасный базовый план Azure для Windows Server. При перемещении конфигурации компьютеров можно повторно применить параметры, развернув шаблон еще раз.

Определение ресурса шаблона ARM

Используйте свойство scope в этом ресурсе, чтобы задать область для этого ресурса. См. раздел Настройка области для ресурсов расширения в шаблонах ARM.

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.GuestConfiguration/guestConfigurationAssignments, добавьте следующий код JSON в шаблон.

{
  "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": [
      {
      }
    ]
  }
}

Значения свойств

guestConfigurationAssignments

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.GuestConfiguration/guestConfigurationAssignments"
apiVersion	Версия API ресурсов	'2018-11-20'
имя	Имя ресурса	строка (обязательно)
местоположение	Регион, в котором находится виртуальная машина.	струна
размах	Используется при создании ресурса расширения в области, отличной от области развертывания.	Целевой ресурс Для JSON задайте полное имя ресурса, чтобы применить к ресурс расширения .
свойства	Свойства назначения гостевой конфигурации.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Имя	Описание	Ценность
контекст	Источник, инициирующий назначение гостевой конфигурации. Например: политика Azure	струна
guestConfiguration	Назначаемая гостевая конфигурация.	GuestConfigurationNavigation
vmssVMList	Список данных о соответствии виртуальных машин для VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Имя	Описание	Ценность
assignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.	ApplyAndAutoCorrect "ApplyAndMonitor" Аудит DeployAndAutoCorrect
configurationParameter	Параметры конфигурации гостевой конфигурации.	ConfigurationParameter[]
configurationProtectedParameter	Защищенные параметры конфигурации для гостевой конфигурации.	ConfigurationParameter[]
configurationSetting	Параметр конфигурации для гостевой конфигурации.	ConfigurationSetting
contentHash	Объединенный хэш пакета гостевой конфигурации и параметров конфигурации.	струна
contentUri	Uri хранилища, в котором отправляется пакет гостевой конфигурации.	струна
добрый	Тип гостевой конфигурации. Например:DSC	DSC
имя	Имя гостевой конфигурации.	струна
Версия	Версия гостевой конфигурации.	струна

ConfigurationParameter

Имя	Описание	Ценность
имя	Имя параметра конфигурации.	струна
ценность	Значение параметра конфигурации.	струна

ConfigurationSetting

Имя	Описание	Ценность
actionAfterReboot	Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration	'ContinueConfiguration' StopConfiguration
allowModuleOverwrite	Если значение true — новые конфигурации, скачанные из службы извлечения, могут перезаписать старые конфигурации на целевом узле. В противном случае — значение false	bool
configurationMode	Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.	ApplyAndAutoCorrect "ApplyAndMonitor" ApplyOnly
configurationModeFrequencyMins	Как часто текущая конфигурация проверяется и применяется в минутах. Это свойство игнорируется, если для свойства ConfigurationMode задано значение ApplyOnly. Значение по умолчанию — 15.	int
перезагрузкаIfNeed	Установите для этого значение true, чтобы автоматически перезагрузить узел после настройки, требующей перезагрузки. В противном случае необходимо вручную перезагрузить узел для любой конфигурации, требующей ее. Значение по умолчанию — false. Чтобы использовать этот параметр при принятии условия перезагрузки, отличном от DSC (например, установщика Windows), объедините этот параметр с модулем xPendingReboot.	bool
refreshFrequencyMins	Интервал времени в минутах, в течение которого LCM проверяет службу извлечения, чтобы получить обновленные конфигурации. Это значение игнорируется, если LCM не настроен в режиме извлечения. Значение по умолчанию — 30.	int

VmssvmInfo

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
виртуальные машины IIS & виртуальной машины SQL Server 2014 развертывание	Создайте веб-серверы Windows 2012 R2 с 1 или 2 IIS и один серверный сервер SQL Server 2014 в виртуальной сети.
виртуальной машине Windows с безопасной базы данных Azure развертывание	Шаблон создает виртуальную машину под управлением Windows Server в новой виртуальной сети с общедоступным IP-адресом. После развертывания компьютера устанавливается расширение гостевой конфигурации и применяется безопасный базовый план Azure для Windows Server. При перемещении конфигурации компьютеров можно повторно применить параметры, развернув шаблон еще раз.

Шаблон

Описание

виртуальные машины IIS & виртуальной машины SQL Server 2014

развертывание

Создайте веб-серверы Windows 2012 R2 с 1 или 2 IIS и один серверный сервер SQL Server 2014 в виртуальной сети.

виртуальной машине Windows с безопасной базы данных Azure

развертывание

Определение ресурса Terraform (поставщик AzAPI)

Используйте свойство parent_id в этом ресурсе, чтобы задать область для этого ресурса.

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.GuestConfiguration/guestConfigurationAssignments, добавьте следующий terraform в шаблон.

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 = [
        {
        }
      ]
    }
  })
}

Значения свойств

guestConfigurationAssignments

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
имя	Имя ресурса	строка (обязательно)
местоположение	Регион, в котором находится виртуальная машина.	струна
parent_id	Идентификатор ресурса для применения этого ресурса расширения.	строка (обязательно)
свойства	Свойства назначения гостевой конфигурации.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Имя	Описание	Ценность
контекст	Источник, инициирующий назначение гостевой конфигурации. Например: политика Azure	струна
guestConfiguration	Назначаемая гостевая конфигурация.	GuestConfigurationNavigation
vmssVMList	Список данных о соответствии виртуальных машин для VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Имя	Описание	Ценность
assignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Аудит" DeployAndAutoCorrect
configurationParameter	Параметры конфигурации гостевой конфигурации.	ConfigurationParameter[]
configurationProtectedParameter	Защищенные параметры конфигурации для гостевой конфигурации.	ConfigurationParameter[]
configurationSetting	Параметр конфигурации для гостевой конфигурации.	ConfigurationSetting
contentHash	Объединенный хэш пакета гостевой конфигурации и параметров конфигурации.	струна
contentUri	Uri хранилища, в котором отправляется пакет гостевой конфигурации.	струна
добрый	Тип гостевой конфигурации. Например:DSC	DSC
имя	Имя гостевой конфигурации.	струна
Версия	Версия гостевой конфигурации.	струна

ConfigurationParameter

Имя	Описание	Ценность
имя	Имя параметра конфигурации.	струна
ценность	Значение параметра конфигурации.	струна

ConfigurationSetting

Имя	Описание	Ценность
actionAfterReboot	Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration	"ContinueConfiguration" StopConfiguration
allowModuleOverwrite	Если значение true — новые конфигурации, скачанные из службы извлечения, могут перезаписать старые конфигурации на целевом узле. В противном случае — значение false	bool
configurationMode	Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Как часто текущая конфигурация проверяется и применяется в минутах. Это свойство игнорируется, если для свойства ConfigurationMode задано значение ApplyOnly. Значение по умолчанию — 15.	int
перезагрузкаIfNeed	Установите для этого значение true, чтобы автоматически перезагрузить узел после настройки, требующей перезагрузки. В противном случае необходимо вручную перезагрузить узел для любой конфигурации, требующей ее. Значение по умолчанию — false. Чтобы использовать этот параметр при принятии условия перезагрузки, отличном от DSC (например, установщика Windows), объедините этот параметр с модулем xPendingReboot.	bool
refreshFrequencyMins	Интервал времени в минутах, в течение которого LCM проверяет службу извлечения, чтобы получить обновленные конфигурации. Это значение игнорируется, если LCM не настроен в режиме извлечения. Значение по умолчанию — 30.	int

VmssvmInfo

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

Поделиться через

Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20

Определение ресурсов Bicep

Формат ресурса

Значения свойств

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

VmssvmInfo

Шаблоны быстрого запуска

Определение ресурса шаблона ARM

Формат ресурса

Значения свойств

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

VmssvmInfo

Шаблоны быстрого запуска

Определение ресурса Terraform (поставщик AzAPI)

Формат ресурса

Значения свойств

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

VmssvmInfo

Обратная связь

Дополнительные ресурсы