Sdílet prostřednictvím


Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

Vytvoří přidružení mezi připojeným počítačem VM Sphere a konfigurací hosta.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
guestConfigurationAssignmentName
path True

string

Název přiřazení konfigurace hosta.

Vzor regulárního výrazu: ^[^<>%&:\\?/#]*$

resourceGroupName
path True

string

Název skupiny prostředků.

Vzor regulárního výrazu: ^[-\w\._]+$

subscriptionId
path True

string

ID předplatného, které jednoznačně identifikuje předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.

vmName
path True

string

Název virtuálního počítače.

Vzor regulárního výrazu: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$

api-version
query True

string

Verze rozhraní API klienta.

Text požadavku

Name Typ Description
location

string

Oblast, ve které se virtuální počítač nachází.

name

string

Název přiřazení konfigurace hosta.

properties

GuestConfigurationAssignmentProperties

Vlastnosti přiřazení konfigurace hosta.

Odpovědi

Name Typ Description
200 OK

GuestConfigurationAssignment

OK. Přiřazení konfigurace hosta pro počítač Connected VM Sphere se úspěšně aktualizovalo.

201 Created

GuestConfigurationAssignment

Vytvořen. Přiřazení konfigurace hosta pro počítač Connected VM Sphere se úspěšně vytvořilo.

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Create or update guest configuration assignment

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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.0",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

Ukázková odpověď

{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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.ConnectedVMwarevSphere/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"
  }
}

Definice

Name Description
actionAfterReboot

Určuje, co se stane po restartování během použití konfigurace. Možné hodnoty jsou ContinueConfiguration a StopConfiguration.

AssignmentInfo

Informace o přiřazení konfigurace hosta

AssignmentReport
AssignmentReportResource

Prostředek přiřazení konfigurace hosta.

AssignmentReportResourceComplianceReason

Důvod a kód dodržování předpisů prostředku přiřazení konfigurace hosta

assignmentType

Určuje typ přiřazení a provedení konfigurace. Možné hodnoty jsou Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect a ApplyAndMonitor.

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

ConfigurationInfo

Informace o konfiguraci.

configurationMode

Určuje, jak LCM (místní Configuration Manager) skutečně použije konfiguraci na cílové uzly. Možné hodnoty jsou ApplyOnly, ApplyAndMonitor a ApplyAndAutoCorrect.

ConfigurationParameter

Představuje parametr konfigurace.

ConfigurationSetting

Nastavení konfigurace LCM (místní Configuration Manager).

createdByType

Typ identity, která vytvořila prostředek.

Error
ErrorResponse

Chybová odpověď při selhání operace

GuestConfigurationAssignment

Přiřazení konfigurace hosta je přidružení mezi počítačem a konfigurací hosta.

GuestConfigurationAssignmentProperties

Vlastnosti přiřazení konfigurace hosta

GuestConfigurationNavigation

Konfigurace hosta je artefakt, který zapouzdřuje konfiguraci DSC a její závislosti. Artefakt je soubor zip obsahující konfiguraci DSC (jako MOF) a závislé prostředky a další závislosti, jako jsou moduly.

kind

Druh konfigurace hosta. Příklad:DSC

provisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

type

Typ sestavy, konzistence nebo počáteční

VMInfo

Informace o virtuálním počítači.

VMSSVMInfo

Informace o virtuálním počítači VMSS

actionAfterReboot

Určuje, co se stane po restartování během použití konfigurace. Možné hodnoty jsou ContinueConfiguration a StopConfiguration.

Name Typ Description
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Informace o přiřazení konfigurace hosta

Name Typ Description
configuration

ConfigurationInfo

Informace o konfiguraci.

name

string

Název přiřazení konfigurace hosta.

AssignmentReport

Name Typ Description
assignment

AssignmentInfo

Podrobnosti o konfiguraci přiřazení konfigurace hosta

complianceStatus

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

endTime

string

Koncové datum a čas kontroly stavu dodržování předpisů přiřazení konfigurace hosta.

id

string

ID prostředku ARM sestavy pro přiřazení konfigurace hosta

operationType

type

Typ sestavy, konzistence nebo počáteční

reportId

string

IDENTIFIKÁTOR GUID, který identifikuje sestavu přiřazení konfigurace hosta v rámci předplatného nebo skupiny prostředků.

resources

AssignmentReportResource[]

Seznam prostředků, u kterých se kontroluje dodržování předpisů pro přiřazení konfigurace hosta.

startTime

string

Počáteční datum a čas kontroly stavu dodržování předpisů přiřazení konfigurace hosta.

vm

VMInfo

Informace o virtuálním počítači.

AssignmentReportResource

Prostředek přiřazení konfigurace hosta.

Name Typ Description
complianceStatus

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

properties

object

Vlastnosti prostředku přiřazení konfigurace hosta.

reasons

AssignmentReportResourceComplianceReason[]

Důvod dodržování předpisů a kód důvodu pro prostředek

resourceId

string

Název nastavení prostředku přiřazení konfigurace hosta.

AssignmentReportResourceComplianceReason

Důvod a kód dodržování předpisů prostředku přiřazení konfigurace hosta

Name Typ Description
code

string

Kód pro dodržování předpisů prostředku přiřazení konfigurace hosta

phrase

string

Důvod dodržování předpisů prostředku přiřazení konfigurace hosta

assignmentType

Určuje typ přiřazení a provedení konfigurace. Možné hodnoty jsou Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect a ApplyAndMonitor.

Name Typ Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

Name Typ Description
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Informace o konfiguraci.

Name Typ Description
name

string

Název konfigurace.

version

string

Verze konfigurace.

configurationMode

Určuje, jak LCM (místní Configuration Manager) skutečně použije konfiguraci na cílové uzly. Možné hodnoty jsou ApplyOnly, ApplyAndMonitor a ApplyAndAutoCorrect.

Name Typ Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Představuje parametr konfigurace.

Name Typ Description
name

string

Název konfiguračního parametru.

value

string

Hodnota konfiguračního parametru.

ConfigurationSetting

Nastavení konfigurace LCM (místní Configuration Manager).

Name Typ Default value Description
actionAfterReboot

actionAfterReboot

Určuje, co se stane po restartování během použití konfigurace. Možné hodnoty jsou ContinueConfiguration a StopConfiguration.

allowModuleOverwrite

boolean

Pokud je hodnota true, nové konfigurace stažené ze služby pull můžou přepsat staré konfigurace na cílovém uzlu. V opačném případě nepravda

configurationMode

configurationMode

Určuje, jak LCM (místní Configuration Manager) skutečně použije konfiguraci na cílové uzly. Možné hodnoty jsou ApplyOnly, ApplyAndMonitor a ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

Jak často se v minutách kontroluje a používá aktuální konfigurace. Tato vlastnost se ignoruje, pokud je vlastnost ConfigurationMode nastavena na ApplyOnly. Výchozí hodnota je 15.

rebootIfNeeded

boolean

Tuto možnost nastavte na hodnotu true, aby se uzel po použití konfigurace, která vyžaduje restartování, automaticky restartuje. V opačném případě budete muset ručně restartovat uzel pro každou konfiguraci, která to vyžaduje. Výchozí hodnota je False. Pokud chcete toto nastavení použít, když je podmínka restartování provedena něčím jiným než DSC (například Instalační službou systému Windows), zkombinujte toto nastavení s modulem xPendingReboot.

refreshFrequencyMins

number

30

Časový interval v minutách, ve kterém LCM kontroluje službu vyžádání, aby získala aktualizované konfigurace. Tato hodnota se ignoruje, pokud LCM není nakonfigurovaný v režimu vyžádání. Výchozí hodnota je 30.

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Name Typ Description
code

string

Kód chyby

message

string

Podrobná chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď při selhání operace

Name Typ Description
error

Error

GuestConfigurationAssignment

Přiřazení konfigurace hosta je přidružení mezi počítačem a konfigurací hosta.

Name Typ Description
id

string

ID prostředku ARM přiřazení konfigurace hosta

location

string

Oblast, ve které se virtuální počítač nachází.

name

string

Název přiřazení konfigurace hosta.

properties

GuestConfigurationAssignmentProperties

Vlastnosti přiřazení konfigurace hosta.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

type

string

Typ prostředku.

GuestConfigurationAssignmentProperties

Vlastnosti přiřazení konfigurace hosta

Name Typ Description
assignmentHash

string

Kombinovaná hodnota hash konfiguračního balíčku a parametrů.

complianceStatus

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

context

string

Zdroj, který inicioval přiřazení konfigurace hosta. Příklad: Azure Policy

guestConfiguration

GuestConfigurationNavigation

Konfigurace hosta, která se má přiřadit.

lastComplianceStatusChecked

string

Datum a čas poslední kontroly stavu dodržování předpisů

latestAssignmentReport

AssignmentReport

Poslední nahlášená sestava přiřazení konfigurace hosta.

latestReportId

string

ID nejnovější sestavy pro přiřazení konfigurace hosta.

parameterHash

string

hodnota hash parametru pro přiřazení konfigurace hosta.

provisioningState

provisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

resourceType

string

Typ prostředku – škálovací sada virtuálních počítačů / virtuální počítač

targetResourceId

string

ID prostředku virtuálního počítače.

vmssVMList

VMSSVMInfo[]

Seznam dat o dodržování předpisů virtuálních počítačů pro VMSS

GuestConfigurationNavigation

Konfigurace hosta je artefakt, který zapouzdřuje konfiguraci DSC a její závislosti. Artefakt je soubor zip obsahující konfiguraci DSC (jako MOF) a závislé prostředky a další závislosti, jako jsou moduly.

Name Typ Description
assignmentSource

string

Určuje původ konfigurace.

assignmentType

assignmentType

Určuje typ přiřazení a provedení konfigurace. Možné hodnoty jsou Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect a ApplyAndMonitor.

configurationParameter

ConfigurationParameter[]

Parametry konfigurace hosta.

configurationProtectedParameter

ConfigurationParameter[]

Parametry chráněné konfigurace pro konfiguraci hosta.

configurationSetting

ConfigurationSetting

Nastavení konfigurace pro konfiguraci hosta.

contentHash

string

Kombinovaná hodnota hash konfiguračního balíčku hosta a konfiguračních parametrů.

contentType

string

Určuje typ obsahu konfigurace. Možné hodnoty můžou být Předdefinované nebo Vlastní.

contentUri

string

Identifikátor URI úložiště, do kterého se nahraje konfigurační balíček hosta.

kind

kind

Druh konfigurace hosta. Příklad:DSC

name

string

Název konfigurace hosta.

version

string

Verze konfigurace hosta.

kind

Druh konfigurace hosta. Příklad:DSC

Name Typ Description
DSC

string

provisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

Name Typ Description
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která vytvořila prostředek.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

type

Typ sestavy, konzistence nebo počáteční

Name Typ Description
Consistency

string

Initial

string

VMInfo

Informace o virtuálním počítači.

Name Typ Description
id

string

ID prostředku Azure virtuálního počítače.

uuid

string

UUID (universally Unique Identifier) virtuálního počítače.

VMSSVMInfo

Informace o virtuálním počítači VMSS

Name Typ Description
complianceStatus

complianceStatus

Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.

lastComplianceChecked

string

Datum a čas poslední kontroly stavu dodržování předpisů

latestReportId

string

ID nejnovější sestavy pro přiřazení konfigurace hosta.

vmId

string

UUID virtuálního počítače.

vmResourceId

string

ID prostředku Azure virtuálního počítače.