Guest Configuration Assignments - Create Or Update

Usługa:

Guest Configuration

Wersja interfejsu API:

2024-04-05

Tworzy skojarzenie między maszyną wirtualną a konfiguracją gościa

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
guestConfigurationAssignmentName	path	True	string	Nazwa przypisania konfiguracji gościa.
resourceGroupName	path	True	string	Nazwa grupy zasobów. Wzorzec wyrażenia regularnego: ^[-\w\._]+$
subscriptionId	path	True	string	Identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vmName	path	True	string	Nazwa maszyny wirtualnej. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
location	string	Region, w którym znajduje się maszyna wirtualna.
name	string	Nazwa przypisania konfiguracji gościa.
properties	GuestConfigurationAssignmentProperties	Właściwości przypisania konfiguracji gościa.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GuestConfigurationAssignment	OK. Przypisanie konfiguracji gościa dla maszyny wirtualnej zostało pomyślnie zaktualizowane.
201 Created	GuestConfigurationAssignment	Utworzono. Przypisanie konfiguracji gościa dla maszyny wirtualnej zostało pomyślnie utworzone.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create or update guest configuration assignment

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
actionAfterReboot	Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration
AssignmentInfo	Informacje o przypisaniu konfiguracji gościa.
AssignmentReport
AssignmentReportResource	Zasób przypisania konfiguracji gościa.
AssignmentReportResourceComplianceReason	Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.
assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.
complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
ConfigurationInfo	Informacje o konfiguracji.
configurationMode	Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.
ConfigurationParameter	Reprezentuje parametr konfiguracji.
ConfigurationSetting	Ustawienie konfiguracji LCM (Local Configuration Manager).
createdByType	Typ tożsamości, która utworzyła zasób.
Error
ErrorResponse	Odpowiedź na błąd operacji
GuestConfigurationAssignment	Przypisanie konfiguracji gościa jest skojarzeniem między maszyną a konfiguracją gościa.
GuestConfigurationAssignmentProperties	Właściwości przypisania konfiguracji gościa.
GuestConfigurationNavigation	Konfiguracja gościa to artefakt, który hermetyzuje konfigurację DSC i jej zależności. Artefakt jest plikiem zip zawierającym konfigurację DSC (jako moF) i zasoby zależne oraz inne zależności, takie jak moduły.
kind	Rodzaj konfiguracji gościa. Na przykład:DSC
provisioningState	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	Typ raportu, spójności lub początkowego
VMInfo	Informacje o maszynie wirtualnej.
VMSSVMInfo	Informacje o maszynie wirtualnej zestawu skalowania maszyn wirtualnych

actionAfterReboot

Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration

Nazwa	Typ	Opis
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informacje o przypisaniu konfiguracji gościa.

Nazwa	Typ	Opis
configuration	ConfigurationInfo	Informacje o konfiguracji.
name	string	Nazwa przypisania konfiguracji gościa.

AssignmentReport

Nazwa	Typ	Opis
assignment	AssignmentInfo	Szczegóły konfiguracji przypisania konfiguracji gościa.
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
endTime	string	Data i godzina zakończenia sprawdzania stanu zgodności przypisania konfiguracji gościa.
id	string	Identyfikator zasobu usługi ARM raportu dla przypisania konfiguracji gościa.
operationType	type	Typ raportu, spójności lub początkowego
reportId	string	Identyfikator GUID identyfikujący raport przypisania konfiguracji gościa w ramach subskrypcji, grupy zasobów.
resources	AssignmentReportResource[]	Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.
startTime	string	Data i godzina rozpoczęcia sprawdzania stanu zgodności przypisania konfiguracji gościa.
vm	VMInfo	Informacje o maszynie wirtualnej.

AssignmentReportResource

Zasób przypisania konfiguracji gościa.

Nazwa	Typ	Opis
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
properties	object	Właściwości zasobu przypisania konfiguracji gościa.
reasons	AssignmentReportResourceComplianceReason[]	Przyczyna zgodności i kod przyczyny zasobu.
resourceId	string	Nazwa ustawienia zasobu przypisania konfiguracji gościa.

AssignmentReportResourceComplianceReason

Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.

Nazwa	Typ	Opis
code	string	Kod zgodności zasobu przypisania konfiguracji gościa.
phrase	string	Przyczyna zgodności zasobu przypisania konfiguracji gościa.

assignmentType

Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.

Nazwa	Typ	Opis
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

Nazwa	Typ	Opis
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informacje o konfiguracji.

Nazwa	Typ	Opis
name	string	Nazwa konfiguracji.
version	string	Wersja konfiguracji.

configurationMode

Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.

Nazwa	Typ	Opis
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Reprezentuje parametr konfiguracji.

Nazwa	Typ	Opis
name	string	Nazwa parametru konfiguracji.
value	string	Wartość parametru konfiguracji.

ConfigurationSetting

Ustawienie konfiguracji LCM (Local Configuration Manager).

Nazwa	Typ	Domyślna wartość	Opis
actionAfterReboot	actionAfterReboot		Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration
allowModuleOverwrite	boolean		Jeśli wartość true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz
configurationMode	configurationMode		Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Jak często w minutach bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.
rebootIfNeeded	boolean		Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla każdej wymaganej konfiguracji. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego uruchomienia zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.
refreshFrequencyMins	number	30	Interwał czasu w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegółowy komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd operacji

Nazwa	Typ	Opis
error	Error

GuestConfigurationAssignment

Przypisanie konfiguracji gościa jest skojarzeniem między maszyną a konfiguracją gościa.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM przypisania konfiguracji gościa.
location	string	Region, w którym znajduje się maszyna wirtualna.
name	string	Nazwa przypisania konfiguracji gościa.
properties	GuestConfigurationAssignmentProperties	Właściwości przypisania konfiguracji gościa.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu.

GuestConfigurationAssignmentProperties

Właściwości przypisania konfiguracji gościa.

Nazwa	Typ	Opis
assignmentHash	string	Połączony skrót pakietu konfiguracji i parametrów.
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
context	string	Źródło, które zainicjowało przypisanie konfiguracji gościa. Na przykład: Azure Policy
guestConfiguration	GuestConfigurationNavigation	Konfiguracja gościa do przypisania.
lastComplianceStatusChecked	string	Data i godzina sprawdzenia ostatniego stanu zgodności.
latestAssignmentReport	AssignmentReport	Raport ostatniego zgłoszonego przypisania konfiguracji gościa.
latestReportId	string	Identyfikator najnowszego raportu dla przypisania konfiguracji gościa.
parameterHash	string	skrót parametru dla przypisania konfiguracji gościa.
provisioningState	provisioningState	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
resourceType	string	Typ zasobu — VMSS/VM
targetResourceId	string	Identyfikator zasobu maszyny wirtualnej.
vmssVMList	VMSSVMInfo[]	Lista danych zgodności maszyn wirtualnych dla zestawu skalowania maszyn wirtualnych

GuestConfigurationNavigation

Konfiguracja gościa to artefakt, który hermetyzuje konfigurację DSC i jej zależności. Artefakt jest plikiem zip zawierającym konfigurację DSC (jako moF) i zasoby zależne oraz inne zależności, takie jak moduły.

Nazwa	Typ	Opis
assignmentSource	string	Określa źródło konfiguracji.
assignmentType	assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Parametry konfiguracji dla konfiguracji gościa.
configurationProtectedParameter	ConfigurationParameter[]	Parametry konfiguracji chronionej dla konfiguracji gościa.
configurationSetting	ConfigurationSetting	Ustawienie konfiguracji dla konfiguracji gościa.
contentHash	string	Połączony skrót pakietu konfiguracji gościa i parametrów konfiguracji.
contentManagedIdentity	string	Tożsamość zarządzana z dostępem do magazynu pakietu konfiguracji gościa i parametrów konfiguracji.
contentType	string	Określa typ zawartości konfiguracji. Możliwe wartości mogą być wbudowane lub niestandardowe.
contentUri	string	Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa.
kind	kind	Rodzaj konfiguracji gościa. Na przykład:DSC
name	string	Nazwa konfiguracji gościa.
version	string	Wersja konfiguracji gościa.

kind

Rodzaj konfiguracji gościa. Na przykład:DSC

Nazwa	Typ	Opis
DSC	string

provisioningState

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

Nazwa	Typ	Opis
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

type

Typ raportu, spójności lub początkowego

Nazwa	Typ	Opis
Consistency	string
Initial	string

VMInfo

Informacje o maszynie wirtualnej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure maszyny wirtualnej.
uuid	string	UUID (uniwersalny unikatowy identyfikator) maszyny wirtualnej.

VMSSVMInfo

Informacje o maszynie wirtualnej zestawu skalowania maszyn wirtualnych

Nazwa	Typ	Opis
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
lastComplianceChecked	string	Data i godzina sprawdzenia ostatniego stanu zgodności.
latestReportId	string	Identyfikator najnowszego raportu dla przypisania konfiguracji gościa.
vmId	string	Identyfikator UUID maszyny wirtualnej.
vmResourceId	string	Identyfikator zasobu platformy Azure maszyny wirtualnej.