Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25
Definicja zasobu Bicep
Typ zasobu guestConfigurationAssignments to zasób rozszerzenia, co oznacza, że można go zastosować do innego zasobu.
scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w aplikacji Bicep.
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-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ść |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Region, w którym znajduje się maszyna wirtualna. | ciąg |
| scope | 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. |
| properties | 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 | ciąg |
| guestConfiguration | Konfiguracja gościa do przypisania. | GuestConfigurationNavigation |
| latestAssignmentReport | Ostatni raport dotyczący przypisania konfiguracji gościa. | Raport przydziału |
| vmssVMList | Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych | VmssvmInfo[] |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| typ przypisania | 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. | ciąg |
| contentUri | Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa. | ciąg |
| Rodzaju | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| name | Nazwa konfiguracji gościa. | ciąg |
| Wersja | Wersja konfiguracji gościa. | ciąg |
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa parametru konfiguracji. | ciąg |
| wartość | Wartość parametru konfiguracji. | ciąg |
ConfigurationSetting
| Nazwa | Opis | Wartość |
|---|---|---|
| actionAfterReboot | Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration | "ContinueConfiguration" "StopConfiguration" |
| allowModuleOverwrite | W przypadku wartości true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare konfiguracje w węźle docelowym. W przeciwnym razie wartość false | bool |
| configurationMode | Określa sposób, w jaki LCM (Configuration Manager lokalne) 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 rozruchu zostanie uchwalony przez coś innego niż DSC (na przykład 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 w celu uzyskania zaktualizowanych konfiguracji. Ta wartość jest ignorowana, jeśli narzędzie LCM nie jest skonfigurowane w trybie ściągania. Wartość domyślna to 30. | int |
Raport przydziału
| Nazwa | Opis | Wartość |
|---|---|---|
| Przypisania | Szczegóły konfiguracji przypisania konfiguracji gościa. | Informacje o przydziałach |
| 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.
PrzypisaniaRaportResource
| 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.
| Template | Opis |
|---|---|
Maszyna wirtualna z systemem Windows z bezpiecznym punktem odniesienia platformy Azure |
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 go zastosować do innego zasobu.
scope Użyj właściwości w tym zasobie, 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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
"apiVersion": "2021-01-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 | '2021-01-25' |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Region, w którym znajduje się maszyna wirtualna. | ciąg |
| scope | 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ć zasób rozszerzenia do. |
| properties | 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 | ciąg |
| guestConfiguration | Konfiguracja gościa do przypisania. | GuestConfigurationNavigation |
| latestAssignmentReport | Ostatni raport dotyczący przypisania konfiguracji gościa. | Raport przydziału |
| vmssVMList | Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych | VmssvmInfo[] |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| typ przypisania | 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. | ciąg |
| contentUri | Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa. | ciąg |
| Rodzaju | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| name | Nazwa konfiguracji gościa. | ciąg |
| Wersja | Wersja konfiguracji gościa. | ciąg |
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa parametru konfiguracji. | ciąg |
| wartość | Wartość parametru konfiguracji. | ciąg |
ConfigurationSetting
| Nazwa | Opis | Wartość |
|---|---|---|
| actionAfterReboot | Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration | "ContinueConfiguration" "StopConfiguration" |
| allowModuleOverwrite | W przypadku wartości true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare konfiguracje w węźle docelowym. W przeciwnym razie wartość false | bool |
| configurationMode | Określa sposób, w jaki LCM (Configuration Manager lokalne) 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 dowolnej konfiguracji, która jej wymaga. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego rozruchu 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ść |
|---|---|---|
| Przypisania | Szczegóły konfiguracji przypisania konfiguracji gościa. | PrzypisaniaInfo |
| zasoby | Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa. | AssignmentReportResource[] |
| vm | Informacje o maszynie wirtualnej. | VMInfo |
PrzypisaniaInfo
| 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.
| Template | Opis |
|---|---|
| Maszyna wirtualna z systemem Windows z bezpiecznym punktem odniesienia platformy Azure |
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 go zastosować do innego zasobu.
parent_id Użyj właściwości tego zasobu, aby ustawić zakres dla tego zasobu.
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.GuestConfiguration/guestConfigurationAssignments, dodaj następujące narzędzie Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-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@2021-01-25" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Region, w którym znajduje się maszyna wirtualna. | ciąg |
| parent_id | Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. | ciąg (wymagany) |
| properties | 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 | ciąg |
| guestConfiguration | Konfiguracja gościa do przypisania. | GuestConfigurationNavigation |
| latestAssignmentReport | Ostatni raport dotyczący przypisania konfiguracji gościa. | Raport przydziału |
| vmssVMList | Lista danych zgodności maszyn wirtualnych dla usługi VMSS | VmssvmInfo[] |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| assignmentType | Określa typ przypisania i wykonanie 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. | ciąg |
| contentUri | Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa. | ciąg |
| Rodzaju | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| name | Nazwa konfiguracji gościa. | ciąg |
| Wersja | Wersja konfiguracji gościa. | ciąg |
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa parametru konfiguracji. | ciąg |
| wartość | Wartość parametru konfiguracji. | ciąg |
ConfigurationSetting
| Nazwa | Opis | Wartość |
|---|---|---|
| actionAfterReboot | Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration | "Kontynuujkonfigurowanie" "StopConfiguration" |
| allowModuleOverwrite | Jeśli prawda — 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, w jaki sposób LCM(lokalna 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 dowolnej konfiguracji, która jej wymaga. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego rozruchu 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ść |
|---|---|---|
| Przypisania | Szczegóły konfiguracji przypisania konfiguracji gościa. | PrzypisaniaInfo |
| zasoby | Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa. | AssignmentReportResource[] |
| vm | Informacje o maszynie wirtualnej. | VMInfo |
PrzypisaniaInfo
| 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.
PrzypisaniaRaportResource
| 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.
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla