Microsoft.GuestConfiguration guestConfigurationAssignments 25-01-2021
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 scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des 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 des ressources
Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le Bicep suivant à votre modèle.
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: [
{
}
]
}
}
Valeurs de propriétés
guestConfigurationAssignments
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Région où se trouve la machine virtuelle. | string |
| scope | Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement. | Ressource cible Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension. |
| properties | Propriétés de l’attribution de configuration Invité. | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| Nom | Description | Valeur |
|---|---|---|
| contexte | Source à l’origine de l’attribution de configuration invité. Exemple : Azure Policy | string |
| guestConfiguration | Configuration invité à affecter. | GuestConfigurationNavigation |
| latestAssignmentReport | Dernier rapport d’affectation de configuration d’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 invité. | ConfigurationParameter[] |
| configurationSetting | Paramètre de configuration de la configuration invité. | ConfigurationSetting |
| contentHash | Hachage combiné du package de configuration invité et des paramètres de configuration. | string |
| contentUri | URI du stockage où le package de configuration invité est chargé. | string |
| kind | Type de configuration de l’invité. Par exemple :DSC | 'DSC' |
| name | Nom de la configuration de l’invité. | string |
| version | Version de la configuration invité. | string |
ConfigurationParameter
| Nom | Description | Valeur |
|---|---|---|
| name | Nom du paramètre de configuration. | string |
| value | Valeur du paramètre de configuration. | string |
ConfigurationSetting
| Nom | Description | Valeur |
|---|---|---|
| actionAfterReboot | Spécifie le comportement après un redémarrage survenant 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 d’extraction sont autorisées à remplacer les anciennes sur le nœud cible. Sinon, false | bool |
| configurationMode | Spécifie comment le LCM (Local Configuration Manager) applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
| configurationModeFrequencyMins | Fréquence, en minutes, à laquelle 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 |
| rebootIfNeeded | Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration qui nécessite un redémarrage. Sinon, vous devez redémarrer manuellement le nœud. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est imposée par autre chose que DSC (par exemple Windows Installer), combinez ce paramètre avec le module xPendingReboot. | bool |
| refreshFrequencyMins | L’intervalle de temps, en minutes, auquel le LCM contrôle un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le LCM n’est pas configuré en mode d’extraction. La valeur par défaut est 30. | int |
AssignmentReport
| Nom | Description | Valeur |
|---|---|---|
| affectation | Détails de configuration de l’attribution de configuration invité. | AssignmentInfo |
| les ressources | Liste des ressources pour lesquelles la conformité de l’affectation de configuration 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 |
|---|---|
Machine virtuelle Windows avec 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 redéployant le modèle. |
Définition de ressources 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 scope propriété 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 des ressources
Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le code JSON suivant à votre modèle.
{
"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": [
{
}
]
}
}
Valeurs de propriétés
guestConfigurationAssignments
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.GuestConfiguration/guestConfigurationAssignments » |
| apiVersion | Version de l’API de ressource | '2021-01-25' |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Région où se trouve la machine virtuelle. | string |
| scope | Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement. | Ressource cible Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension . |
| properties | Propriétés de l’attribution de configuration Invité. | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| Nom | Description | Valeur |
|---|---|---|
| contexte | Source à l’origine de l’attribution de configuration invité. Exemple : Azure Policy | string |
| guestConfiguration | Configuration invité à affecter. | GuestConfigurationNavigation |
| latestAssignmentReport | Dernier rapport d’affectation de configuration d’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 invité. | ConfigurationParameter[] |
| configurationSetting | Paramètre de configuration de la configuration invité. | ConfigurationSetting |
| contentHash | Hachage combiné du package de configuration invité et des paramètres de configuration. | string |
| contentUri | URI du stockage où le package de configuration invité est chargé. | string |
| kind | Type de configuration de l’invité. Par exemple :DSC | 'DSC' |
| name | Nom de la configuration de l’invité. | string |
| version | Version de la configuration invité. | string |
ConfigurationParameter
| Nom | Description | Valeur |
|---|---|---|
| name | Nom du paramètre de configuration. | string |
| value | Valeur du paramètre de configuration. | string |
ConfigurationSetting
| Nom | Description | Valeur |
|---|---|---|
| actionAfterReboot | Spécifie le comportement après un redémarrage survenant 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 d’extraction sont autorisées à remplacer les anciennes sur le nœud cible. Sinon, false | bool |
| configurationMode | Spécifie comment le LCM (Local Configuration Manager) applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect. | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
| configurationModeFrequencyMins | Fréquence, en minutes, à laquelle 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 |
| rebootIfNeeded | Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration qui nécessite un redémarrage. Sinon, vous devez redémarrer manuellement le nœud. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est imposée par autre chose que DSC (par exemple Windows Installer), combinez ce paramètre avec le module xPendingReboot. | bool |
| refreshFrequencyMins | L’intervalle de temps, en minutes, auquel le LCM contrôle un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le LCM n’est pas configuré en mode d’extraction. La valeur par défaut est 30. | int |
AssignmentReport
| Nom | Description | Valeur |
|---|---|---|
| affectation | Détails de configuration de l’attribution de configuration invité. | AssignmentInfo |
| les ressources | Liste des ressources pour lesquelles la conformité de l’affectation de configuration 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 |
|---|---|
| Machine virtuelle Windows avec 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 redéployant le modèle. |
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 parent_id propriété 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 des ressources
Pour créer une ressource Microsoft.GuestConfiguration/guestConfigurationAssignments, ajoutez le Terraform suivant à votre modèle.
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 = [
{
}
]
}
})
}
Valeurs de propriétés
guestConfigurationAssignments
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25 » |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Région où se trouve la machine virtuelle. | string |
| parent_id | ID de la ressource à laquelle appliquer cette ressource d’extension. | chaîne (obligatoire) |
| properties | Propriétés de l’attribution de configuration Invité. | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| Nom | Description | Valeur |
|---|---|---|
| contexte | Source à l’origine de l’attribution de configuration invité. Exemple : Azure Policy | string |
| guestConfiguration | Configuration invité à affecter. | GuestConfigurationNavigation |
| latestAssignmentReport | Dernier rapport d’affectation de configuration d’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 » « Auditer » « DeployAndAutoCorrect » |
| configurationParameter | Paramètres de configuration de la configuration invité. | ConfigurationParameter[] |
| configurationProtectedParameter | Paramètres de configuration protégés pour la configuration invité. | ConfigurationParameter[] |
| configurationSetting | Paramètre de configuration de la configuration invité. | ConfigurationSetting |
| contentHash | Hachage combiné du package de configuration invité et des paramètres de configuration. | string |
| contentUri | URI du stockage où le package de configuration invité est chargé. | string |
| kind | Type de configuration de l’invité. Par exemple :DSC | « DSC » |
| name | Nom de la configuration de l’invité. | string |
| version | Version de la configuration invité. | string |
ConfigurationParameter
| Nom | Description | Valeur |
|---|---|---|
| name | Nom du paramètre de configuration. | string |
| value | Valeur du paramètre de configuration. | string |
ConfigurationSetting
| Nom | Description | Valeur |
|---|---|---|
| actionAfterReboot | Spécifie le comportement après un redémarrage survenant 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 d’extraction sont autorisées à remplacer les anciennes configurations sur le nœud cible. Sinon, false | bool |
| configurationMode | Spécifie comment le LCM (Local Configuration Manager) applique réellement la configuration aux nœuds cibles. Les valeurs possibles sont ApplyOnly, ApplyAndMonitor et ApplyAndAutoCorrect. | « ApplyAndAutoCorrect » « ApplyAndMonitor » « ApplyOnly » |
| configurationModeFrequencyMins | Fréquence, en minutes, à laquelle 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 |
| rebootIfNeeded | Définissez cette valeur sur true pour redémarrer automatiquement le nœud après l’application d’une configuration qui nécessite un redémarrage. Sinon, vous devez redémarrer manuellement le nœud. La valeur par défaut est false. Pour utiliser ce paramètre lorsqu’une condition de redémarrage est imposée par autre chose que DSC (par exemple Windows Installer), combinez ce paramètre avec le module xPendingReboot. | bool |
| refreshFrequencyMins | L’intervalle de temps, en minutes, auquel le LCM contrôle un service d’extraction pour obtenir des configurations mises à jour. Cette valeur est ignorée si le LCM n’est pas configuré en mode d’extraction. La valeur par défaut est 30. | int |
AssignmentReport
| Nom | Description | Valeur |
|---|---|---|
| affectation | Détails de configuration de l’affectation de configuration invité. | AssignmentInfo |
| les ressources | Liste des ressources pour lesquelles la conformité de l’affectation 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.
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour