Guest Configuration Assignments - Create Or Update

Služba:

Guest Configuration

Verze rozhraní API:

2024-04-05

Vytvoří přidružení mezi virtuálním počítačem a konfigurací hosta.

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
guestConfigurationAssignmentName	path	True	string	Název přiřazení konfigurace hosta.
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 tvoří 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, 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

Odpovědi

Name	Typ	Description
200 OK	GuestConfigurationAssignment	OK. Přiřazení konfigurace hosta pro virtuální počítač bylo úspěšně aktualizováno.
201 Created	GuestConfigurationAssignment	Vytvořil. Přiřazení konfigurace hosta pro virtuální počítač bylo úspěšně vytvořeno.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

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ěď 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

Určuje, co se stane po restartování během aplikace 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 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 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	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

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 prostředku
resourceId	string	Název nastavení prostředku přiřazení konfigurace hosta

AssignmentReportResourceComplianceReason

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

Určuje typ přiřazení a spuštění 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(Local 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 parametru konfigurace.
value	string	Hodnota parametru konfigurace.

ConfigurationSetting

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

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

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ěď 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, 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

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

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

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á prostředek vytvořila.
lastModifiedAt	string	Č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

Typ sestavy, konzistence nebo iniciály

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