Guest Configuration Assignments - Create Or Update

Társítás létrehozása a virtuális gép és a vendégkonfiguráció között

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

URI-paraméterek

Name In Kötelező Típus Description
guestConfigurationAssignmentName
path True

string

A vendégkonfiguráció-hozzárendelés neve.

resourceGroupName
path True

string

Az erőforráscsoport neve.

Regex pattern: ^[-\w\._]+$

subscriptionId
path True

string

Előfizetés azonosítója, amely egyedileg azonosítja a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.

vmName
path True

string

A virtuális gép neve.

Regex pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$

api-version
query True

string

Client API-verzió.

Kérelem törzse

Name Típus Description
location

string

Régió, ahol a virtuális gép található.

name

string

A vendégkonfiguráció-hozzárendelés neve.

properties

GuestConfigurationAssignmentProperties

A vendégkonfiguráció-hozzárendelés tulajdonságai.

Válaszok

Name Típus Description
200 OK

GuestConfigurationAssignment

OK gombra. A virtuális gép vendégkonfiguráció-hozzárendelése sikeresen frissült.

201 Created

GuestConfigurationAssignment

Létrehozott. A virtuális gép vendégkonfiguráció-hozzárendelése sikeresen létrejött.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

Create or update guest configuration assignment

Sample Request

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

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

Sample Response

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

Definíciók

Name Description
actionAfterReboot

Meghatározza, hogy mi történjen a konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration

AssignmentInfo

A vendégkonfiguráció-hozzárendeléssel kapcsolatos információk.

AssignmentReport
AssignmentReportResource

A vendégkonfiguráció-hozzárendelési erőforrás.

AssignmentReportResourceComplianceReason

A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka és kódja.

assignmentType

Meghatározza a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect és ApplyAndMonitor.

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

ConfigurationInfo

A konfigurációval kapcsolatos információk.

configurationMode

Meghatározza, hogy az LCM (helyi Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.

ConfigurationParameter

Egy konfigurációs paramétert jelöl.

ConfigurationSetting

Az LCM konfigurációs beállítása (helyi Configuration Manager).

createdByType

Az erőforrást létrehozó identitás típusa.

Error
ErrorResponse

Művelethiba hibaválasza

GuestConfigurationAssignment

A vendégkonfiguráció-hozzárendelés a gép és a vendégkonfiguráció közötti társítás.

GuestConfigurationAssignmentProperties

Vendégkonfiguráció-hozzárendelés tulajdonságai.

GuestConfigurationNavigation

A vendégkonfiguráció egy összetevő, amely magában foglalja a DSC-konfigurációt és annak függőségeit. Az összetevő egy zip-fájl, amely DSC-konfigurációt (MOF-t) és függő erőforrásokat és más függőségeket, például modulokat tartalmaz.

kind

A vendégkonfiguráció típusa. Például:DSC

provisioningState

A kiépítési állapot, amely csak a válaszban jelenik meg.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type

Jelentés típusa, konzisztencia vagy kezdeti

VMInfo

A virtuális gépre vonatkozó információk.

VMSSVMInfo

Információk a VMSS virtuális gépről

actionAfterReboot

Meghatározza, hogy mi történjen a konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration

Name Típus Description
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

A vendégkonfiguráció-hozzárendeléssel kapcsolatos információk.

Name Típus Description
configuration

ConfigurationInfo

A konfigurációval kapcsolatos információk.

name

string

A vendégkonfiguráció-hozzárendelés neve.

AssignmentReport

Name Típus Description
assignment

AssignmentInfo

A vendégkonfiguráció-hozzárendelés konfigurációs részletei.

complianceStatus

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

endTime

string

A vendégkonfiguráció-hozzárendelés megfelelőségi állapotának ellenőrzésének záró dátuma és időpontja.

id

string

A vendégkonfiguráció-hozzárendelés jelentésének ARM-erőforrás-azonosítója.

operationType

type

Jelentés típusa, konzisztencia vagy kezdeti

reportId

string

GUID, amely azonosítja a vendégkonfiguráció-hozzárendelési jelentést egy előfizetés, erőforráscsoport alatt.

resources

AssignmentReportResource[]

Azon erőforrások listája, amelyek esetében a vendégkonfiguráció-hozzárendelés megfelelőségét ellenőrzi a rendszer.

startTime

string

A vendégkonfiguráció-hozzárendelés megfelelőségi állapotának ellenőrzésének kezdő dátuma és időpontja.

vm

VMInfo

A virtuális gépre vonatkozó információk.

AssignmentReportResource

A vendégkonfiguráció-hozzárendelési erőforrás.

Name Típus Description
complianceStatus

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

properties

object

Egy vendégkonfiguráció-hozzárendelési erőforrás tulajdonságai.

reasons

AssignmentReportResourceComplianceReason[]

Egy erőforrás megfelelőségi oka és okkódja.

resourceId

string

A vendégkonfiguráció-hozzárendelés erőforrás-beállításának neve.

AssignmentReportResourceComplianceReason

A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka és kódja.

Name Típus Description
code

string

A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének kódja.

phrase

string

A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka.

assignmentType

Meghatározza a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect és ApplyAndMonitor.

Name Típus Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

Name Típus Description
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

A konfigurációval kapcsolatos információk.

Name Típus Description
name

string

A konfiguráció neve.

version

string

A konfiguráció verziója.

configurationMode

Meghatározza, hogy az LCM (helyi Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.

Name Típus Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Egy konfigurációs paramétert jelöl.

Name Típus Description
name

string

A konfigurációs paraméter neve.

value

string

A konfigurációs paraméter értéke.

ConfigurationSetting

Az LCM konfigurációs beállítása (helyi Configuration Manager).

Name Típus Alapértelmezett érték Description
actionAfterReboot

actionAfterReboot

Meghatározza, hogy mi történik egy konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration

allowModuleOverwrite

boolean

Ha igaz – a lekérési szolgáltatásból letöltött új konfigurációk felülírhatják a régieket a célcsomóponton. Ellenkező esetben hamis

configurationMode

configurationMode

Meghatározza, hogy az LCM(Helyi Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

A rendszer percek alatt ellenőrzi és alkalmazza az aktuális konfigurációt. Ezt a tulajdonságot a rendszer figyelmen kívül hagyja, ha a ConfigurationMode tulajdonság ApplyOnly értékre van állítva. Az alapértelmezett érték 15.

rebootIfNeeded

boolean

Állítsa ezt igaz értékre, hogy automatikusan újraindítsa a csomópontot egy újraindítást igénylő konfiguráció alkalmazása után. Ellenkező esetben manuálisan kell újraindítania a csomópontot minden olyan konfigurációhoz, amelyhez szükség van rá. Az alapértelmezett érték a hamis. Ha ezt a beállítást akkor szeretné használni, ha a DSC-n (például a Windows Installeren) kívül más rendszer is életbe léptet egy újraindítási feltételt, kombinálja ezt a beállítást az xPendingReboot modullal.

refreshFrequencyMins

number

30

Az az időintervallum percekben, amikor az LCM ellenőrzi a lekéréses szolgáltatást a frissített konfigurációk lekéréséhez. Ezt az értéket a rendszer figyelmen kívül hagyja, ha az LCM nincs lekéréses módban konfigurálva. Az alapértelmezett érték 30.

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Name Típus Description
code

string

Hibakód.

message

string

Részletes hibaüzenet, amely azt jelzi, hogy a művelet miért hiúsult meg.

ErrorResponse

Művelethiba hibaválasza

Name Típus Description
error

Error

GuestConfigurationAssignment

A vendégkonfiguráció-hozzárendelés a gép és a vendégkonfiguráció közötti társítás.

Name Típus Description
id

string

A vendégkonfiguráció-hozzárendelés ARM-erőforrás-azonosítója.

location

string

Régió, ahol a virtuális gép található.

name

string

A vendégkonfiguráció-hozzárendelés neve.

properties

GuestConfigurationAssignmentProperties

A Vendégkonfiguráció-hozzárendelés tulajdonságai.

systemData

systemData

Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatok.

type

string

Az erőforrás típusa.

GuestConfigurationAssignmentProperties

Vendégkonfiguráció-hozzárendelés tulajdonságai.

Name Típus Description
assignmentHash

string

A konfigurációs csomag és a paraméterek kombinált kivonata.

complianceStatus

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

context

string

A vendégkonfiguráció-hozzárendelést kezdeményező forrás. Például: Azure Policy

guestConfiguration

GuestConfigurationNavigation

A hozzárendelni kívánt vendégkonfiguráció.

lastComplianceStatusChecked

string

A legutóbbi megfelelőségi állapot ellenőrzésének dátuma és időpontja.

latestAssignmentReport

AssignmentReport

Legutóbb jelentett vendégkonfiguráció-hozzárendelési jelentés.

latestReportId

string

A vendégkonfiguráció-hozzárendelés legújabb jelentésének azonosítója.

parameterHash

string

paraméterkivonat a vendégkonfiguráció-hozzárendeléshez.

provisioningState

provisioningState

A kiépítési állapot, amely csak a válaszban jelenik meg.

resourceType

string

Az erőforrás típusa – VMSS/VM

targetResourceId

string

Virtuálisgép-erőforrás azonosítója.

vmssVMList

VMSSVMInfo[]

A VMSS virtuálisgép-megfelelőségi adatainak listája

GuestConfigurationNavigation

A vendégkonfiguráció egy összetevő, amely magában foglalja a DSC-konfigurációt és annak függőségeit. Az összetevő egy zip-fájl, amely DSC-konfigurációt (MOF-t) és függő erőforrásokat és más függőségeket, például modulokat tartalmaz.

Name Típus Description
assignmentSource

string

Megadja a konfiguráció eredetét.

assignmentType

assignmentType

Meghatározza a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect és ApplyAndMonitor.

configurationParameter

ConfigurationParameter[]

A vendégkonfiguráció konfigurációs paraméterei.

configurationProtectedParameter

ConfigurationParameter[]

A vendégkonfiguráció védett konfigurációs paraméterei.

configurationSetting

ConfigurationSetting

A vendégkonfiguráció konfigurációs beállítása.

contentHash

string

A vendégkonfigurációs csomag és a konfigurációs paraméterek kombinált kivonata.

contentType

string

Megadja a konfiguráció tartalomtípusát. Lehetséges értékek lehetnek Beépített vagy Egyéni.

contentUri

string

A vendégkonfigurációs csomag feltöltésére szolgáló tároló URI-ja.

kind

kind

A vendégkonfiguráció típusa. Például:DSC

name

string

A vendégkonfiguráció neve.

version

string

A vendégkonfiguráció verziója.

kind

A vendégkonfiguráció típusa. Például:DSC

Name Típus Description
DSC

string

provisioningState

A kiépítési állapot, amely csak a válaszban jelenik meg.

Name Típus Description
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az az identitás, amely legutóbb módosította az erőforrást.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

type

Jelentés típusa, konzisztencia vagy kezdeti

Name Típus Description
Consistency

string

Initial

string

VMInfo

A virtuális gépre vonatkozó információk.

Name Típus Description
id

string

A virtuális gép Azure-erőforrás-azonosítója.

uuid

string

A virtuális gép UUID(univerzálisan egyedi azonosítója).

VMSSVMInfo

Információk a VMSS virtuális gépről

Name Típus Description
complianceStatus

complianceStatus

A hozzárendelt vendégkonfigurációhoz tartozó gép megfelelőségi állapotát jelző érték.

lastComplianceChecked

string

A legutóbbi megfelelőségi állapot ellenőrzésének dátuma és időpontja.

latestReportId

string

A vendégkonfiguráció-hozzárendelés legújabb jelentésének azonosítója.

vmId

string

A virtuális gép UUID azonosítója.

vmResourceId

string

A virtuális gép Azure-erőforrás-azonosítója.