Guest Configuration Assignments - Create Or Update

Referenz

Dienst:: Guest Configuration

API-Version:: 2024-04-05

Erstellt eine Zuordnung zwischen einer VM und einer Gastkonfiguration

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
guestConfigurationAssignmentName	path	True	string	Name der Gastkonfigurationszuweisung.
resourceGroupName	path	True	string	Der Ressourcengruppenname. RegEx-Muster: `^[-\w\._]+$`
subscriptionId	path	True	string	Abonnement-ID, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmName	path	True	string	Der Name des virtuellen Computers. RegEx-Muster: `^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$`
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
location	string	Region, in der sich der virtuelle Computer befindet.
name	string	Name der Gastkonfigurationszuweisung.
properties	GuestConfigurationAssignmentProperties	Eigenschaften der Gastkonfigurationszuweisung.

Antworten

Name	Typ	Beschreibung
200 OK	GuestConfigurationAssignment	OKAY. Die Gastkonfigurationszuweisung für den virtuellen Computer wurde erfolgreich aktualisiert.
201 Created	GuestConfigurationAssignment	Erstellt. Die Gastkonfigurationszuweisung für den virtuellen Computer wurde erfolgreich erstellt.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create or update guest configuration assignment

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"
        }
      ]
    }
  }
}

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://video2.skills-academy.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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
actionAfterReboot	Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration
AssignmentInfo	Informationen zur Gastkonfigurationszuweisung.
AssignmentReport
AssignmentReportResource	Die Ressource für die Gastkonfigurationszuordnung.
AssignmentReportResourceComplianceReason	Grund und Code für die Einhaltung der Ressource für die Gastkonfigurationszuordnung.
assignmentType	Gibt den Zuordnungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor.
complianceStatus	Ein Wert, der den Konformitätsstatus des Computers für die zugewiesene Gastkonfiguration angibt.
ConfigurationInfo	Informationen zur Konfiguration.
configurationMode	Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.
ConfigurationParameter	Stellt einen Konfigurationsparameter dar.
ConfigurationSetting	Konfigurationseinstellung von LCM (Local Configuration Manager).
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Error
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
GuestConfigurationAssignment	Die Gastkonfigurationszuweisung ist eine Zuordnung zwischen einem Computer und einer Gastkonfiguration.
GuestConfigurationAssignmentProperties	Eigenschaften der Gastkonfigurationszuweisung.
GuestConfigurationNavigation	Die Gastkonfiguration ist ein Artefakt, das die DSC-Konfiguration und die zugehörigen Abhängigkeiten kapselt. Das Artefakt ist eine ZIP-Datei, die DSC-Konfiguration (als MOF) und abhängige Ressourcen und andere Abhängigkeiten wie Module enthält.
kind	Art der Gastkonfiguration. Beispiel:DSC
provisioningState	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	Berichtstyp, Konsistenz oder Initial
VMInfo	Informationen über den virtuellen Computer.
VMSSVMInfo	Informationen zu VMSS-VM

actionAfterReboot

Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration

Name	Typ	Beschreibung
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informationen zur Gastkonfigurationszuweisung.

Name	Typ	Beschreibung
configuration	ConfigurationInfo	Informationen zur Konfiguration.
name	string	Name der Gastkonfigurationszuweisung.

AssignmentReport

Name	Typ	Beschreibung
assignment	AssignmentInfo	Konfigurationsdetails der Gastkonfigurationszuweisung.
complianceStatus	complianceStatus	Ein Wert, der den Konformitätsstatus des Computers für die zugewiesene Gastkonfiguration angibt.
endTime	string	Enddatum und -uhrzeit der Konformitätsüberprüfung der Gastkonfigurationszuweisung.
id	string	ARM-Ressourcen-ID des Berichts für die Gastkonfigurationszuordnung.
operationType	type	Berichtstyp, Konsistenz oder Initial
reportId	string	GUID, die den Bericht zur Gastkonfigurationszuordnung unter einem Abonnement, einer Ressourcengruppe identifiziert.
resources	AssignmentReportResource[]	Die Liste der Ressourcen, für die die Kompatibilität der Gastkonfigurationszuweisung überprüft wird.
startTime	string	Startdatum und -uhrzeit der Konformitätsüberprüfung der Gastkonfigurationszuweisung.
vm	VMInfo	Informationen über den virtuellen Computer.

AssignmentReportResource

Die Ressource für die Gastkonfigurationszuordnung.

Name	Typ	Beschreibung
complianceStatus	complianceStatus	Ein Wert, der den Konformitätsstatus des Computers für die zugewiesene Gastkonfiguration angibt.
properties	object	Eigenschaften einer Gastkonfigurationszuordnungsressource.
reasons	AssignmentReportResourceComplianceReason[]	Compliancegrund und Grundcode für eine Ressource.
resourceId	string	Name der Ressourceneinstellung für die Gastkonfigurationszuordnung.

AssignmentReportResourceComplianceReason

Grund und Code für die Einhaltung der Ressource für die Gastkonfigurationszuordnung.

Name	Typ	Beschreibung
code	string	Code für die Einhaltung der Gastkonfigurationszuordnungsressource.
phrase	string	Grund für die Einhaltung der Gastkonfigurationszuordnungsressource.

assignmentType

Gibt den Zuordnungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor.

Name	Typ	Beschreibung
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Ein Wert, der den Konformitätsstatus des Computers für die zugewiesene Gastkonfiguration angibt.

Name	Typ	Beschreibung
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informationen zur Konfiguration.

Name	Typ	Beschreibung
name	string	Name der Konfiguration.
version	string	Version der Konfiguration.

configurationMode

Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.

Name	Typ	Beschreibung
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Stellt einen Konfigurationsparameter dar.

Name	Typ	Beschreibung
name	string	Name des Konfigurationsparameters.
value	string	Wert des Konfigurationsparameters.

ConfigurationSetting

Konfigurationseinstellung von LCM (Local Configuration Manager).

Name	Typ	Standardwert	Beschreibung
actionAfterReboot	actionAfterReboot		Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Mögliche Werte sind ContinueConfiguration und StopConfiguration
allowModuleOverwrite	boolean		Wenn "true" – neue Konfigurationen, die vom Pulldienst heruntergeladen wurden, dürfen die alten Konfigurationen auf dem Zielknoten überschrieben werden. Andernfalls "false"
configurationMode	configurationMode		Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Wie oft in Minuten die aktuelle Konfiguration überprüft und angewendet wird. Diese Eigenschaft wird ignoriert, wenn die ConfigurationMode-Eigenschaft auf ApplyOnly festgelegt ist. Der Standardwert ist 15.
rebootIfNeeded	boolean		Legen Sie diesen Wert auf "true" fest, um den Knoten automatisch neu zu starten, nachdem eine Konfiguration angewendet wurde, für die ein Neustart erforderlich ist. Andernfalls müssen Sie den Knoten für jede konfiguration, für die er erforderlich ist, manuell neu starten. Der Standardwert ist "false". Wenn Sie diese Einstellung verwenden möchten, wenn eine Neustartbedingung von einem anderen Element als DSC (z. B. Windows Installer) ausgeführt wird, kombinieren Sie diese Einstellung mit dem xPendingReboot-Modul.
refreshFrequencyMins	number	30	Das Zeitintervall in Minuten, in dem das LCM einen Pulldienst überprüft, um aktualisierte Konfigurationen abzurufen. Dieser Wert wird ignoriert, wenn der LCM nicht im Pullmodus konfiguriert ist. Der Standardwert ist 30.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Detailfehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
error	Error