Guest Configuration Assignments - Create Or Update
Crée une association entre une machine virtuelle et une configuration invité
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2022-01-25
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
guest
|
path | True |
string |
Nom de l’attribution de configuration invité. |
resource
|
path | True |
string |
Nom du groupe de ressources. Regex pattern: |
subscription
|
path | True |
string |
ID d’abonnement qui identifie de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
vm
|
path | True |
string |
Nom de la machine virtuelle. Regex pattern: |
api-version
|
query | True |
string |
Version de l’API cliente. |
Corps de la demande
Nom | Type | Description |
---|---|---|
location |
string |
Région où se trouve la machine virtuelle. |
name |
string |
Nom de l’attribution de configuration invité. |
properties |
Propriétés de l’attribution de configuration Invité. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK. L’attribution de configuration invité pour la machine virtuelle a été mise à jour avec succès. |
|
201 Created |
Créé. L’attribution de configuration invité pour la machine virtuelle a été créée avec succès. |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Create or update guest configuration assignment
Sample Request
PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows?api-version=2022-01-25
{
"location": "westcentralus",
"name": "NotInstalledApplicationForWindows",
"properties": {
"context": "Azure policy",
"guestConfiguration": {
"name": "NotInstalledApplicationForWindows",
"version": "1.0.0.3",
"contentUri": "https://thisisfake/pacakge",
"contentHash": "123contenthash",
"assignmentType": "ApplyAndAutoCorrect",
"configurationParameter": [
{
"name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
"value": "NotePad,sql"
}
]
}
}
}
Sample Response
{
"location": "westcentralus",
"id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
"name": "NotInstalledApplicationForWindows",
"properties": {
"complianceStatus": "Pending",
"assignmentHash": null,
"latestReportId": null,
"lastComplianceStatusChecked": null,
"context": "Azure policy",
"resourceType": null,
"vmssVMList": null,
"guestConfiguration": {
"kind": null,
"name": "NotInstalledApplicationForWindows",
"version": "1.0.0.3",
"contentUri": null,
"contentHash": null,
"contentType": null,
"assignmentSource": "AzurePolicy",
"configurationParameter": [
{
"name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
"value": "NotePad,sql"
}
]
},
"provisioningState": "Succeeded"
}
}
{
"location": "westcentralus",
"id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
"name": "NotInstalledApplicationForWindows",
"properties": {
"complianceStatus": "Pending",
"assignmentHash": null,
"latestReportId": null,
"lastComplianceStatusChecked": null,
"context": "Azure policy",
"resourceType": null,
"vmssVMList": null,
"guestConfiguration": {
"kind": null,
"name": "NotInstalledApplicationForWindows",
"version": "1.0.0.3",
"contentUri": null,
"contentHash": null,
"contentType": null,
"assignmentSource": "AzurePolicy",
"configurationParameter": [
{
"name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
"value": "NotePad,sql"
}
]
},
"provisioningState": "Succeeded"
}
}
Définitions
Nom | Description |
---|---|
action |
Spécifie le comportement après un redémarrage survenant pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration |
Assignment |
Informations sur l’affectation de configuration d’invité. |
Assignment |
|
Assignment |
Ressource d’affectation de configuration d’invité. |
Assignment |
Raison et code de la conformité de la ressource d’affectation de configuration invité. |
assignment |
Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor. |
compliance |
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée. |
Configuration |
Informations sur la configuration. |
configuration |
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. |
Configuration |
Représente un paramètre de configuration. |
Configuration |
Paramètre de configuration de LCM (Local Configuration Manager). |
created |
Type d’identité qui a créé la ressource. |
Error | |
Error |
Réponse d’erreur d’un échec d’opération |
Guest |
L’affectation de configuration d’invité est une association entre une configuration de machine et une configuration invité. |
Guest |
Propriétés d’affectation de configuration d’invité. |
Guest |
La configuration d’invité est un artefact qui encapsule la configuration DSC et ses dépendances. L’artefact est un fichier zip contenant une configuration DSC (en tant que MOF) et des ressources dépendantes et d’autres dépendances telles que des modules. |
kind |
Type de configuration de l’invité. Par exemple :DSC |
provisioning |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
type |
Type de rapport, Cohérence ou Initial |
VMInfo |
Informations sur la machine virtuelle. |
VMSSVMInfo |
Informations sur la machine virtuelle VMSS |
actionAfterReboot
Spécifie le comportement après un redémarrage survenant pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration
Nom | Type | Description |
---|---|---|
ContinueConfiguration |
string |
|
StopConfiguration |
string |
AssignmentInfo
Informations sur l’affectation de configuration d’invité.
Nom | Type | Description |
---|---|---|
configuration |
Informations sur la configuration. |
|
name |
string |
Nom de l’affectation de configuration d’invité. |
AssignmentReport
Nom | Type | Description |
---|---|---|
assignment |
Détails de configuration de l’affectation de configuration invité. |
|
complianceStatus |
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée. |
|
endTime |
string |
Date et heure de fin de l’status case activée de conformité de l’affectation de configuration d’invité. |
id |
string |
ID de ressource ARM du rapport pour l’affectation de configuration d’invité. |
operationType |
Type de rapport, Cohérence ou Initial |
|
reportId |
string |
GUID qui identifie le rapport d’affectation de configuration d’invité sous un abonnement, un groupe de ressources. |
resources |
Liste des ressources pour lesquelles la conformité de l’affectation de configuration d’invité est vérifiée. |
|
startTime |
string |
Date et heure de début de l’status case activée de conformité de l’affectation de configuration d’invité. |
vm |
Informations sur la machine virtuelle. |
AssignmentReportResource
Ressource d’affectation de configuration d’invité.
Nom | Type | Description |
---|---|---|
complianceStatus |
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée. |
|
properties |
object |
Propriétés d’une ressource d’affectation de configuration d’invité. |
reasons |
Raison de conformité et code de raison d’une ressource. |
|
resourceId |
string |
Nom du paramètre de ressource d’affectation de configuration d’invité. |
AssignmentReportResourceComplianceReason
Raison et code de la conformité de la ressource d’affectation de configuration invité.
Nom | Type | Description |
---|---|---|
code |
string |
Code pour la conformité de la ressource d’affectation de configuration invité. |
phrase |
string |
Raison de la conformité de la ressource d’affectation de configuration invité. |
assignmentType
Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.
Nom | Type | Description |
---|---|---|
ApplyAndAutoCorrect |
string |
|
ApplyAndMonitor |
string |
|
Audit |
string |
|
DeployAndAutoCorrect |
string |
complianceStatus
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée.
Nom | Type | Description |
---|---|---|
Compliant |
string |
|
NonCompliant |
string |
|
Pending |
string |
ConfigurationInfo
Informations sur la configuration.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la configuration. |
version |
string |
Version de la configuration. |
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.
Nom | Type | Description |
---|---|---|
ApplyAndAutoCorrect |
string |
|
ApplyAndMonitor |
string |
|
ApplyOnly |
string |
ConfigurationParameter
Représente un paramètre de configuration.
Nom | Type | Description |
---|---|---|
name |
string |
Nom du paramètre de configuration. |
value |
string |
Valeur du paramètre de configuration. |
ConfigurationSetting
Paramètre de configuration de LCM (Local Configuration Manager).
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
actionAfterReboot |
Spécifie le comportement après un redémarrage survenant pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration |
||
allowModuleOverwrite |
boolean |
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 |
|
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. |
||
configurationModeFrequencyMins |
number |
15 |
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. |
rebootIfNeeded |
boolean |
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. |
|
refreshFrequencyMins |
number |
30 |
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. |
createdByType
Type d’identité qui a créé la ressource.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Error
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
message |
string |
Message d’erreur détaillé indiquant la raison de l’échec de l’opération. |
ErrorResponse
Réponse d’erreur d’un échec d’opération
Nom | Type | Description |
---|---|---|
error |
GuestConfigurationAssignment
L’affectation de configuration d’invité est une association entre une configuration de machine et une configuration invité.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource ARM de l’affectation de configuration d’invité. |
location |
string |
Région où se trouve la machine virtuelle. |
name |
string |
Nom de l’affectation de configuration d’invité. |
properties |
Propriétés de l’affectation de configuration invité. |
|
systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
type |
string |
Type de la ressource. |
GuestConfigurationAssignmentProperties
Propriétés d’affectation de configuration d’invité.
Nom | Type | Description |
---|---|---|
assignmentHash |
string |
Hachage combiné du package de configuration et des paramètres. |
complianceStatus |
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée. |
|
context |
string |
Source qui a lancé l’affectation de configuration d’invité. Exemple : Azure Policy |
guestConfiguration |
Configuration d’invité à affecter. |
|
lastComplianceStatusChecked |
string |
Date et heure de la dernière vérification de la status de conformité. |
latestAssignmentReport |
Dernier rapport d’affectation de configuration d’invité signalé. |
|
latestReportId |
string |
ID du dernier rapport pour l’affectation de configuration d’invité. |
parameterHash |
string |
hachage de paramètre pour l’affectation de configuration d’invité. |
provisioningState |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
|
resourceType |
string |
Type de la ressource - VMSS / machine virtuelle |
targetResourceId |
string |
ID de ressource de machine virtuelle. |
vmssVMList |
Liste des données de conformité des machines virtuelles pour VMSS |
GuestConfigurationNavigation
La configuration d’invité est un artefact qui encapsule la configuration DSC et ses dépendances. L’artefact est un fichier zip contenant une configuration DSC (en tant que MOF) et des ressources dépendantes et d’autres dépendances telles que des modules.
Nom | Type | Description |
---|---|---|
assignmentSource |
string |
Spécifie l’origine de la configuration. |
assignmentType |
Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor. |
|
configurationParameter |
Paramètres de configuration de la configuration invité. |
|
configurationProtectedParameter |
Paramètres de configuration protégés pour la configuration invité. |
|
configurationSetting |
Paramètre de configuration de la configuration invité. |
|
contentHash |
string |
Hachage combiné du package de configuration invité et des paramètres de configuration. |
contentType |
string |
Spécifie le type de contenu de la configuration. Les valeurs possibles peuvent être Builtin ou Custom. |
contentUri |
string |
URI du stockage où le package de configuration invité est chargé. |
kind |
Type de configuration de l’invité. Par exemple :DSC |
|
name |
string |
Nom de la configuration de l’invité. |
version |
string |
Version de la configuration invité. |
kind
Type de configuration de l’invité. Par exemple :DSC
Nom | Type | Description |
---|---|---|
DSC |
string |
provisioningState
État d’approvisionnement, qui apparaît uniquement dans la réponse.
Nom | Type | Description |
---|---|---|
Canceled |
string |
|
Created |
string |
|
Failed |
string |
|
Succeeded |
string |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
Nom | Type | Description |
---|---|---|
createdAt |
string |
Horodatage de la création de ressources (UTC). |
createdBy |
string |
Identité qui a créé la ressource. |
createdByType |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de la ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
type
Type de rapport, Cohérence ou Initial
Nom | Type | Description |
---|---|---|
Consistency |
string |
|
Initial |
string |
VMInfo
Informations sur la machine virtuelle.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource Azure de la machine virtuelle. |
uuid |
string |
UUID(Universally Unique Identifier) de la machine virtuelle. |
VMSSVMInfo
Informations sur la machine virtuelle VMSS
Nom | Type | Description |
---|---|---|
complianceStatus |
Valeur indiquant la conformité status de l’ordinateur pour la configuration d’invité affectée. |
|
lastComplianceChecked |
string |
Date et heure de la dernière vérification de la status de conformité. |
latestReportId |
string |
ID du dernier rapport pour l’affectation de configuration d’invité. |
vmId |
string |
UUID de la machine virtuelle. |
vmResourceId |
string |
ID de ressource Azure de la machine virtuelle. |