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 minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	Nazwa maszyny wirtualnej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GuestConfigurationAssignment	Operacja aktualizacji zasobu "GuestConfigurationAssignment" zakończyła się pomyślnie
201 Created	GuestConfigurationAssignment	Operacja tworzenia zasobu "GuestConfigurationAssignment" zakończyła się pomyślnie
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ 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

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

Kod stanu:: 201

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

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

Wyliczanie

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

Wartość	Opis
ContinueConfiguration
StopConfiguration

AssignmentInfo

Objekt

Informacje o przypisaniu konfiguracji gościa.

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

AssignmentReport

Objekt

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 (date-time)	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 (date-time)	Data i godzina rozpoczęcia sprawdzania stanu zgodności przypisania konfiguracji gościa.
vm	VMInfo	Informacje o maszynie wirtualnej.

AssignmentReportResource

Objekt

Zasób przypisania konfiguracji gościa.

Nazwa	Typ	Opis
complianceStatus	ComplianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
properties		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

Objekt

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

Wyliczanie

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

Wartość	Opis
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

Wyliczanie

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

Wartość	Opis
Compliant
NonCompliant
Pending

ConfigurationInfo

Objekt

Informacje o konfiguracji.

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

ConfigurationMode

Wyliczanie

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.

Wartość	Opis
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Objekt

Reprezentuje parametr konfiguracji.

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

ConfigurationSetting

Objekt

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 (float)	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 (float)	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

Wyliczanie

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

Wartość	Opis
User
Application
ManagedIdentity
Key

Error

Objekt

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

Objekt

Odpowiedź na błąd niepowodzenia operacji.

Nazwa	Typ	Opis
error	Error