Guest Configuration Assignments - Create Or Update

Servizio:

Guest Configuration

Versione API:

2024-04-05

Crea un'associazione tra una macchina virtuale e una configurazione guest

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
guestConfigurationAssignmentName	path	True	string	Nome dell'assegnazione della configurazione guest.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Criterio di espressione regolare: ^[-\w\._]+$
subscriptionId	path	True	string	ID sottoscrizione che identifica in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vmName	path	True	string	Nome della macchina virtuale. Criterio di espressione regolare: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
location	string	Area in cui si trova la macchina virtuale.
name	string	Nome dell'assegnazione della configurazione guest.
properties	GuestConfigurationAssignmentProperties	Proprietà dell'assegnazione di configurazione guest.

Risposte

Nome	Tipo	Descrizione
200 OK	GuestConfigurationAssignment	OK. L'assegnazione di configurazione guest per la macchina virtuale è stata aggiornata correttamente.
201 Created	GuestConfigurationAssignment	Creato. L'assegnazione di configurazione guest per la macchina virtuale è stata creata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or update guest configuration assignment

Esempio di richiesta

HTTP

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

{
  "location": "westcentralus",
  "name": "NotInstalledApplicationForWindows",
  "properties": {
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "version": "1.0.0.3",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "contentManagedIdentity": "test_identity",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

dotnet

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/createOrUpdateGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_CreateOrUpdate" 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 = "NotInstalledApplicationForWindows";
GuestConfigurationAssignmentData data = new GuestConfigurationAssignmentData()
{
    Properties = new GuestConfigurationAssignmentProperties()
    {
        GuestConfiguration = new GuestConfigurationNavigation()
        {
            Name = "NotInstalledApplicationForWindows",
            Version = "1.0.0.3",
            ContentUri = new Uri("https://thisisfake/pacakge"),
            ContentHash = "123contenthash",
            ContentManagedIdentity = "test_identity",
            AssignmentType = GuestConfigurationAssignmentType.ApplyAndAutoCorrect,
            ConfigurationParameters =
            {
            new GuestConfigurationParameter()
            {
            Name = "[InstalledApplication]NotInstalledApplicationResource1;Name",
            Value = "NotePad,sql",
            }
            },
        },
        Context = "Azure policy",
    },
    Name = "NotInstalledApplicationForWindows",
    Location = new AzureLocation("westcentralus"),
};
ArmOperation<GuestConfigurationVmAssignmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, guestConfigurationAssignmentName, data);
GuestConfigurationVmAssignmentResource result = lro.Value;

// 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

Risposta di esempio

Codice di stato:

201

{
  "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,
      "contentManagedIdentity": null,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Codice di stato:

200

{
  "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,
      "contentManagedIdentity": null,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Definizioni

Nome	Descrizione
actionAfterReboot	Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration
AssignmentInfo	Informazioni sull'assegnazione di configurazione guest.
AssignmentReport
AssignmentReportResource	Risorsa di assegnazione della configurazione guest.
AssignmentReportResourceComplianceReason	Motivo e codice per la conformità della risorsa di assegnazione della configurazione guest.
assignmentType	Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.
complianceStatus	Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.
ConfigurationInfo	Informazioni sulla configurazione.
configurationMode	Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.
ConfigurationParameter	Rappresenta un parametro di configurazione.
ConfigurationSetting	Impostazione di configurazione di Gestione configurazione locale (Gestione configurazione locale).
createdByType	Tipo di identità che ha creato la risorsa.
Error
ErrorResponse	Risposta di errore di un errore dell'operazione
GuestConfigurationAssignment	L'assegnazione di configurazione guest è un'associazione tra un computer e una configurazione guest.
GuestConfigurationAssignmentProperties	Proprietà dell'assegnazione della configurazione guest.
GuestConfigurationNavigation	La configurazione guest è un artefatto che incapsula la configurazione DSC e le relative dipendenze. L'artefatto è un file ZIP contenente la configurazione DSC (come MOF) e le risorse dipendenti e altre dipendenze come i moduli.
kind	Tipo di configurazione guest. Ad esempio:DSC
provisioningState	Stato di provisioning, visualizzato solo nella risposta.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	Tipo di report, coerenza o iniziale
VMInfo	Informazioni sulla macchina virtuale.
VMSSVMInfo	Informazioni sulla macchina virtuale del set di scalabilità di macchine virtuali

actionAfterReboot

Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration

Nome	Tipo	Descrizione
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informazioni sull'assegnazione di configurazione guest.

Nome	Tipo	Descrizione
configuration	ConfigurationInfo	Informazioni sulla configurazione.
name	string	Nome dell'assegnazione della configurazione guest.

AssignmentReport

Nome	Tipo	Descrizione
assignment	AssignmentInfo	Dettagli di configurazione dell'assegnazione della configurazione guest.
complianceStatus	complianceStatus	Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.
endTime	string	Data e ora di fine del controllo dello stato di conformità dell'assegnazione della configurazione guest.
id	string	ID risorsa ARM del report per l'assegnazione di configurazione guest.
operationType	type	Tipo di report, coerenza o iniziale
reportId	string	GUID che identifica il report di assegnazione della configurazione guest in una sottoscrizione, gruppo di risorse.
resources	AssignmentReportResource[]	Elenco di risorse per le quali viene verificata la conformità dell'assegnazione della configurazione guest.
startTime	string	Data e ora di inizio del controllo dello stato di conformità dell'assegnazione della configurazione guest.
vm	VMInfo	Informazioni sulla macchina virtuale.

AssignmentReportResource

Risorsa di assegnazione della configurazione guest.

Nome	Tipo	Descrizione
complianceStatus	complianceStatus	Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.
properties	object	Proprietà di una risorsa di assegnazione della configurazione guest.
reasons	AssignmentReportResourceComplianceReason[]	Motivo di conformità e codice motivo per una risorsa.
resourceId	string	Nome dell'impostazione della risorsa di assegnazione della configurazione guest.

AssignmentReportResourceComplianceReason

Motivo e codice per la conformità della risorsa di assegnazione della configurazione guest.

Nome	Tipo	Descrizione
code	string	Codice per la conformità della risorsa di assegnazione della configurazione guest.
phrase	string	Motivo della conformità della risorsa di assegnazione della configurazione guest.

assignmentType

Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.

Nome	Tipo	Descrizione
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.

Nome	Tipo	Descrizione
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informazioni sulla configurazione.

Nome	Tipo	Descrizione
name	string	Nome della configurazione.
version	string	Versione della configurazione.

configurationMode

Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.

Nome	Tipo	Descrizione
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Rappresenta un parametro di configurazione.

Nome	Tipo	Descrizione
name	string	Nome del parametro di configurazione.
value	string	Valore del parametro di configurazione.

ConfigurationSetting

Impostazione di configurazione di Gestione configurazione locale (Gestione configurazione locale).

Nome	Tipo	Valore predefinito	Descrizione
actionAfterReboot	actionAfterReboot		Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration
allowModuleOverwrite	boolean		Se true: le nuove configurazioni scaricate dal servizio di pull possono sovrascrivere quelle precedenti nel nodo di destinazione. In caso contrario, false
configurationMode	configurationMode		Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Con quale frequenza, in minuti, viene verificata e applicata la configurazione corrente. Questa proprietà viene ignorata se la proprietà ConfigurationMode è impostata su ApplyOnly. Il valore predefinito è 15.
rebootIfNeeded	boolean		Impostare su true per riavviare automaticamente il nodo dopo l'applicazione di una configurazione che richiede il riavvio. In caso contrario, sarà necessario riavviare manualmente il nodo per qualsiasi configurazione che lo richiede. Il valore predefinito è false. Per usare questa impostazione quando viene applicato una condizione di riavvio da un elemento diverso da DSC (ad esempio Windows Installer), combinare questa impostazione con il modulo xPendingReboot.
refreshFrequencyMins	number	30	Intervallo di tempo, espresso in minuti, in cui Gestione configurazione locale controlla un servizio di pull per ottenere configurazioni aggiornate. Questo valore viene ignorato se Gestione configurazione locale non è configurata in modalità pull. Il valore predefinito è 30.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore dettagliato che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
error	Error

GuestConfigurationAssignment

L'assegnazione di configurazione guest è un'associazione tra un computer e una configurazione guest.

Nome	Tipo	Descrizione
id	string	ID risorsa ARM dell'assegnazione della configurazione guest.
location	string	Area in cui si trova la macchina virtuale.
name	string	Nome dell'assegnazione della configurazione guest.
properties	GuestConfigurationAssignmentProperties	Proprietà dell'assegnazione di configurazione guest.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa.

GuestConfigurationAssignmentProperties

Proprietà dell'assegnazione della configurazione guest.

Nome	Tipo	Descrizione
assignmentHash	string	Hash combinato del pacchetto di configurazione e dei parametri.
complianceStatus	complianceStatus	Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.
context	string	Origine che ha avviato l'assegnazione di configurazione guest. Ad esempio: Criteri di Azure
guestConfiguration	GuestConfigurationNavigation	Configurazione guest da assegnare.
lastComplianceStatusChecked	string	Data e ora dell'ultima verifica dello stato di conformità.
latestAssignmentReport	AssignmentReport	Ultimo report sull'assegnazione della configurazione guest segnalata.
latestReportId	string	ID del report più recente per l'assegnazione di configurazione guest.
parameterHash	string	hash dei parametri per l'assegnazione di configurazione guest.
provisioningState	provisioningState	Stato di provisioning, visualizzato solo nella risposta.
resourceType	string	Tipo di risorsa - VMSS/VM
targetResourceId	string	ID risorsa macchina virtuale.
vmssVMList	VMSSVMInfo[]	Elenco dei dati di conformità delle macchine virtuali per il set di scalabilità di macchine virtuali

GuestConfigurationNavigation

La configurazione guest è un artefatto che incapsula la configurazione DSC e le relative dipendenze. L'artefatto è un file ZIP contenente la configurazione DSC (come MOF) e le risorse dipendenti e altre dipendenze come i moduli.

Nome	Tipo	Descrizione
assignmentSource	string	Specifica l'origine della configurazione.
assignmentType	assignmentType	Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Parametri di configurazione per la configurazione guest.
configurationProtectedParameter	ConfigurationParameter[]	Parametri di configurazione protetti per la configurazione guest.
configurationSetting	ConfigurationSetting	Impostazione di configurazione per la configurazione guest.
contentHash	string	Hash combinato del pacchetto di configurazione guest e dei parametri di configurazione.
contentManagedIdentity	string	Identità gestita con accesso all'archiviazione dei parametri di configurazione e del pacchetto di configurazione guest.
contentType	string	Specifica il tipo di contenuto della configurazione. I valori possibili possono essere Builtin o Custom.
contentUri	string	URI della risorsa di archiviazione in cui viene caricato il pacchetto di configurazione guest.
kind	kind	Tipo di configurazione guest. Ad esempio:DSC
name	string	Nome della configurazione guest.
version	string	Versione della configurazione guest.

kind

Tipo di configurazione guest. Ad esempio:DSC

Nome	Tipo	Descrizione
DSC	string

provisioningState

Stato di provisioning, visualizzato solo nella risposta.

Nome	Tipo	Descrizione
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

type

Tipo di report, coerenza o iniziale

Nome	Tipo	Descrizione
Consistency	string
Initial	string

VMInfo

Informazioni sulla macchina virtuale.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure della macchina virtuale.
uuid	string	UUID(Universally Unique Identifier) della macchina virtuale.

VMSSVMInfo

Informazioni sulla macchina virtuale del set di scalabilità di macchine virtuali

Nome	Tipo	Descrizione
complianceStatus	complianceStatus	Valore che indica lo stato di conformità del computer per la configurazione guest assegnata.
lastComplianceChecked	string	Data e ora dell'ultima verifica dello stato di conformità.
latestReportId	string	ID del report più recente per l'assegnazione di configurazione guest.
vmId	string	UUID della macchina virtuale.
vmResourceId	string	ID risorsa di Azure della macchina virtuale.