Microsoft.GuestConfiguration GuestConfigurationAssignments 2020-06-25

Article
10/19/2024

Définition de ressource Bicep

Le type de ressource guestConfigurationAssignments est une ressource d’extension , ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la propriété scope sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue sur les ressources d’extension dans Bicep.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le bicep suivant à votre modèle.

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: [
      {
      }
    ]
  }
}

Valeurs de propriété

guestConfigurationAssignments

Nom	Description	Valeur
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Région où se trouve la machine virtuelle.	corde
portée	Utilisez-la lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement.	Ressource cible Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension .
Propriétés	Propriétés de l’affectation de configuration d’invité.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nom	Description	Valeur
contexte	Source qui a lancé l’attribution de configuration d’invité. Ex : Azure Policy	corde
guestConfiguration	Configuration d’invité à attribuer.	GuestConfigurationNavigation
latestAssignmentReport	Dernier rapport d’affectation de configuration invité signalé.	AssignmentReport
vmssVMList	Liste des données de conformité des machines virtuelles pour VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Nom	Description	Valeur
assignmentType	Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	Paramètres de configuration de la configuration invité.	ConfigurationParameter[]
configurationProtectedParameter	Paramètres de configuration protégés pour la configuration d’invité.	ConfigurationParameter[]
configurationSetting	Paramètre de configuration de la configuration de l’invité.	ConfigurationSetting
contentHash	Hachage combiné du package de configuration invité et des paramètres de configuration.	corde
contentUri	URI du stockage où le package de configuration invité est chargé.	corde
gentil	Type de configuration d’invité. Par exemple :DSC	'DSC'
nom	Nom de la configuration d’invité.	corde
Version	Version de la configuration d’invité.	corde

ConfigurationParameter

Nom	Description	Valeur
nom	Nom du paramètre de configuration.	corde
valeur	Valeur du paramètre de configuration.	corde

ConfigurationSetting

Nom	Description	Valeur
actionAfterReboot	Spécifie ce qui se passe après un redémarrage pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration	'ContinueConfiguration' 'StopConfiguration'
allowModuleOverwrite	Si la valeur est true , les nouvelles configurations téléchargées à partir du service pull sont autorisées à remplacer les anciennes configurations sur le nœud cible. Sinon, false	Bool
configurationMode	Spécifie comment le gestionnaire de configuration local (LCM)applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly'
configurationModeFrequencyMins	Fréquence à laquelle, en minutes, la configuration actuelle est vérifiée et appliquée. Cette propriété est ignorée si la propriété ConfigurationMode est définie sur ApplyOnly. La valeur par défaut est 15.	Int
rebootIfNeededed	Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration nécessitant un redémarrage. Sinon, vous devrez redémarrer manuellement le nœud pour toute configuration qui l’exige. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est adoptée par autre chose que DSC (par exemple, Windows Installer), combinez ce paramètre avec le module xPendingReboot.	Bool
refreshFrequencyMins	Intervalle de temps, en minutes, auquel le gestionnaire de configuration local vérifie un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le gestionnaire de configuration local n’est pas configuré en mode collecteur. La valeur par défaut est 30.	Int

AssignmentReport

Nom	Description	Valeur
mission	Détails de configuration de l’attribution de configuration d’invité.	AssignmentInfo
ressources	Liste des ressources pour lesquelles la conformité de l’attribution de configuration d’invité est vérifiée.	AssignmentReportResource[]
Vm	Informations sur la machine virtuelle.	VMInfo

AssignmentInfo

Nom	Description	Valeur
configuration	Informations sur la configuration.	ConfigurationInfo

ConfigurationInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

AssignmentReportResource

Nom	Description	Valeur
Raisons	Raison de conformité et code de raison d’une ressource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VMInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VmssvmInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
machines virtuelles IIS & machine virtuelle SQL Server 2014	Créez 1 ou 2 serveurs web IIS Windows 2012 R2 et un serveur principal SQL Server 2014 dans le réseau virtuel.
machine virtuelle Windows avec une base de référence sécurisée Azure	Le modèle crée une machine virtuelle exécutant Windows Server dans un nouveau réseau virtuel, avec une adresse IP publique. Une fois la machine déployée, l’extension de configuration invité est installée et la base de référence sécurisée Azure pour Windows Server est appliquée. Si la configuration des machines dérive, vous pouvez réappliquer les paramètres en déployant à nouveau le modèle.

Modèle

Description

machines virtuelles IIS & machine virtuelle SQL Server 2014

Créez 1 ou 2 serveurs web IIS Windows 2012 R2 et un serveur principal SQL Server 2014 dans le réseau virtuel.

machine virtuelle Windows avec une base de référence sécurisée Azure

Le modèle crée une machine virtuelle exécutant Windows Server dans un nouveau réseau virtuel, avec une adresse IP publique. Une fois la machine déployée, l’extension de configuration invité est installée et la base de référence sécurisée Azure pour Windows Server est appliquée. Si la configuration des machines dérive, vous pouvez réappliquer les paramètres en déployant à nouveau le modèle.

Définition de ressource de modèle ARM

Le type de ressource guestConfigurationAssignments est une ressource d’extension , ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la propriété scope sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans les modèles ARM.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le code JSON suivant à votre modèle.

{
  "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": [
      {
      }
    ]
  }
}

Valeurs de propriété

guestConfigurationAssignments

Nom	Description	Valeur
type	Type de ressource	'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion	Version de l’API de ressource	'2020-06-25'
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Région où se trouve la machine virtuelle.	corde
portée	Utilisez-la lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement.	Ressource cible Pour JSON, définissez la valeur sur le nom complet de la ressource pour appliquer la ressource d’extension .
Propriétés	Propriétés de l’affectation de configuration d’invité.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nom	Description	Valeur
contexte	Source qui a lancé l’attribution de configuration d’invité. Ex : Azure Policy	corde
guestConfiguration	Configuration d’invité à attribuer.	GuestConfigurationNavigation
latestAssignmentReport	Dernier rapport d’affectation de configuration invité signalé.	AssignmentReport
vmssVMList	Liste des données de conformité des machines virtuelles pour VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Nom	Description	Valeur
assignmentType	Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	Paramètres de configuration de la configuration invité.	ConfigurationParameter[]
configurationProtectedParameter	Paramètres de configuration protégés pour la configuration d’invité.	ConfigurationParameter[]
configurationSetting	Paramètre de configuration de la configuration de l’invité.	ConfigurationSetting
contentHash	Hachage combiné du package de configuration invité et des paramètres de configuration.	corde
contentUri	URI du stockage où le package de configuration invité est chargé.	corde
gentil	Type de configuration d’invité. Par exemple :DSC	'DSC'
nom	Nom de la configuration d’invité.	corde
Version	Version de la configuration d’invité.	corde

ConfigurationParameter

Nom	Description	Valeur
nom	Nom du paramètre de configuration.	corde
valeur	Valeur du paramètre de configuration.	corde

ConfigurationSetting

Nom	Description	Valeur
actionAfterReboot	Spécifie ce qui se passe après un redémarrage pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration	'ContinueConfiguration' 'StopConfiguration'
allowModuleOverwrite	Si la valeur est true , les nouvelles configurations téléchargées à partir du service pull sont autorisées à remplacer les anciennes configurations sur le nœud cible. Sinon, false	Bool
configurationMode	Spécifie comment le gestionnaire de configuration local (LCM)applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly'
configurationModeFrequencyMins	Fréquence à laquelle, en minutes, la configuration actuelle est vérifiée et appliquée. Cette propriété est ignorée si la propriété ConfigurationMode est définie sur ApplyOnly. La valeur par défaut est 15.	Int
rebootIfNeededed	Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration nécessitant un redémarrage. Sinon, vous devrez redémarrer manuellement le nœud pour toute configuration qui l’exige. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est adoptée par autre chose que DSC (par exemple, Windows Installer), combinez ce paramètre avec le module xPendingReboot.	Bool
refreshFrequencyMins	Intervalle de temps, en minutes, auquel le gestionnaire de configuration local vérifie un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le gestionnaire de configuration local n’est pas configuré en mode collecteur. La valeur par défaut est 30.	Int

AssignmentReport

Nom	Description	Valeur
mission	Détails de configuration de l’attribution de configuration d’invité.	AssignmentInfo
ressources	Liste des ressources pour lesquelles la conformité de l’attribution de configuration d’invité est vérifiée.	AssignmentReportResource[]
Vm	Informations sur la machine virtuelle.	VMInfo

AssignmentInfo

Nom	Description	Valeur
configuration	Informations sur la configuration.	ConfigurationInfo

ConfigurationInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

AssignmentReportResource

Nom	Description	Valeur
Raisons	Raison de conformité et code de raison d’une ressource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VMInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VmssvmInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
machines virtuelles IIS & machine virtuelle SQL Server 2014	Créez 1 ou 2 serveurs web IIS Windows 2012 R2 et un serveur principal SQL Server 2014 dans le réseau virtuel.
machine virtuelle Windows avec une base de référence sécurisée Azure	Le modèle crée une machine virtuelle exécutant Windows Server dans un nouveau réseau virtuel, avec une adresse IP publique. Une fois la machine déployée, l’extension de configuration invité est installée et la base de référence sécurisée Azure pour Windows Server est appliquée. Si la configuration des machines dérive, vous pouvez réappliquer les paramètres en déployant à nouveau le modèle.

Modèle

Description

machines virtuelles IIS & machine virtuelle SQL Server 2014

Créez 1 ou 2 serveurs web IIS Windows 2012 R2 et un serveur principal SQL Server 2014 dans le réseau virtuel.

machine virtuelle Windows avec une base de référence sécurisée Azure

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource guestConfigurationAssignments est une ressource d’extension , ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la propriété parent_id sur cette ressource pour définir l’étendue de cette ressource.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le terraform suivant à votre modèle.

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 = [
        {
        }
      ]
    }
  })
}

Valeurs de propriété

guestConfigurationAssignments

Nom	Description	Valeur
type	Type de ressource	« Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25 »
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Région où se trouve la machine virtuelle.	corde
parent_id	ID de la ressource à laquelle appliquer cette ressource d’extension.	chaîne (obligatoire)
Propriétés	Propriétés de l’affectation de configuration d’invité.	GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nom	Description	Valeur
contexte	Source qui a lancé l’attribution de configuration d’invité. Ex : Azure Policy	corde
guestConfiguration	Configuration d’invité à attribuer.	GuestConfigurationNavigation
latestAssignmentReport	Dernier rapport d’affectation de configuration invité signalé.	AssignmentReport
vmssVMList	Liste des données de conformité des machines virtuelles pour VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Nom	Description	Valeur
assignmentType	Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.	« ApplyAndAutoCorrect » « ApplyAndMonitor » « Audit » « DeployAndAutoCorrect »
configurationParameter	Paramètres de configuration de la configuration invité.	ConfigurationParameter[]
configurationProtectedParameter	Paramètres de configuration protégés pour la configuration d’invité.	ConfigurationParameter[]
configurationSetting	Paramètre de configuration de la configuration de l’invité.	ConfigurationSetting
contentHash	Hachage combiné du package de configuration invité et des paramètres de configuration.	corde
contentUri	URI du stockage où le package de configuration invité est chargé.	corde
gentil	Type de configuration d’invité. Par exemple :DSC	« DSC »
nom	Nom de la configuration d’invité.	corde
Version	Version de la configuration d’invité.	corde

ConfigurationParameter

Nom	Description	Valeur
nom	Nom du paramètre de configuration.	corde
valeur	Valeur du paramètre de configuration.	corde

ConfigurationSetting

Nom	Description	Valeur
actionAfterReboot	Spécifie ce qui se passe après un redémarrage pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration	« ContinueConfiguration » « StopConfiguration »
allowModuleOverwrite	Si la valeur est true , les nouvelles configurations téléchargées à partir du service pull sont autorisées à remplacer les anciennes configurations sur le nœud cible. Sinon, false	Bool
configurationMode	Spécifie comment le gestionnaire de configuration local (LCM)applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect.	« ApplyAndAutoCorrect » « ApplyAndMonitor » « ApplyOnly »
configurationModeFrequencyMins	Fréquence à laquelle, en minutes, la configuration actuelle est vérifiée et appliquée. Cette propriété est ignorée si la propriété ConfigurationMode est définie sur ApplyOnly. La valeur par défaut est 15.	Int
rebootIfNeededed	Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration nécessitant un redémarrage. Sinon, vous devrez redémarrer manuellement le nœud pour toute configuration qui l’exige. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est adoptée par autre chose que DSC (par exemple, Windows Installer), combinez ce paramètre avec le module xPendingReboot.	Bool
refreshFrequencyMins	Intervalle de temps, en minutes, auquel le gestionnaire de configuration local vérifie un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le gestionnaire de configuration local n’est pas configuré en mode collecteur. La valeur par défaut est 30.	Int

AssignmentReport

Nom	Description	Valeur
mission	Détails de configuration de l’attribution de configuration d’invité.	AssignmentInfo
ressources	Liste des ressources pour lesquelles la conformité de l’attribution de configuration d’invité est vérifiée.	AssignmentReportResource[]
Vm	Informations sur la machine virtuelle.	VMInfo

AssignmentInfo

Nom	Description	Valeur
configuration	Informations sur la configuration.	ConfigurationInfo

ConfigurationInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

AssignmentReportResource

Nom	Description	Valeur
Raisons	Raison de conformité et code de raison d’une ressource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VMInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

VmssvmInfo

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

Partager via

Microsoft.GuestConfiguration GuestConfigurationAssignments 2020-06-25

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

AssignmentReport

AssignmentInfo

ConfigurationInfo

AssignmentReportResource

AssignmentReportResourceComplianceReason

VMInfo

VmssvmInfo

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

AssignmentReport

AssignmentInfo

ConfigurationInfo

AssignmentReportResource

AssignmentReportResourceComplianceReason

VMInfo

VmssvmInfo

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameter

ConfigurationSetting

AssignmentReport

AssignmentInfo

ConfigurationInfo

AssignmentReportResource

AssignmentReportResourceComplianceReason

VMInfo

VmssvmInfo

Commentaires

Ressources supplémentaires