Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20
Bicep-resourcedefinitie
Het resourcetype guestConfigurationAssignments kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.GuestConfiguration/guestConfigurationAssignments wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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: [
{}
]
}
}
Eigenschapswaarden
ConfigurationParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Naam van de configuratieparameter. | snaar |
| waarde | Waarde van de configuratieparameter. | snaar |
ConfigurationSetting
| Naam | Beschrijving | Waarde |
|---|---|---|
| actionAfterReboot | Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration | ContinueConfiguration 'StopConfiguration' |
| allowModuleOverwrite | Indien waar: nieuwe configuraties die zijn gedownload van de pull-service, mogen de oude configuraties op het doelknooppunt overschrijven. Anders, onwaar | Bool |
| configurationMode | Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
| configurationModeFrequencyMins | Hoe vaak, in minuten, de huidige configuratie wordt gecontroleerd en toegepast. Deze eigenschap wordt genegeerd als de eigenschap ConfigurationMode is ingesteld op ApplyOnly. De standaardwaarde is 15. | Int |
| rebootIfNeeded | Stel dit in op True om het knooppunt automatisch opnieuw op te starten nadat een configuratie waarvoor opnieuw opstarten is vereist, is toegepast. Anders moet u het knooppunt handmatig opnieuw opstarten voor elke configuratie die dit vereist. De standaardwaarde is onwaar. Als u deze instelling wilt gebruiken wanneer een voorwaarde voor opnieuw opstarten wordt uitgevoerd door iets anders dan DSC (zoals Windows Installer), combineert u deze instelling met de xPendingReboot-module. | Bool |
| refreshFrequencyMins | Het tijdsinterval, in minuten, waarmee de LCM een pull-service controleert om bijgewerkte configuraties op te halen. Deze waarde wordt genegeerd als de LCM niet is geconfigureerd in de pull-modus. De standaardwaarde is 30. | Int |
GuestConfigurationAssignmentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| context | De bron waarmee de toewijzing van de gastconfiguratie is gestart. Bijvoorbeeld: Azure Policy | snaar |
| guestConfiguration | De gastconfiguratie die moet worden toegewezen. | GuestConfigurationNavigation |
| vmssVMList | De lijst met VM-nalevingsgegevens voor VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Naam | Beschrijving | Waarde |
|---|---|---|
| assignmentType | Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Controle' 'DeployAndAutoCorrect' |
| configurationParameter | De configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationProtectedParameter | De beveiligde configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationSetting | De configuratie-instelling voor de gastconfiguratie. | ConfigurationSetting- |
| contentHash | Gecombineerde hash van het gastconfiguratiepakket en configuratieparameters. | snaar |
| contentUri | Uri van de opslag waar het gastconfiguratiepakket wordt geüpload. | snaar |
| soort | Soort gastconfiguratie. Bijvoorbeeld: DSC | DSC |
| naam | Naam van de gastconfiguratie. | snaar |
| Versie | Versie van de gastconfiguratie. | snaar |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Naam | Beschrijving | Waarde |
|---|---|---|
| plaats | Regio waar de VIRTUELE machine zich bevindt. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van de toewijzing van de gastconfiguratie. | GuestConfigurationAssignmentProperties- |
| draagwijdte | Gebruik deze functie bij het maken van een resource in een bereik dat anders is dan het implementatiebereik. | Stel deze eigenschap in op de symbolische naam van een resource om de extensieresource toe te passen. |
VmssvmInfo
| Naam | Beschrijving | Waarde |
|---|
Gebruiksvoorbeelden
Azure-snelstartvoorbeelden
De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.
| Bicep-bestand | Beschrijving |
|---|---|
| VIRTUELE IIS-machines & SQL Server 2014-VM's | Maak 1 of 2 IIS Windows 2012 R2 Webservers en één back-end SQL Server 2014 in VNET. |
| Windows-VM met beveiligde basislijn van Azure | De sjabloon maakt een virtuele machine met Windows Server in een nieuw virtueel netwerk, met een openbaar IP-adres. Zodra de machine is geïmplementeerd, wordt de gastconfiguratie-extensie geïnstalleerd en wordt de beveiligde basislijn van Azure voor Windows Server toegepast. Als de configuratie van de machines afdrijdt, kunt u de instellingen opnieuw toepassen door de sjabloon opnieuw te implementeren. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype guestConfigurationAssignments kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.GuestConfiguration/guestConfigurationAssignments-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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": [
{
}
]
}
}
Eigenschapswaarden
ConfigurationParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Naam van de configuratieparameter. | snaar |
| waarde | Waarde van de configuratieparameter. | snaar |
ConfigurationSetting
| Naam | Beschrijving | Waarde |
|---|---|---|
| actionAfterReboot | Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration | ContinueConfiguration 'StopConfiguration' |
| allowModuleOverwrite | Indien waar: nieuwe configuraties die zijn gedownload van de pull-service, mogen de oude configuraties op het doelknooppunt overschrijven. Anders, onwaar | Bool |
| configurationMode | Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
| configurationModeFrequencyMins | Hoe vaak, in minuten, de huidige configuratie wordt gecontroleerd en toegepast. Deze eigenschap wordt genegeerd als de eigenschap ConfigurationMode is ingesteld op ApplyOnly. De standaardwaarde is 15. | Int |
| rebootIfNeeded | Stel dit in op True om het knooppunt automatisch opnieuw op te starten nadat een configuratie waarvoor opnieuw opstarten is vereist, is toegepast. Anders moet u het knooppunt handmatig opnieuw opstarten voor elke configuratie die dit vereist. De standaardwaarde is onwaar. Als u deze instelling wilt gebruiken wanneer een voorwaarde voor opnieuw opstarten wordt uitgevoerd door iets anders dan DSC (zoals Windows Installer), combineert u deze instelling met de xPendingReboot-module. | Bool |
| refreshFrequencyMins | Het tijdsinterval, in minuten, waarmee de LCM een pull-service controleert om bijgewerkte configuraties op te halen. Deze waarde wordt genegeerd als de LCM niet is geconfigureerd in de pull-modus. De standaardwaarde is 30. | Int |
GuestConfigurationAssignmentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| context | De bron waarmee de toewijzing van de gastconfiguratie is gestart. Bijvoorbeeld: Azure Policy | snaar |
| guestConfiguration | De gastconfiguratie die moet worden toegewezen. | GuestConfigurationNavigation |
| vmssVMList | De lijst met VM-nalevingsgegevens voor VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Naam | Beschrijving | Waarde |
|---|---|---|
| assignmentType | Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Controle' 'DeployAndAutoCorrect' |
| configurationParameter | De configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationProtectedParameter | De beveiligde configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationSetting | De configuratie-instelling voor de gastconfiguratie. | ConfigurationSetting- |
| contentHash | Gecombineerde hash van het gastconfiguratiepakket en configuratieparameters. | snaar |
| contentUri | Uri van de opslag waar het gastconfiguratiepakket wordt geüpload. | snaar |
| soort | Soort gastconfiguratie. Bijvoorbeeld: DSC | DSC |
| naam | Naam van de gastconfiguratie. | snaar |
| Versie | Versie van de gastconfiguratie. | snaar |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2018-11-20' |
| plaats | Regio waar de VIRTUELE machine zich bevindt. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van de toewijzing van de gastconfiguratie. | GuestConfigurationAssignmentProperties- |
| type | Het resourcetype | 'Microsoft.GuestConfiguration/guestConfigurationAssignments' |
VmssvmInfo
| Naam | Beschrijving | Waarde |
|---|
Gebruiksvoorbeelden
Azure-snelstartsjablonen
De volgende Azure-quickstartsjablonen dit resourcetype implementeren.
| Sjabloon | Beschrijving |
|---|---|
VIRTUELE IIS-machines & SQL Server 2014-VM's
|
Maak 1 of 2 IIS Windows 2012 R2 Webservers en één back-end SQL Server 2014 in VNET. |
|
Windows-VM met beveiligde basislijn van Azure
|
De sjabloon maakt een virtuele machine met Windows Server in een nieuw virtueel netwerk, met een openbaar IP-adres. Zodra de machine is geïmplementeerd, wordt de gastconfiguratie-extensie geïnstalleerd en wordt de beveiligde basislijn van Azure voor Windows Server toegepast. Als de configuratie van de machines afdrijdt, kunt u de instellingen opnieuw toepassen door de sjabloon opnieuw te implementeren. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype guestConfigurationAssignments kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.GuestConfiguration/guestConfigurationAssignments-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
name = "string"
parent_id = "string"
location = "string"
body = {
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 = [
{
}
]
}
}
}
Eigenschapswaarden
ConfigurationParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Naam van de configuratieparameter. | snaar |
| waarde | Waarde van de configuratieparameter. | snaar |
ConfigurationSetting
| Naam | Beschrijving | Waarde |
|---|---|---|
| actionAfterReboot | Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration | ContinueConfiguration 'StopConfiguration' |
| allowModuleOverwrite | Indien waar: nieuwe configuraties die zijn gedownload van de pull-service, mogen de oude configuraties op het doelknooppunt overschrijven. Anders, onwaar | Bool |
| configurationMode | Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
| configurationModeFrequencyMins | Hoe vaak, in minuten, de huidige configuratie wordt gecontroleerd en toegepast. Deze eigenschap wordt genegeerd als de eigenschap ConfigurationMode is ingesteld op ApplyOnly. De standaardwaarde is 15. | Int |
| rebootIfNeeded | Stel dit in op True om het knooppunt automatisch opnieuw op te starten nadat een configuratie waarvoor opnieuw opstarten is vereist, is toegepast. Anders moet u het knooppunt handmatig opnieuw opstarten voor elke configuratie die dit vereist. De standaardwaarde is onwaar. Als u deze instelling wilt gebruiken wanneer een voorwaarde voor opnieuw opstarten wordt uitgevoerd door iets anders dan DSC (zoals Windows Installer), combineert u deze instelling met de xPendingReboot-module. | Bool |
| refreshFrequencyMins | Het tijdsinterval, in minuten, waarmee de LCM een pull-service controleert om bijgewerkte configuraties op te halen. Deze waarde wordt genegeerd als de LCM niet is geconfigureerd in de pull-modus. De standaardwaarde is 30. | Int |
GuestConfigurationAssignmentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| context | De bron waarmee de toewijzing van de gastconfiguratie is gestart. Bijvoorbeeld: Azure Policy | snaar |
| guestConfiguration | De gastconfiguratie die moet worden toegewezen. | GuestConfigurationNavigation |
| vmssVMList | De lijst met VM-nalevingsgegevens voor VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Naam | Beschrijving | Waarde |
|---|---|---|
| assignmentType | Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Controle' 'DeployAndAutoCorrect' |
| configurationParameter | De configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationProtectedParameter | De beveiligde configuratieparameters voor de gastconfiguratie. | ConfigurationParameter[] |
| configurationSetting | De configuratie-instelling voor de gastconfiguratie. | ConfigurationSetting- |
| contentHash | Gecombineerde hash van het gastconfiguratiepakket en configuratieparameters. | snaar |
| contentUri | Uri van de opslag waar het gastconfiguratiepakket wordt geüpload. | snaar |
| soort | Soort gastconfiguratie. Bijvoorbeeld: DSC | DSC |
| naam | Naam van de gastconfiguratie. | snaar |
| Versie | Versie van de gastconfiguratie. | snaar |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Naam | Beschrijving | Waarde |
|---|---|---|
| plaats | Regio waar de VIRTUELE machine zich bevindt. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| parent_id | De id van de resource waar deze extensieresource op moet worden toegepast. | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van de toewijzing van de gastconfiguratie. | GuestConfigurationAssignmentProperties- |
| type | Het resourcetype | "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20" |
VmssvmInfo
| Naam | Beschrijving | Waarde |
|---|