Microsoft.GuestConfiguration guestConfigurationAssignments

Bicep-Ressourcendefinition

Der Ressourcentyp guestConfigurationAssignments ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in Bicep.

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-01-25' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      contentHash: 'string'
      contentUri: 'string'
      kind: 'DSC'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {
            }
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {
      }
    ]
  }
}

Eigenschaftswerte

guestConfigurationAssignments

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)
location Region, in der sich die VM befindet. Zeichenfolge
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. Zielressource

Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden.
properties Eigenschaften der Gastkonfigurationszuweisung. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Name BESCHREIBUNG Wert
context Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure Policy Zeichenfolge
guestConfiguration Die zuzuweisende Gastkonfiguration. GuestConfigurationNavigation
latestAssignmentReport Zuletzt gemeldeter Gastkonfigurationszuweisungsbericht. AssignmentReport
vmssVMList Die Liste der VM-Konformitätsdaten für VMSS VmssvmInfo[]

GuestConfigurationNavigation

Name BESCHREIBUNG Wert
assignmentType Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Überwachung"
"DeployAndAutoCorrect"
configurationParameter Die Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
configurationProtectedParameter Die geschützten Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
contentHash Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. Zeichenfolge
contentUri URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. Zeichenfolge
kind Art der Gastkonfiguration. Beispiel:DSC "DSC"
name Name der Gastkonfiguration. Zeichenfolge
Version Version der Gastkonfiguration. Zeichenfolge

ConfigurationParameter

Name BESCHREIBUNG Wert
name Name des Konfigurationsparameters. Zeichenfolge
value Wert des Konfigurationsparameters. Zeichenfolge

AssignmentReport

Name BESCHREIBUNG Wert
Zuweisung Konfigurationsdetails der Gastkonfigurationszuweisung. AssignmentInfo
ressourcen Die Liste der Ressourcen, für die die Compliance der Gastkonfigurationszuweisung überprüft wird. AssignmentReportResource[]
vm Informationen zur VM. VMInfo

AssignmentInfo

Name BESCHREIBUNG Wert
Konfiguration Informationen zur Konfiguration. ConfigurationInfo

ConfigurationInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

AssignmentReportResource

Name BESCHREIBUNG Wert
Gründe Compliance-Grund- und -Grundcode für eine Ressource. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VMInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VmssvmInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

Schnellstartvorlagen

Mit den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Windows-VM mit sicherer Azure-Baseline

In Azure bereitstellen
Die Vorlage erstellt einen virtuellen Computer mit Windows Server in einem neuen virtuellen Netzwerk mit einer öffentlichen IP-Adresse. Nachdem der Computer bereitgestellt wurde, wird die Gastkonfigurationserweiterung installiert, und die Azure Secure Baseline für Windows Server wird angewendet. Wenn die Konfiguration der Computer driftet, können Sie die Einstellungen erneut anwenden, indem Sie die Vorlage erneut bereitstellen.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp guestConfigurationAssignments ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in ARM-Vorlagen.

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2022-01-25",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "contentHash": "string",
      "contentUri": "string",
      "kind": "DSC",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {}
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {}
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Eigenschaftswerte

guestConfigurationAssignments

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.GuestConfiguration/guestConfigurationAssignments"
apiVersion Die Version der Ressourcen-API '2022-01-25'
name Der Ressourcenname Zeichenfolge (erforderlich)
location Region, in der sich die VM befindet. Zeichenfolge
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. Zielressource

Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll.
properties Eigenschaften der Gastkonfigurationszuweisung. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Name BESCHREIBUNG Wert
context Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure Policy Zeichenfolge
guestConfiguration Die zuzuweisende Gastkonfiguration. GuestConfigurationNavigation
latestAssignmentReport Zuletzt gemeldeter Gastkonfigurationszuweisungsbericht. AssignmentReport
vmssVMList Die Liste der VM-Compliancedaten für VMSS VmssvmInfo[]

GuestConfigurationNavigation

Name BESCHREIBUNG Wert
assignmentType Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Überwachung"
"DeployAndAutoCorrect"
configurationParameter Die Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
configurationProtectedParameter Die geschützten Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
contentHash Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. Zeichenfolge
contentUri URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. Zeichenfolge
kind Art der Gastkonfiguration. Beispiel:DSC "DSC"
name Name der Gastkonfiguration. Zeichenfolge
Version Version der Gastkonfiguration. Zeichenfolge

ConfigurationParameter

Name BESCHREIBUNG Wert
name Name des Konfigurationsparameters. Zeichenfolge
value Wert des Konfigurationsparameters. Zeichenfolge

AssignmentReport

Name BESCHREIBUNG Wert
Zuweisung Konfigurationsdetails der Gastkonfigurationszuweisung. AssignmentInfo
ressourcen Die Liste der Ressourcen, für die die Konformität der Gastkonfigurationszuweisung überprüft wird. AssignmentReportResource[]
vm Informationen zur VM. VMInfo

AssignmentInfo

Name BESCHREIBUNG Wert
Konfiguration Informationen zur Konfiguration. ConfigurationInfo

ConfigurationInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

AssignmentReportResource

Name BESCHREIBUNG Wert
Gründe Konformitätsgrund und -grundcode für eine Ressource. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VMInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VmssvmInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Windows-VM mit Azure Secure Baseline

In Azure bereitstellen
Die Vorlage erstellt einen virtuellen Computer, auf dem Windows Server ausgeführt wird, in einem neuen virtuellen Netzwerk mit einer öffentlichen IP-Adresse. Nachdem der Computer bereitgestellt wurde, wird die Gastkonfigurationserweiterung installiert, und die sichere Azure-Baseline für Windows Server wird angewendet. Wenn die Konfiguration der Computer abweicht, können Sie die Einstellungen erneut anwenden, indem Sie die Vorlage erneut bereitstellen.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp guestConfigurationAssignments ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die parent_id -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen.

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.GuestConfiguration/guestConfigurationAssignments-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-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"
          }
        ]
        contentHash = "string"
        contentUri = "string"
        kind = "DSC"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {}
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {}
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Eigenschaftswerte

guestConfigurationAssignments

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-01-25"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Region, in der sich die VM befindet. Zeichenfolge
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
properties Eigenschaften der Gastkonfigurationszuweisung. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Name BESCHREIBUNG Wert
context Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure Policy Zeichenfolge
guestConfiguration Die zuzuweisende Gastkonfiguration. GuestConfigurationNavigation
latestAssignmentReport Zuletzt gemeldeter Gastkonfigurationszuweisungsbericht. AssignmentReport
vmssVMList Die Liste der VM-Konformitätsdaten für VMSS VmssvmInfo[]

GuestConfigurationNavigation

Name BESCHREIBUNG Wert
assignmentType Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Audit"
"DeployAndAutoCorrect"
configurationParameter Die Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
configurationProtectedParameter Die geschützten Konfigurationsparameter für die Gastkonfiguration. ConfigurationParameter[]
contentHash Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter. Zeichenfolge
contentUri URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird. Zeichenfolge
kind Art der Gastkonfiguration. Beispiel:DSC "DSC"
name Name der Gastkonfiguration. Zeichenfolge
Version Version der Gastkonfiguration. Zeichenfolge

ConfigurationParameter

Name BESCHREIBUNG Wert
name Name des Konfigurationsparameters. Zeichenfolge
value Wert des Konfigurationsparameters. Zeichenfolge

AssignmentReport

Name BESCHREIBUNG Wert
Zuweisung Konfigurationsdetails der Gastkonfigurationszuweisung. AssignmentInfo
ressourcen Die Liste der Ressourcen, für die die Konformität der Gastkonfigurationszuweisung überprüft wird. AssignmentReportResource[]
vm Informationen zur VM. VMInfo

AssignmentInfo

Name BESCHREIBUNG Wert
Konfiguration Informationen zur Konfiguration. ConfigurationInfo

ConfigurationInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

AssignmentReportResource

Name BESCHREIBUNG Wert
Gründe Konformitätsgrund und -grundcode für eine Ressource. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VMInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

VmssvmInfo

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.