Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20
Bicep-Ressourcendefinition
Der Ressourcentyp "guestConfigurationAssignments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20' = {
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'
}
vmssVMList: [
{}
]
}
}
Eigenschaftswerte
ConfigurationParameter
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Name des Konfigurationsparameters. | Schnur |
| Wert | Wert des Konfigurationsparameters. | Schnur |
ConfigurationSetting
| Name | Beschreibung | Wert |
|---|---|---|
| actionAfterReboot | Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration | 'ContinueConfiguration' "StopConfiguration" |
| allowModuleOverwrite | Wenn "true" – neue Konfigurationen, die vom Pulldienst heruntergeladen wurden, dürfen die alten Konfigurationen auf dem Zielknoten überschrieben werden. Andernfalls "false" | Bool |
| configurationMode | Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "ApplyOnly" |
| configurationModeFrequencyMins | Wie oft in Minuten die aktuelle Konfiguration überprüft und angewendet wird. Diese Eigenschaft wird ignoriert, wenn die ConfigurationMode-Eigenschaft auf ApplyOnly festgelegt ist. Der Standardwert ist 15. | Int |
| rebootIfNeed | Legen Sie diesen Wert auf "true" fest, um den Knoten automatisch neu zu starten, nachdem eine Konfiguration angewendet wurde, für die ein Neustart erforderlich ist. Andernfalls müssen Sie den Knoten für jede konfiguration, für die er erforderlich ist, manuell neu starten. Der Standardwert ist "false". Wenn Sie diese Einstellung verwenden möchten, wenn eine Neustartbedingung von einem anderen Element als DSC (z. B. Windows Installer) ausgeführt wird, kombinieren Sie diese Einstellung mit dem xPendingReboot-Modul. | Bool |
| refreshFrequencyMins | Das Zeitintervall in Minuten, in dem das LCM einen Pulldienst überprüft, um aktualisierte Konfigurationen abzurufen. Dieser Wert wird ignoriert, wenn der LCM nicht im Pullmodus konfiguriert ist. Der Standardwert ist 30. | Int |
GuestConfigurationAssignmentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Zusammenhang | Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure-Richtlinie | Schnur |
| guestConfiguration | Die zuzuweisende Gastkonfiguration. | GuestConfigurationNavigation |
| vmssVMList | Die Liste der VM-Compliancedaten für VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Name | Beschreibung | Wert |
|---|---|---|
| assignmentType | Gibt den Zuordnungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "Überwachung" 'DeployAndAutoCorrect' |
| configurationParameter | Die Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationProtectedParameter | Die geschützten Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationSetting | Die Konfigurationseinstellung für die Gastkonfiguration. | ConfigurationSetting- |
| contentHash | Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. | Schnur |
| contentUri | URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. | Schnur |
| Art | Art der Gastkonfiguration. Beispiel:DSC | "DSC" |
| Name | Name der Gastkonfiguration. | Schnur |
| Version | Version der Gastkonfiguration. | Schnur |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Region, in der sich der virtuelle Computer befindet. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Gastkonfigurationszuweisung. | GuestConfigurationAssignmentProperties |
| Umfang | Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. | Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden. |
VmssvmInfo
| Name | Beschreibung | Wert |
|---|
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| IIS-VMs & SQL Server 2014-VM- | Erstellen Sie 1 oder 2 IIS Windows 2012 R2-Webserver und ein Back-End SQL Server 2014 in VNET. |
| Windows-VM mit azure secure baseline | Die Vorlage erstellt einen virtuellen Computer mit Windows Server in einem neuen virtuellen Netzwerk mit einer öffentlichen IP-Adresse. Sobald der Computer bereitgestellt wurde, wird die Gastkonfigurationserweiterung installiert, und die azure secure baseline für Windows Server wird angewendet. Wenn sich die Konfiguration der Computer bewegt, können Sie die Einstellungen erneut anwenden, indem Sie die Vorlage erneut bereitstellen. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "guestConfigurationAssignments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
"apiVersion": "2018-11-20",
"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"
},
"vmssVMList": [
{
}
]
}
}
Eigenschaftswerte
ConfigurationParameter
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Name des Konfigurationsparameters. | Schnur |
| Wert | Wert des Konfigurationsparameters. | Schnur |
ConfigurationSetting
| Name | Beschreibung | Wert |
|---|---|---|
| actionAfterReboot | Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration | 'ContinueConfiguration' "StopConfiguration" |
| allowModuleOverwrite | Wenn "true" – neue Konfigurationen, die vom Pulldienst heruntergeladen wurden, dürfen die alten Konfigurationen auf dem Zielknoten überschrieben werden. Andernfalls "false" | Bool |
| configurationMode | Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "ApplyOnly" |
| configurationModeFrequencyMins | Wie oft in Minuten die aktuelle Konfiguration überprüft und angewendet wird. Diese Eigenschaft wird ignoriert, wenn die ConfigurationMode-Eigenschaft auf ApplyOnly festgelegt ist. Der Standardwert ist 15. | Int |
| rebootIfNeed | Legen Sie diesen Wert auf "true" fest, um den Knoten automatisch neu zu starten, nachdem eine Konfiguration angewendet wurde, für die ein Neustart erforderlich ist. Andernfalls müssen Sie den Knoten für jede konfiguration, für die er erforderlich ist, manuell neu starten. Der Standardwert ist "false". Wenn Sie diese Einstellung verwenden möchten, wenn eine Neustartbedingung von einem anderen Element als DSC (z. B. Windows Installer) ausgeführt wird, kombinieren Sie diese Einstellung mit dem xPendingReboot-Modul. | Bool |
| refreshFrequencyMins | Das Zeitintervall in Minuten, in dem das LCM einen Pulldienst überprüft, um aktualisierte Konfigurationen abzurufen. Dieser Wert wird ignoriert, wenn der LCM nicht im Pullmodus konfiguriert ist. Der Standardwert ist 30. | Int |
GuestConfigurationAssignmentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Zusammenhang | Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure-Richtlinie | Schnur |
| guestConfiguration | Die zuzuweisende Gastkonfiguration. | GuestConfigurationNavigation |
| vmssVMList | Die Liste der VM-Compliancedaten für VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Name | Beschreibung | Wert |
|---|---|---|
| assignmentType | Gibt den Zuordnungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "Überwachung" 'DeployAndAutoCorrect' |
| configurationParameter | Die Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationProtectedParameter | Die geschützten Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationSetting | Die Konfigurationseinstellung für die Gastkonfiguration. | ConfigurationSetting- |
| contentHash | Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. | Schnur |
| contentUri | URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. | Schnur |
| Art | Art der Gastkonfiguration. Beispiel:DSC | "DSC" |
| Name | Name der Gastkonfiguration. | Schnur |
| Version | Version der Gastkonfiguration. | Schnur |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2018-11-20' |
| Ort | Region, in der sich der virtuelle Computer befindet. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Gastkonfigurationszuweisung. | GuestConfigurationAssignmentProperties |
| Art | Der Ressourcentyp | 'Microsoft.GuestConfiguration/guestConfigurationAssignments' |
VmssvmInfo
| Name | Beschreibung | Wert |
|---|
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
IIS-VMs & SQL Server 2014-VM-
|
Erstellen Sie 1 oder 2 IIS Windows 2012 R2-Webserver und ein Back-End SQL Server 2014 in VNET. |
|
Windows-VM mit azure secure baseline
|
Die Vorlage erstellt einen virtuellen Computer mit Windows Server in einem neuen virtuellen Netzwerk mit einer öffentlichen IP-Adresse. Sobald der Computer bereitgestellt wurde, wird die Gastkonfigurationserweiterung installiert, und die azure secure baseline für Windows Server wird angewendet. Wenn sich die Konfiguration der Computer bewegt, können Sie die Einstellungen erneut anwenden, indem Sie die Vorlage erneut bereitstellen. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "guestConfigurationAssignments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
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"
}
vmssVMList = [
{
}
]
}
})
}
Eigenschaftswerte
ConfigurationParameter
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Name des Konfigurationsparameters. | Schnur |
| Wert | Wert des Konfigurationsparameters. | Schnur |
ConfigurationSetting
| Name | Beschreibung | Wert |
|---|---|---|
| actionAfterReboot | Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration | 'ContinueConfiguration' "StopConfiguration" |
| allowModuleOverwrite | Wenn "true" – neue Konfigurationen, die vom Pulldienst heruntergeladen wurden, dürfen die alten Konfigurationen auf dem Zielknoten überschrieben werden. Andernfalls "false" | Bool |
| configurationMode | Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "ApplyOnly" |
| configurationModeFrequencyMins | Wie oft in Minuten die aktuelle Konfiguration überprüft und angewendet wird. Diese Eigenschaft wird ignoriert, wenn die ConfigurationMode-Eigenschaft auf ApplyOnly festgelegt ist. Der Standardwert ist 15. | Int |
| rebootIfNeed | Legen Sie diesen Wert auf "true" fest, um den Knoten automatisch neu zu starten, nachdem eine Konfiguration angewendet wurde, für die ein Neustart erforderlich ist. Andernfalls müssen Sie den Knoten für jede konfiguration, für die er erforderlich ist, manuell neu starten. Der Standardwert ist "false". Wenn Sie diese Einstellung verwenden möchten, wenn eine Neustartbedingung von einem anderen Element als DSC (z. B. Windows Installer) ausgeführt wird, kombinieren Sie diese Einstellung mit dem xPendingReboot-Modul. | Bool |
| refreshFrequencyMins | Das Zeitintervall in Minuten, in dem das LCM einen Pulldienst überprüft, um aktualisierte Konfigurationen abzurufen. Dieser Wert wird ignoriert, wenn der LCM nicht im Pullmodus konfiguriert ist. Der Standardwert ist 30. | Int |
GuestConfigurationAssignmentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Zusammenhang | Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure-Richtlinie | Schnur |
| guestConfiguration | Die zuzuweisende Gastkonfiguration. | GuestConfigurationNavigation |
| vmssVMList | Die Liste der VM-Compliancedaten für VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Name | Beschreibung | Wert |
|---|---|---|
| assignmentType | Gibt den Zuordnungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' "Überwachung" 'DeployAndAutoCorrect' |
| configurationParameter | Die Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationProtectedParameter | Die geschützten Konfigurationsparameter für die Gastkonfiguration. | ConfigurationParameter-[] |
| configurationSetting | Die Konfigurationseinstellung für die Gastkonfiguration. | ConfigurationSetting- |
| contentHash | Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. | Schnur |
| contentUri | URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. | Schnur |
| Art | Art der Gastkonfiguration. Beispiel:DSC | "DSC" |
| Name | Name der Gastkonfiguration. | Schnur |
| Version | Version der Gastkonfiguration. | Schnur |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Region, in der sich der virtuelle Computer befindet. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Gastkonfigurationszuweisung. | GuestConfigurationAssignmentProperties |
| Art | Der Ressourcentyp | "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20" |
VmssvmInfo
| Name | Beschreibung | Wert |
|---|