Guest Configuration Assignments - Get

Référence

Service:: Guest Configuration

Version d'API:: 2024-04-05

Obtenir des informations sur une attribution de configuration d’invité

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2024-04-05

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
guestConfigurationAssignmentName	path	True	string	Nom de l’attribution de configuration d’invité.
resourceGroupName	path	True	string	Nom du groupe de ressources. Modèle d’expression régulière: `^[-\w\._]+$`
subscriptionId	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 de chaque appel de service.
vmName	path	True	string	Nom de la machine virtuelle. Modèle d’expression régulière: `^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$`
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	GuestConfigurationAssignment	D’ACCORD. L’attribution de configuration d’invité a été retournée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get a guest configuration assignment

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/SecureProtocol?api-version=2024-04-05

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.GuestConfiguration.Models;
using Azure.ResourceManager.GuestConfiguration;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionId";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Compute/virtualMachines/{2}", subscriptionId, resourceGroupName, vmName));
GuestConfigurationVmAssignmentCollection collection = client.GetGuestConfigurationVmAssignments(scopeId);

// invoke the operation
string guestConfigurationAssignmentName = "SecureProtocol";
NullableResponse<GuestConfigurationVmAssignmentResource> response = await collection.GetIfExistsAsync(guestConfigurationAssignmentName);
GuestConfigurationVmAssignmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    GuestConfigurationAssignmentData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "location": "centraluseuap",
  "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol",
  "name": "AuditSecureProtocol",
  "properties": {
    "complianceStatus": "Compliant",
    "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
    "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
    "context": null,
    "guestConfiguration": {
      "kind": null,
      "name": "AuditSecureProtocol",
      "version": "1.0.0.3",
      "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip",
      "contentHash": "content hash",
      "contentManagedIdentity": "test_identity",
      "configurationParameter": [],
      "configurationSetting": null
    },
    "provisioningState": "Succeeded"
  }
}

Définitions

Nom	Description
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
AssignmentInfo	Informations sur l’attribution de configuration d’invité.
AssignmentReport
AssignmentReportResource	Ressource d’affectation de configuration d’invité.
AssignmentReportResourceComplianceReason	Raison et code de la conformité de la ressource d’affectation de configuration d’invité.
assignmentType	Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.
complianceStatus	Valeur indiquant l’état de conformité de l’ordinateur pour la configuration d’invité affectée.
ConfigurationInfo	Informations sur la configuration.
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.
ConfigurationParameter	Représente un paramètre de configuration.
ConfigurationSetting	Paramètre de configuration du gestionnaire de configuration local (Gestionnaire de configuration local).
createdByType	Type d’identité qui a créé la ressource.
Error
ErrorResponse	Réponse d’erreur d’un échec d’opération
GuestConfigurationAssignment	L’attribution de configuration d’invité est une association entre une machine et une configuration invité.
GuestConfigurationAssignmentProperties	Propriétés d’affectation de configuration d’invité.
GuestConfigurationNavigation	La configuration d’invité est un artefact qui encapsule la configuration DSC et ses dépendances. L’artefact est un fichier zip contenant la configuration DSC (en tant que MOF) et les ressources dépendantes et d’autres dépendances telles que les modules.
kind	Type de configuration d’invité. Par exemple :DSC
provisioningState	État d’approvisionnement, qui apparaît uniquement dans la réponse.
systemData	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 ce qui se passe après un redémarrage pendant l’application d’une configuration. Les valeurs possibles sont ContinueConfiguration et StopConfiguration

Nom	Type	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informations sur l’attribution de configuration d’invité.

Nom	Type	Description
configuration	ConfigurationInfo	Informations sur la configuration.
name	string	Nom de l’attribution de configuration d’invité.

AssignmentReport

Nom	Type	Description
assignment	AssignmentInfo	Détails de configuration de l’attribution de configuration d’invité.
complianceStatus	complianceStatus	Valeur indiquant l’état de conformité de l’ordinateur pour la configuration d’invité affectée.
endTime	string	Date et heure de fin de la vérification de l’état de conformité de l’attribution de configuration de l’invité.
id	string	ID de ressource ARM du rapport pour l’affectation de configuration d’invité.
operationType	type	Type de rapport, cohérence ou initial
reportId	string	GUID qui identifie le rapport d’affectation de configuration invité sous un abonnement, un groupe de ressources.
resources	AssignmentReportResource[]	Liste des ressources pour lesquelles la conformité de l’attribution de configuration d’invité est vérifiée.
startTime	string	Date et heure de début de la vérification de l’état de conformité de l’attribution de configuration de l’invité.
vm	VMInfo	Informations sur la machine virtuelle.

AssignmentReportResource

Ressource d’affectation de configuration d’invité.

Nom	Type	Description
complianceStatus	complianceStatus	Valeur indiquant l’état de conformité 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	AssignmentReportResourceComplianceReason[]	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 d’invité.

Nom	Type	Description
code	string	Code pour la conformité de la ressource d’affectation de configuration d’invité.
phrase	string	Raison de la conformité de la ressource d’affectation de configuration d’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 l’état de conformité 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 gestionnaire de configuration local (LCM)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 du gestionnaire de configuration local (Gestionnaire de configuration local).

Nom	Type	Valeur par défaut	Description
actionAfterReboot	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
allowModuleOverwrite	boolean		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
configurationMode	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.
configurationModeFrequencyMins	number	15	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.
rebootIfNeeded	boolean		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.
refreshFrequencyMins	number	30	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.

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 pourquoi l’opération a échoué.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
error	Error

GuestConfigurationAssignment

L’attribution de configuration d’invité est une association entre une machine et une configuration invité.

Nom	Type	Description
id	string	ID de ressource ARM de l’attribution de configuration d’invité.
location	string	Région où se trouve la machine virtuelle.
name	string	Nom de l’attribution de configuration d’invité.
properties	GuestConfigurationAssignmentProperties	Propriétés de l’affectation de configuration d’invité.
systemData	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	complianceStatus	Valeur indiquant l’état de conformité de l’ordinateur pour la configuration d’invité affectée.
context	string	Source qui a lancé l’attribution de configuration d’invité. Ex : Azure Policy
guestConfiguration	GuestConfigurationNavigation	Configuration d’invité à attribuer.
lastComplianceStatusChecked	string	Date et heure à laquelle l’état de la dernière conformité a été vérifié.
latestAssignmentReport	AssignmentReport	Dernier rapport d’affectation de configuration invité signalé.
latestReportId	string	ID du dernier rapport pour l’attribution de configuration d’invité.
parameterHash	string	hachage de paramètre pour l’attribution de configuration d’invité.
provisioningState	provisioningState	État d’approvisionnement, qui apparaît uniquement dans la réponse.
resourceType	string	Type de la ressource - VMSS /VM
targetResourceId	string	ID de ressource de machine virtuelle.
vmssVMList	VMSSVMInfo[]	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 la configuration DSC (en tant que MOF) et les ressources dépendantes et d’autres dépendances telles que les modules.

Nom	Type	Description
assignmentSource	string	Spécifie l’origine de la configuration.
assignmentType	assignmentType	Spécifie le type d’affectation et l’exécution de la configuration. Les valeurs possibles sont Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect et ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Paramètres de configuration de la configuration invité.
configurationProtectedParameter	ConfigurationParameter[]	Paramètres de configuration protégés pour la configuration d’invité.
configurationSetting	ConfigurationSetting	Paramètre de configuration de la configuration de l’invité.
contentHash	string	Hachage combiné du package de configuration invité et des paramètres de configuration.
contentManagedIdentity	string	Identité managée avec accès au stockage 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	kind	Type de configuration d’invité. Par exemple :DSC
name	string	Nom de la configuration d’invité.
version	string	Version de la configuration d’invité.

kind

Type de configuration d’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	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	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(Identificateur universel unique) de la machine virtuelle.

VMSSVMInfo

Informations sur la machine virtuelle VMSS

Nom	Type	Description
complianceStatus	complianceStatus	Valeur indiquant l’état de conformité de l’ordinateur pour la configuration d’invité affectée.
lastComplianceChecked	string	Date et heure à laquelle l’état de la dernière conformité a été vérifié.
latestReportId	string	ID du dernier rapport pour l’attribution de configuration d’invité.
vmId	string	UUID de la machine virtuelle.
vmResourceId	string	ID de ressource Azure de la machine virtuelle.

Partager via