Microsoft.GuestConfiguration guestConfigurationAssignments 2020-06-25

Artikel
12/21/2024

Bicep-resursdefinition

Resurstypen guestConfigurationAssignments kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.GuestConfiguration/guestConfigurationAssignments-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25' = {
  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'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {}
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {}
    ]
  }
}

Egenskapsvärden

AssignmentInfo

Namn	Beskrivning	Värde
konfiguration	Information om konfigurationen.	ConfigurationInfo

Tilldelningsrapport

Namn	Beskrivning	Värde
tilldelning	Konfigurationsinformation för gästkonfigurationstilldelningen.	AssignmentInfo
Resurser	Listan över resurser som gästkonfigurationstilldelningsefterlevnad är markerad för.	AssignmentReportResource[]
virtuell dator	Information om den virtuella datorn.	VMInfo

AssignmentReportResource

Namn	Beskrivning	Värde
Skäl	Efterlevnadsorsak och orsakskod för en resurs.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Namn	Beskrivning	Värde

ConfigurationInfo

Namn	Beskrivning	Värde

ConfigurationParameter

Namn	Beskrivning	Värde
Namn	Namnet på konfigurationsparametern.	sträng
värde	Värdet för konfigurationsparametern.	sträng

ConfigurationSetting

Namn	Beskrivning	Värde
actionAfterReboot	Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration	"ContinueConfiguration" "StopConfiguration"
allowModuleOverwrite	Om sant – nya konfigurationer som hämtats från pull-tjänsten tillåts skriva över de gamla på målnoden. Annars falskt	Bool
configurationMode	Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Hur ofta, på några minuter, kontrolleras och tillämpas den aktuella konfigurationen. Den här egenskapen ignoreras om egenskapen ConfigurationMode är inställd på ApplyOnly. Standardvärdet är 15.	Int
rebootIfNeededed	Ställ in detta på true för att automatiskt starta om noden efter att en konfiguration som kräver omstart har tillämpats. Annars måste du starta om noden manuellt för alla konfigurationer som kräver den. Standardvärdet är falskt. Om du vill använda den här inställningen när ett omstartsvillkor utförs av något annat än DSC (till exempel Windows Installer) kombinerar du den här inställningen med modulen xPendingReboot.	Bool
refreshFrequencyMins	Tidsintervallet, i minuter, där LCM kontrollerar en pull-tjänst för att få uppdaterade konfigurationer. Det här värdet ignoreras om LCM inte har konfigurerats i pull-läge. Standardvärdet är 30.	Int

GuestConfigurationAssignmentProperties

Namn	Beskrivning	Värde
sammanhang	Källan som initierade gästkonfigurationstilldelningen. Ex: Azure Policy	sträng
guestConfiguration	Gästkonfigurationen som ska tilldelas.	GuestConfigurationNavigation
latestAssignmentReport	Senast rapporterad rapport om gästkonfigurationstilldelning.	AssignmentReport
vmssVMList	Listan över vm-efterlevnadsdata för VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Namn	Beskrivning	Värde
assignmentType	Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Granskning" "DeployAndAutoCorrect"
configurationParameter	Konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationProtectedParameter	De skyddade konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationSetting	Konfigurationsinställningen för gästkonfigurationen.	ConfigurationSetting
contentHash	Kombinerad hash för gästkonfigurationspaketet och konfigurationsparametrarna.	sträng
contentUri	Uri för lagringen där gästkonfigurationspaketet laddas upp.	sträng
sort	Typ av gästkonfiguration. Till exempel:DSC	"DSC"
Namn	Namnet på gästkonfigurationen.	sträng
version	Version av gästkonfigurationen.	sträng

Microsoft.GuestConfiguration/guestConfigurationAssignments

Namn	Beskrivning	Värde
plats	Region där den virtuella datorn finns.	sträng
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Egenskaper för gästkonfigurationstilldelningen.	GuestConfigurationAssignmentProperties
omfattning	Använd när du skapar en resurs i ett annat omfång än distributionsomfånget.	Ange den här egenskapen till det symboliska namnet på en resurs för att tillämpa -tilläggsresursen.

VMInfo

Namn	Beskrivning	Värde

VmssvmInfo

Namn	Beskrivning	Värde

Användningsexempel

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil	Beskrivning
virtuella IIS-datorer & SQL Server 2014 VM-	Skapa 1 eller 2 IIS Windows 2012 R2-webbservrar och en serverdels SQL Server 2014 i VNET.
virtuell Windows-dator med Säker Azure-baslinje	Mallen skapar en virtuell dator som kör Windows Server i ett nytt virtuellt nätverk med en offentlig IP-adress. När datorn har distribuerats installeras gästkonfigurationstillägget och Azures säkra baslinje för Windows Server tillämpas. Om konfigurationen av datorerna genererar drift kan du tillämpa inställningarna igen genom att distribuera mallen igen.

Resursdefinition för ARM-mall

Resurstypen guestConfigurationAssignments kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.GuestConfiguration/guestConfigurationAssignments-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2020-06-25",
  "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"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {
        }
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {
      }
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Egenskapsvärden

AssignmentInfo

Namn	Beskrivning	Värde
konfiguration	Information om konfigurationen.	ConfigurationInfo

Tilldelningsrapport

Namn	Beskrivning	Värde
tilldelning	Konfigurationsinformation för gästkonfigurationstilldelningen.	AssignmentInfo
Resurser	Listan över resurser som gästkonfigurationstilldelningsefterlevnad är markerad för.	AssignmentReportResource[]
virtuell dator	Information om den virtuella datorn.	VMInfo

AssignmentReportResource

Namn	Beskrivning	Värde
Skäl	Efterlevnadsorsak och orsakskod för en resurs.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Namn	Beskrivning	Värde

ConfigurationInfo

Namn	Beskrivning	Värde

ConfigurationParameter

Namn	Beskrivning	Värde
Namn	Namnet på konfigurationsparametern.	sträng
värde	Värdet för konfigurationsparametern.	sträng

ConfigurationSetting

Namn	Beskrivning	Värde
actionAfterReboot	Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration	"ContinueConfiguration" "StopConfiguration"
allowModuleOverwrite	Om sant – nya konfigurationer som hämtats från pull-tjänsten tillåts skriva över de gamla på målnoden. Annars falskt	Bool
configurationMode	Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Hur ofta, på några minuter, kontrolleras och tillämpas den aktuella konfigurationen. Den här egenskapen ignoreras om egenskapen ConfigurationMode är inställd på ApplyOnly. Standardvärdet är 15.	Int
rebootIfNeededed	Ställ in detta på true för att automatiskt starta om noden efter att en konfiguration som kräver omstart har tillämpats. Annars måste du starta om noden manuellt för alla konfigurationer som kräver den. Standardvärdet är falskt. Om du vill använda den här inställningen när ett omstartsvillkor utförs av något annat än DSC (till exempel Windows Installer) kombinerar du den här inställningen med modulen xPendingReboot.	Bool
refreshFrequencyMins	Tidsintervallet, i minuter, där LCM kontrollerar en pull-tjänst för att få uppdaterade konfigurationer. Det här värdet ignoreras om LCM inte har konfigurerats i pull-läge. Standardvärdet är 30.	Int

GuestConfigurationAssignmentProperties

Namn	Beskrivning	Värde
sammanhang	Källan som initierade gästkonfigurationstilldelningen. Ex: Azure Policy	sträng
guestConfiguration	Gästkonfigurationen som ska tilldelas.	GuestConfigurationNavigation
latestAssignmentReport	Senast rapporterad rapport om gästkonfigurationstilldelning.	AssignmentReport
vmssVMList	Listan över vm-efterlevnadsdata för VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Namn	Beskrivning	Värde
assignmentType	Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Granskning" "DeployAndAutoCorrect"
configurationParameter	Konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationProtectedParameter	De skyddade konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationSetting	Konfigurationsinställningen för gästkonfigurationen.	ConfigurationSetting
contentHash	Kombinerad hash för gästkonfigurationspaketet och konfigurationsparametrarna.	sträng
contentUri	Uri för lagringen där gästkonfigurationspaketet laddas upp.	sträng
sort	Typ av gästkonfiguration. Till exempel:DSC	"DSC"
Namn	Namnet på gästkonfigurationen.	sträng
version	Version av gästkonfigurationen.	sträng

Microsoft.GuestConfiguration/guestConfigurationAssignments

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2020-06-25'
plats	Region där den virtuella datorn finns.	sträng
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Egenskaper för gästkonfigurationstilldelningen.	GuestConfigurationAssignmentProperties
typ	Resurstypen	"Microsoft.GuestConfiguration/guestConfigurationAssignments"

VMInfo

Namn	Beskrivning	Värde

VmssvmInfo

Namn	Beskrivning	Värde

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall	Beskrivning
virtuella IIS-datorer & SQL Server 2014 VM-	Skapa 1 eller 2 IIS Windows 2012 R2-webbservrar och en serverdels SQL Server 2014 i VNET.
virtuell Windows-dator med Säker Azure-baslinje	Mallen skapar en virtuell dator som kör Windows Server i ett nytt virtuellt nätverk med en offentlig IP-adress. När datorn har distribuerats installeras gästkonfigurationstillägget och Azures säkra baslinje för Windows Server tillämpas. Om konfigurationen av datorerna genererar drift kan du tillämpa inställningarna igen genom att distribuera mallen igen.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen guestConfigurationAssignments kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.GuestConfiguration/guestConfigurationAssignments-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25"
  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"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {
          }
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {
        }
      }
      vmssVMList = [
        {
        }
      ]
    }
  }
}

Egenskapsvärden

AssignmentInfo

Namn	Beskrivning	Värde
konfiguration	Information om konfigurationen.	ConfigurationInfo

Tilldelningsrapport

Namn	Beskrivning	Värde
tilldelning	Konfigurationsinformation för gästkonfigurationstilldelningen.	AssignmentInfo
Resurser	Listan över resurser som gästkonfigurationstilldelningsefterlevnad är markerad för.	AssignmentReportResource[]
virtuell dator	Information om den virtuella datorn.	VMInfo

AssignmentReportResource

Namn	Beskrivning	Värde
Skäl	Efterlevnadsorsak och orsakskod för en resurs.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Namn	Beskrivning	Värde

ConfigurationInfo

Namn	Beskrivning	Värde

ConfigurationParameter

Namn	Beskrivning	Värde
Namn	Namnet på konfigurationsparametern.	sträng
värde	Värdet för konfigurationsparametern.	sträng

ConfigurationSetting

Namn	Beskrivning	Värde
actionAfterReboot	Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration	"ContinueConfiguration" "StopConfiguration"
allowModuleOverwrite	Om sant – nya konfigurationer som hämtats från pull-tjänsten tillåts skriva över de gamla på målnoden. Annars falskt	Bool
configurationMode	Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Hur ofta, på några minuter, kontrolleras och tillämpas den aktuella konfigurationen. Den här egenskapen ignoreras om egenskapen ConfigurationMode är inställd på ApplyOnly. Standardvärdet är 15.	Int
rebootIfNeededed	Ställ in detta på true för att automatiskt starta om noden efter att en konfiguration som kräver omstart har tillämpats. Annars måste du starta om noden manuellt för alla konfigurationer som kräver den. Standardvärdet är falskt. Om du vill använda den här inställningen när ett omstartsvillkor utförs av något annat än DSC (till exempel Windows Installer) kombinerar du den här inställningen med modulen xPendingReboot.	Bool
refreshFrequencyMins	Tidsintervallet, i minuter, där LCM kontrollerar en pull-tjänst för att få uppdaterade konfigurationer. Det här värdet ignoreras om LCM inte har konfigurerats i pull-läge. Standardvärdet är 30.	Int

GuestConfigurationAssignmentProperties

Namn	Beskrivning	Värde
sammanhang	Källan som initierade gästkonfigurationstilldelningen. Ex: Azure Policy	sträng
guestConfiguration	Gästkonfigurationen som ska tilldelas.	GuestConfigurationNavigation
latestAssignmentReport	Senast rapporterad rapport om gästkonfigurationstilldelning.	AssignmentReport
vmssVMList	Listan över vm-efterlevnadsdata för VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Namn	Beskrivning	Värde
assignmentType	Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Granskning" "DeployAndAutoCorrect"
configurationParameter	Konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationProtectedParameter	De skyddade konfigurationsparametrarna för gästkonfigurationen.	ConfigurationParameter[]
configurationSetting	Konfigurationsinställningen för gästkonfigurationen.	ConfigurationSetting
contentHash	Kombinerad hash för gästkonfigurationspaketet och konfigurationsparametrarna.	sträng
contentUri	Uri för lagringen där gästkonfigurationspaketet laddas upp.	sträng
sort	Typ av gästkonfiguration. Till exempel:DSC	"DSC"
Namn	Namnet på gästkonfigurationen.	sträng
version	Version av gästkonfigurationen.	sträng

Microsoft.GuestConfiguration/guestConfigurationAssignments

Namn	Beskrivning	Värde
plats	Region där den virtuella datorn finns.	sträng
Namn	Resursnamnet	sträng (krävs)
parent_id	ID:t för resursen som den här tilläggsresursen ska tillämpas på.	sträng (krävs)
Egenskaper	Egenskaper för gästkonfigurationstilldelningen.	GuestConfigurationAssignmentProperties
typ	Resurstypen	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25"

VMInfo

Namn	Beskrivning	Värde

VmssvmInfo

Namn	Beskrivning	Värde

Dela via

Microsoft.GuestConfiguration guestConfigurationAssignments 2020-06-25

Bicep-resursdefinition

Resursformat

Egenskapsvärden

AssignmentInfo

Tilldelningsrapport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Användningsexempel

Azure-snabbstartsexempel

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

AssignmentInfo

Tilldelningsrapport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Användningsexempel

Azure-snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

AssignmentInfo

Tilldelningsrapport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Feedback

Ytterligare resurser