Microsoft.GuestConfiguration guestConfigurationAssignments 2020-06-25

• najnowsze
• 2022-01-25
• 2021-01-25
• 2020-06-25
• 2018-11-20
• 2018-06-30-preview
• 2018-01-20-preview

Definicja zasobu Bicep

Typ zasobu guestConfigurationAssignments to zasób rozszerzenia , co oznacza, że można zastosować go do innego zasobu.

Użyj właściwości scope dla tego zasobu, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń wBicep.

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-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: [
      {
      }
    ]
  }
}

Wartości właściwości

guestConfigurationAssignments

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	ciąg (wymagany)
lokalizacja	Region, w którym znajduje się maszyna wirtualna.	struna
zakres	Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia.	Zasób docelowy Dla Bicep ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia .
Właściwości	Właściwości przypisania konfiguracji gościa.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nazwa	Opis	Wartość
kontekst	Źródło, które zainicjowało przypisanie konfiguracji gościa. Na przykład: Azure Policy	struna
guestConfiguration	Konfiguracja gościa do przypisania.	GuestConfigurationNavigation
latestAssignmentReport	Raport ostatniego zgłoszonego przypisania konfiguracji gościa.	AssignmentReport
vmssVMList	Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych	vmssvmInfo[]

GuestConfigurationNavigation

Nazwa	Opis	Wartość
assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Inspekcja" "DeployAndAutoCorrect"
configurationParameter	Parametry konfiguracji dla konfiguracji gościa.	ConfigurationParameter[]
configurationProtectedParameter	Parametry konfiguracji chronionej dla konfiguracji gościa.	ConfigurationParameter[]
configurationSetting	Ustawienie konfiguracji dla konfiguracji gościa.	ConfigurationSetting
contentHash	Połączony skrót pakietu konfiguracji gościa i parametrów konfiguracji.	struna
contentUri	Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa.	struna
rodzaj	Rodzaj konfiguracji gościa. Na przykład:DSC	"DSC"
nazwa	Nazwa konfiguracji gościa.	struna
Wersja	Wersja konfiguracji gościa.	struna

ConfigurationParameter

Nazwa	Opis	Wartość
nazwa	Nazwa parametru konfiguracji.	struna
wartość	Wartość parametru konfiguracji.	struna

ConfigurationSetting

Nazwa	Opis	Wartość
actionAfterReboot	Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration	"KontynuujKonfiguracja" "StopConfiguration"
allowModuleOverwrite	Jeśli wartość true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz	Bool
configurationMode	Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Jak często w minutach bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.	Int
rebootIfNeeded	Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla każdej wymaganej konfiguracji. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego uruchomienia zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.	Bool
refreshFrequencyMins	Interwał czasu w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.	Int

Raport przydziału

Nazwa	Opis	Wartość
przypisanie	Szczegóły konfiguracji przypisania konfiguracji gościa.	AssignmentInfo
zasoby	Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.	AssignmentReportResource[]
Vm	Informacje o maszynie wirtualnej.	VMInfo

Informacje o przydziałach

Nazwa	Opis	Wartość
konfiguracja	Informacje o konfiguracji.	ConfigurationInfo

ConfigurationInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

AssignmentReportResource

Nazwa	Opis	Wartość
Powodów	Przyczyna zgodności i kod przyczyny zasobu.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VMInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VmssvmInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
maszyn wirtualnych usług IIS & maszyn wirtualnych programu SQL Server 2014 wdrażanie	Utwórz 1 lub 2 serwery sieci Web usług IIS Windows 2012 R2 i jeden zaplecze programu SQL Server 2014 w sieci wirtualnej.
maszyny wirtualnej z systemem Windows z bezpiecznym punktem odniesienia platformy Azure wdrażanie	Szablon tworzy maszynę wirtualną z systemem Windows Server w nowej sieci wirtualnej z publicznym adresem IP. Po wdrożeniu maszyny zostanie zainstalowane rozszerzenie konfiguracji gościa i zostanie zastosowany bezpieczny punkt odniesienia platformy Azure dla systemu Windows Server. Jeśli konfiguracja maszyn dryfuje, możesz ponownie zastosować ustawienia, ponownie wdrażając szablon.

Definicja zasobu szablonu usługi ARM

Typ zasobu guestConfigurationAssignments to zasób rozszerzenia , co oznacza, że można zastosować go do innego zasobu.

Użyj właściwości scope dla tego zasobu, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w szablonach usługi ARM.

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2020-06-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": [
      {
      }
    ]
  }
}

Wartości właściwości

guestConfigurationAssignments

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.GuestConfiguration/guestConfigurationAssignments"
apiVersion	Wersja interfejsu API zasobów	'2020-06-25'
nazwa	Nazwa zasobu	ciąg (wymagany)
lokalizacja	Region, w którym znajduje się maszyna wirtualna.	struna
zakres	Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia.	Zasób docelowy W przypadku formatu JSON ustaw wartość na pełną nazwę zasobu, aby zastosować zasobu rozszerzenia .
Właściwości	Właściwości przypisania konfiguracji gościa.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nazwa	Opis	Wartość
kontekst	Źródło, które zainicjowało przypisanie konfiguracji gościa. Na przykład: Azure Policy	struna
guestConfiguration	Konfiguracja gościa do przypisania.	GuestConfigurationNavigation
latestAssignmentReport	Raport ostatniego zgłoszonego przypisania konfiguracji gościa.	AssignmentReport
vmssVMList	Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych	vmssvmInfo[]

GuestConfigurationNavigation

Nazwa	Opis	Wartość
assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Inspekcja" "DeployAndAutoCorrect"
configurationParameter	Parametry konfiguracji dla konfiguracji gościa.	ConfigurationParameter[]
configurationProtectedParameter	Parametry konfiguracji chronionej dla konfiguracji gościa.	ConfigurationParameter[]
configurationSetting	Ustawienie konfiguracji dla konfiguracji gościa.	ConfigurationSetting
contentHash	Połączony skrót pakietu konfiguracji gościa i parametrów konfiguracji.	struna
contentUri	Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa.	struna
rodzaj	Rodzaj konfiguracji gościa. Na przykład:DSC	"DSC"
nazwa	Nazwa konfiguracji gościa.	struna
Wersja	Wersja konfiguracji gościa.	struna

ConfigurationParameter

Nazwa	Opis	Wartość
nazwa	Nazwa parametru konfiguracji.	struna
wartość	Wartość parametru konfiguracji.	struna

ConfigurationSetting

Nazwa	Opis	Wartość
actionAfterReboot	Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration	"KontynuujKonfiguracja" "StopConfiguration"
allowModuleOverwrite	Jeśli wartość true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz	Bool
configurationMode	Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Jak często w minutach bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.	Int
rebootIfNeeded	Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla każdej wymaganej konfiguracji. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego uruchomienia zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.	Bool
refreshFrequencyMins	Interwał czasu w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.	Int

Raport przydziału

Nazwa	Opis	Wartość
przypisanie	Szczegóły konfiguracji przypisania konfiguracji gościa.	AssignmentInfo
zasoby	Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.	AssignmentReportResource[]
Vm	Informacje o maszynie wirtualnej.	VMInfo

Informacje o przydziałach

Nazwa	Opis	Wartość
konfiguracja	Informacje o konfiguracji.	ConfigurationInfo

ConfigurationInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

AssignmentReportResource

Nazwa	Opis	Wartość
Powodów	Przyczyna zgodności i kod przyczyny zasobu.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VMInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VmssvmInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
maszyn wirtualnych usług IIS & maszyn wirtualnych programu SQL Server 2014 wdrażanie	Utwórz 1 lub 2 serwery sieci Web usług IIS Windows 2012 R2 i jeden zaplecze programu SQL Server 2014 w sieci wirtualnej.
maszyny wirtualnej z systemem Windows z bezpiecznym punktem odniesienia platformy Azure wdrażanie	Szablon tworzy maszynę wirtualną z systemem Windows Server w nowej sieci wirtualnej z publicznym adresem IP. Po wdrożeniu maszyny zostanie zainstalowane rozszerzenie konfiguracji gościa i zostanie zastosowany bezpieczny punkt odniesienia platformy Azure dla systemu Windows Server. Jeśli konfiguracja maszyn dryfuje, możesz ponownie zastosować ustawienia, ponownie wdrażając szablon.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu guestConfigurationAssignments to zasób rozszerzenia , co oznacza, że można zastosować go do innego zasobu.

Użyj właściwości parent_id dla tego zasobu, aby ustawić zakres dla tego zasobu.

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-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 = [
        {
        }
      ]
    }
  })
}

Wartości właściwości

guestConfigurationAssignments

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25"
nazwa	Nazwa zasobu	ciąg (wymagany)
lokalizacja	Region, w którym znajduje się maszyna wirtualna.	struna
parent_id	Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia.	ciąg (wymagany)
Właściwości	Właściwości przypisania konfiguracji gościa.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nazwa	Opis	Wartość
kontekst	Źródło, które zainicjowało przypisanie konfiguracji gościa. Na przykład: Azure Policy	struna
guestConfiguration	Konfiguracja gościa do przypisania.	GuestConfigurationNavigation
latestAssignmentReport	Raport ostatniego zgłoszonego przypisania konfiguracji gościa.	AssignmentReport
vmssVMList	Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych	vmssvmInfo[]

GuestConfigurationNavigation

Nazwa	Opis	Wartość
assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "Inspekcja" "DeployAndAutoCorrect"
configurationParameter	Parametry konfiguracji dla konfiguracji gościa.	ConfigurationParameter[]
configurationProtectedParameter	Parametry konfiguracji chronionej dla konfiguracji gościa.	ConfigurationParameter[]
configurationSetting	Ustawienie konfiguracji dla konfiguracji gościa.	ConfigurationSetting
contentHash	Połączony skrót pakietu konfiguracji gościa i parametrów konfiguracji.	struna
contentUri	Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa.	struna
rodzaj	Rodzaj konfiguracji gościa. Na przykład:DSC	"DSC"
nazwa	Nazwa konfiguracji gościa.	struna
Wersja	Wersja konfiguracji gościa.	struna

ConfigurationParameter

Nazwa	Opis	Wartość
nazwa	Nazwa parametru konfiguracji.	struna
wartość	Wartość parametru konfiguracji.	struna

ConfigurationSetting

Nazwa	Opis	Wartość
actionAfterReboot	Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration	"KontynuujKonfigurowanie" "StopConfiguration"
allowModuleOverwrite	Jeśli wartość true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz	Bool
configurationMode	Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.	"ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly"
configurationModeFrequencyMins	Jak często w minutach bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.	Int
rebootIfNeeded	Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla każdej wymaganej konfiguracji. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego uruchomienia zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.	Bool
refreshFrequencyMins	Interwał czasu w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.	Int

Raport przydziału

Nazwa	Opis	Wartość
przypisanie	Szczegóły konfiguracji przypisania konfiguracji gościa.	AssignmentInfo
zasoby	Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.	AssignmentReportResource[]
Vm	Informacje o maszynie wirtualnej.	VMInfo

Informacje o przydziałach

Nazwa	Opis	Wartość
konfiguracja	Informacje o konfiguracji.	ConfigurationInfo

ConfigurationInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

AssignmentReportResource

Nazwa	Opis	Wartość
Powodów	Przyczyna zgodności i kod przyczyny zasobu.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VMInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

VmssvmInfo

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.