Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

Služba:: Guest Configuration

Verze rozhraní API:: 2024-04-05

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=2024-04-05

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
guestConfigurationAssignmentName	path	True	string pattern: ^[^<>%&:\\?/#]*$	Název přiřazení konfigurace hosta.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	Název virtuálního počítače.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název přiřazení konfigurace hosta.
location		string	Oblast, kde se nachází virtuální počítač
properties		GuestConfigurationAssignmentProperties	Vlastnosti přiřazení konfigurace hosta

Odpovědi

Name	Typ	Description
200 OK	GuestConfigurationAssignment	Operace aktualizace prostředku GuestConfigurationAssignment byla úspěšná
201 Created	GuestConfigurationAssignment	Operace vytvoření prostředku GuestConfigurationAssignment byla úspěšná
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

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

HTTP

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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",
      "contentUri": "https://thisisfake/pacakge",
      "version": "1.0.0.0"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/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,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

Stavový kód:: 201

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

Definice

Name	Description
ActionAfterReboot	Určuje, co se stane po restartování během aplikace 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 pro dodržování předpisů prostředku přiřazení konfigurace hosta
AssignmentType	Určuje typ přiřazení a spuštění 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(Local 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 (Local Configuration Manager).
createdByType	Typ identity, která prostředek vytvořila.
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 iniciály
VMInfo	Informace o virtuálním počítači
VMSSVMInfo	Informace o virtuálním počítači VMSS

ActionAfterReboot

Výčet

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

Hodnota	Description
ContinueConfiguration
StopConfiguration

AssignmentInfo

Objekt

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

Objekt

Name	Typ	Description
assignment	AssignmentInfo	Podrobnosti o konfiguraci hosta
complianceStatus	ComplianceStatus	Hodnota označující stav dodržování předpisů počítače pro přiřazenou konfiguraci hosta.
endTime	string (date-time)	Koncové datum a čas kontroly stavu přiřazení konfigurace hosta
id	string	ID prostředku ARM pro přiřazení konfigurace hosta
operationType	Type	Typ sestavy, konzistence nebo iniciály
reportId	string	IDENTIFIKÁTOR GUID, který identifikuje sestavu přiřazení konfigurace hosta v rámci předplatného, skupiny prostředků.
resources	AssignmentReportResource[]	Seznam prostředků, pro které je zaškrtnuto dodržování předpisů pro přiřazení konfigurace hosta.
startTime	string (date-time)	Počáteční datum a čas kontroly stavu dodržování předpisů pro přiřazení konfigurace hosta
vm	VMInfo	Informace o virtuálním počítači

AssignmentReportResource

Objekt

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		Vlastnosti prostředku přiřazení konfigurace hosta
reasons	AssignmentReportResourceComplianceReason[]	Důvod dodržování předpisů a kód důvodu prostředku
resourceId	string	Název nastavení prostředku přiřazení konfigurace hosta

AssignmentReportResourceComplianceReason

Objekt

Důvod a kód pro 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

Výčet

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

Hodnota	Description
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

Výčet

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

Hodnota	Description
Compliant
NonCompliant
Pending

ConfigurationInfo

Objekt

Informace o konfiguraci

Name	Typ	Description
name	string	Název konfigurace.
version	string	Verze konfigurace

ConfigurationMode

Výčet

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

Hodnota	Description
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Objekt

Představuje parametr konfigurace.

Name	Typ	Description
name	string	Název parametru konfigurace.
value	string	Hodnota parametru konfigurace.

ConfigurationSetting

Objekt

Nastavení konfigurace LCM (Local Configuration Manager).

Name	Typ	Default value	Description
actionAfterReboot	ActionAfterReboot		Určuje, co se stane po restartování během aplikace konfigurace. Možné hodnoty jsou ContinueConfiguration a StopConfiguration.
allowModuleOverwrite	boolean		Pokud je hodnota true – nové konfigurace stažené ze služby vyžádané replikace můžou přepsat staré konfigurace na cílovém uzlu. V opačném případě nepravda
configurationMode	ConfigurationMode		Určuje, jak LCM(Local Configuration Manager) skutečně použije konfiguraci na cílové uzly. Možné hodnoty jsou ApplyOnly, ApplyAndMonitor a ApplyAndAutoCorrect.
configurationModeFrequencyMins	number (float)	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		Nastavte tuto hodnotu na hodnotu True, aby se uzel po použití konfigurace, která vyžaduje restartování, automaticky restartuje. Jinak budete muset ručně restartovat uzel pro všechny konfigurace, které ho vyžadují. Výchozí hodnota je false. Chcete-li toto nastavení použít, pokud je podmínka restartování přijata něčím jiným než DSC (například Instalační služba systému Windows), zkombinujte toto nastavení s modulem xPendingReboot.
refreshFrequencyMins	number (float)	30	Časový interval v minutách, ve kterém LCM kontroluje službu vyžádané replikace, aby získala aktualizované konfigurace. Tato hodnota se ignoruje, pokud není LCM nakonfigurovaný v režimu vyžádání obsahu. Výchozí hodnota je 30.

createdByType

Výčet

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

Hodnota	Description
User
Application
ManagedIdentity
Key

Error

Objekt

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobná chybová zpráva označující, proč operace selhala.

ErrorResponse

Objekt

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

Name	Typ	Description
error	Error

GuestConfigurationAssignment

Objekt

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

Name	Typ	Description
id	string (arm-id)	ID prostředku ARM přiřazení konfigurace hosta
location	string	Oblast, kde se nachází virtuální počítač
name	string	Název přiřazení konfigurace hosta.
properties	GuestConfigurationAssignmentProperties	Vlastnosti přiřazení konfigurace hosta
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku.

GuestConfigurationAssignmentProperties

Objekt

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 (date-time)	Datum a čas, kdy byl zkontrolován poslední stav 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 – VMSS / virtuální počítač
targetResourceId	string	ID prostředku virtuálního počítače.
vmssVMList	VMSSVMInfo[]	Seznam dat dodržování předpisů virtuálních počítačů pro VMSS

GuestConfigurationNavigation

Objekt

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 spuštění konfigurace. Možné hodnoty jsou Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect a ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Parametry konfigurace pro konfiguraci 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 parametrů konfigurace
contentManagedIdentity	string	Spravovaná identita s přístupem k úložišti konfiguračního balíčku hosta a parametrů konfigurace
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ě, kde 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

Výčet

Druh konfigurace hosta. Příklad:DSC

Hodnota	Description
DSC

ProvisioningState

Výčet

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

Hodnota	Description
Succeeded
Failed
Canceled
Created

systemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Type

Výčet

Typ sestavy, konzistence nebo iniciály

Hodnota	Description
Consistency
Initial

VMInfo

Objekt

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

Objekt

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 (date-time)	Datum a čas, kdy byl zkontrolován poslední stav 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

Sdílet prostřednictvím

Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create or update guest configuration assignment

Ukázkový požadavek

Ukázková odpověď

Definice

ActionAfterReboot

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

AssignmentType

ComplianceStatus

ConfigurationInfo

ConfigurationMode

ConfigurationParameter

ConfigurationSetting

createdByType

Error

ErrorResponse

GuestConfigurationAssignment

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Kind

ProvisioningState

systemData

Type

VMInfo

VMSSVMInfo