Guest Configuration Assignments - Get

Referencia

Servicio:: Guest Configuration

Versión de la API:: 2024-04-05

Obtener información sobre una asignación de configuración de invitado

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
guestConfigurationAssignmentName	path	True	string	Nombre de la asignación de configuración de invitado.
resourceGroupName	path	True	string	Nombre del grupo de recursos. Patrón de Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vmName	path	True	string	Nombre de la máquina virtual. Patrón de Regex: `^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$`
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	GuestConfigurationAssignment	De acuerdo. La asignación de configuración de invitado se devolvió correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
actionAfterReboot	Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration.
AssignmentInfo	Información sobre la asignación de configuración de invitado.
AssignmentReport
AssignmentReportResource	Recurso de asignación de configuración de invitado.
AssignmentReportResourceComplianceReason	Motivo y código para el cumplimiento del recurso de asignación de configuración de invitado.
assignmentType	Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor.
complianceStatus	Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.
ConfigurationInfo	Información sobre la configuración.
configurationMode	Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.
ConfigurationParameter	Representa un parámetro de configuración.
ConfigurationSetting	Configuración de LCM (Administrador de configuración local).
createdByType	Tipo de identidad que creó el recurso.
Error
ErrorResponse	Respuesta de error de un error de operación
GuestConfigurationAssignment	La asignación de configuración de invitado es una asociación entre una máquina y una configuración de invitado.
GuestConfigurationAssignmentProperties	Propiedades de asignación de configuración de invitado.
GuestConfigurationNavigation	La configuración de invitado es un artefacto que encapsula la configuración de DSC y sus dependencias. El artefacto es un archivo ZIP que contiene la configuración de DSC (como MOF) y recursos dependientes y otras dependencias como módulos.
kind	Tipo de configuración de invitado. Por ejemplo: DSC
provisioningState	Estado de aprovisionamiento, que solo aparece en la respuesta.
systemData	Metadatos relativos a la creación y última modificación del recurso.
type	Tipo de informe, coherencia o inicial
VMInfo	Información sobre la máquina virtual.
VMSSVMInfo	Información sobre VMSS VM

actionAfterReboot

Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration.

Nombre	Tipo	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Información sobre la asignación de configuración de invitado.

Nombre	Tipo	Description
configuration	ConfigurationInfo	Información sobre la configuración.
name	string	Nombre de la asignación de configuración de invitado.

AssignmentReport

Nombre	Tipo	Description
assignment	AssignmentInfo	Detalles de configuración de la asignación de configuración de invitado.
complianceStatus	complianceStatus	Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.
endTime	string	Fecha y hora de finalización de la comprobación de estado de cumplimiento de la asignación de configuración de invitado.
id	string	Identificador de recurso de ARM del informe para la asignación de configuración de invitado.
operationType	type	Tipo de informe, coherencia o inicial
reportId	string	GUID que identifica el informe de asignación de configuración de invitado en una suscripción, grupo de recursos.
resources	AssignmentReportResource[]	Lista de recursos para los que se comprueba el cumplimiento de la asignación de configuración de invitado.
startTime	string	Fecha y hora de inicio de la comprobación de estado de cumplimiento de la asignación de configuración de invitado.
vm	VMInfo	Información sobre la máquina virtual.

AssignmentReportResource

Recurso de asignación de configuración de invitado.

Nombre	Tipo	Description
complianceStatus	complianceStatus	Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.
properties	object	Propiedades de un recurso de asignación de configuración de invitado.
reasons	AssignmentReportResourceComplianceReason[]	Motivo de cumplimiento y código de motivo para un recurso.
resourceId	string	Nombre de la configuración del recurso de asignación de configuración de invitado.

AssignmentReportResourceComplianceReason

Motivo y código para el cumplimiento del recurso de asignación de configuración de invitado.

Nombre	Tipo	Description
code	string	Código para el cumplimiento del recurso de asignación de configuración de invitado.
phrase	string	Motivo del cumplimiento del recurso de asignación de configuración de invitado.

assignmentType

Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor.

Nombre	Tipo	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

Nombre	Tipo	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Información sobre la configuración.

Nombre	Tipo	Description
name	string	Nombre de la configuración.
version	string	Versión de la configuración.

configurationMode

Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.

Nombre	Tipo	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Representa un parámetro de configuración.

Nombre	Tipo	Description
name	string	Nombre del parámetro de configuración.
value	string	Valor del parámetro de configuración.

ConfigurationSetting

Configuración de LCM (Administrador de configuración local).

Nombre	Tipo	Valor predeterminado	Description
actionAfterReboot	actionAfterReboot		Especifica lo que sucede después de un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration.
allowModuleOverwrite	boolean		Si es true: se permiten nuevas configuraciones descargadas desde el servicio de extracción para sobrescribir las antiguas del nodo de destino. De lo contrario, false
configurationMode	configurationMode		Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Con qué frecuencia, en minutos, se comprueba y aplica la configuración actual. Esta propiedad se omite si la propiedad ConfigurationMode está establecida en ApplyOnly. El valor predeterminado es 15.
rebootIfNeeded	boolean		Establézcalo en true para reiniciar automáticamente el nodo después de aplicar una configuración que requiera reiniciar. De lo contrario, tendrá que reiniciar manualmente el nodo para cualquier configuración que lo requiera. El valor predeterminado es false. Para usar esta configuración cuando una condición de reinicio está aprobada por algo distinto de DSC (por ejemplo, Windows Installer), combine esta configuración con el módulo xPendingReboot.
refreshFrequencyMins	number	30	Intervalo de tiempo, en minutos, en el que el LCM comprueba un servicio de extracción para obtener configuraciones actualizadas. Este valor se omite si el LCM no está configurado en modo de extracción. El valor predeterminado es 30.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error de detalle que indica por qué se produjo un error en la operación.

ErrorResponse

Respuesta de error de un error de operación

Nombre	Tipo	Description
error	Error