Microsoft.GuestConfiguration guestConfigurationAssignments 2018-06-30-preview
Definicja zasobu Bicep
Typ zasobu guestConfigurationAssignments można wdrożyć przy użyciu operacji docelowych:
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@2018-06-30-preview' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
context: 'string'
guestConfiguration: {
configurationParameter: [
{}
]
configurationSetting: {
actionAfterReboot: 'string'
allowModuleOverwrite: bool
configurationMode: 'string'
configurationModeFrequencyMins: int
rebootIfNeeded: bool
refreshFrequencyMins: int
}
kind: 'string'
name: 'string'
version: 'string'
}
}
}
Wartości właściwości
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|
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 |
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 |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| configurationParameter | Parametry konfiguracji dla konfiguracji gościa. | ConfigurationParameter[] |
| configurationSetting | Ustawienie konfiguracji dla konfiguracji gościa. | ConfigurationSetting |
| rodzaj | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| nazwa | Nazwa konfiguracji gościa. | struna |
| Wersja | Wersja konfiguracji gościa. | struna |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Nazwa | Opis | Wartość |
|---|---|---|
| lokalizacja | Region, w którym znajduje się maszyna wirtualna. | struna |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| Właściwości | Właściwości przypisania konfiguracji gościa. | GuestConfigurationAssignmentProperties |
| zakres | Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. | Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia . |
Przykłady użycia
Przykłady szybkiego startu platformy Azure
Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.
| Plik Bicep | Opis |
|---|---|
| maszyn wirtualnych usług IIS & maszyn wirtualnych programu SQL Server 2014 | 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 | 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 można wdrożyć przy użyciu operacji docelowych:
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": "2018-06-30-preview",
"name": "string",
"location": "string",
"properties": {
"context": "string",
"guestConfiguration": {
"configurationParameter": [
{
}
],
"configurationSetting": {
"actionAfterReboot": "string",
"allowModuleOverwrite": "bool",
"configurationMode": "string",
"configurationModeFrequencyMins": "int",
"rebootIfNeeded": "bool",
"refreshFrequencyMins": "int"
},
"kind": "string",
"name": "string",
"version": "string"
}
}
}
Wartości właściwości
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|
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 |
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 |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| configurationParameter | Parametry konfiguracji dla konfiguracji gościa. | ConfigurationParameter[] |
| configurationSetting | Ustawienie konfiguracji dla konfiguracji gościa. | ConfigurationSetting |
| rodzaj | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| nazwa | Nazwa konfiguracji gościa. | struna |
| Wersja | Wersja konfiguracji gościa. | struna |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2018-06-30-preview" |
| lokalizacja | Region, w którym znajduje się maszyna wirtualna. | struna |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| Właściwości | Właściwości przypisania konfiguracji gościa. | GuestConfigurationAssignmentProperties |
| typ | Typ zasobu | "Microsoft.GuestConfiguration/guestConfigurationAssignments" |
Przykłady użycia
Szablony szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure wdrożyć 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 można wdrożyć przy użyciu operacji docelowych:
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@2018-06-30-preview"
name = "string"
parent_id = "string"
location = "string"
body = jsonencode({
properties = {
context = "string"
guestConfiguration = {
configurationParameter = [
{
}
]
configurationSetting = {
actionAfterReboot = "string"
allowModuleOverwrite = bool
configurationMode = "string"
configurationModeFrequencyMins = int
rebootIfNeeded = bool
refreshFrequencyMins = int
}
kind = "string"
name = "string"
version = "string"
}
}
})
}
Wartości właściwości
ConfigurationParameter
| Nazwa | Opis | Wartość |
|---|
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 |
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 |
GuestConfigurationNavigation
| Nazwa | Opis | Wartość |
|---|---|---|
| configurationParameter | Parametry konfiguracji dla konfiguracji gościa. | ConfigurationParameter[] |
| configurationSetting | Ustawienie konfiguracji dla konfiguracji gościa. | ConfigurationSetting |
| rodzaj | Rodzaj konfiguracji gościa. Na przykład:DSC | "DSC" |
| nazwa | Nazwa konfiguracji gościa. | struna |
| Wersja | Wersja konfiguracji gościa. | struna |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| Nazwa | Opis | Wartość |
|---|---|---|
| lokalizacja | Region, w którym znajduje się maszyna wirtualna. | struna |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| 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 |
| typ | Typ zasobu | "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview" |