Guest Configuration Assignments - Create Or Update

Tjänst:

Guest Configuration

API-version:

2024-04-05

Skapar en association mellan en virtuell dator och gästkonfiguration

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
guestConfigurationAssignmentName	path	True	string	Namnet på gästkonfigurationstilldelningen.
resourceGroupName	path	True	string	Resursgruppens namn. Reguljärt uttrycksmönster: ^[-\w\._]+$
subscriptionId	path	True	string	Prenumerations-ID som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vmName	path	True	string	Namnet på den virtuella datorn. Reguljärt uttrycksmönster: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
location	string	Region där den virtuella datorn finns.
name	string	Namnet på gästkonfigurationstilldelningen.
properties	GuestConfigurationAssignmentProperties	Egenskaper för gästkonfigurationstilldelningen.

Svar

Name	Typ	Description
200 OK	GuestConfigurationAssignment	OKEJ. Gästkonfigurationstilldelningen för den virtuella datorn har uppdaterats.
201 Created	GuestConfigurationAssignment	Skapad. Gästkonfigurationstilldelningen för den virtuella datorn har skapats.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create or update guest configuration assignment

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Definitioner

Name	Description
actionAfterReboot	Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration
AssignmentInfo	Information om gästkonfigurationstilldelningen.
AssignmentReport
AssignmentReportResource	Resursen för gästkonfigurationstilldelning.
AssignmentReportResourceComplianceReason	Orsak och kod för kompatibiliteten för gästkonfigurationstilldelningsresursen.
assignmentType	Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.
complianceStatus	Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.
ConfigurationInfo	Information om konfigurationen.
configurationMode	Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.
ConfigurationParameter	Representerar en konfigurationsparameter.
ConfigurationSetting	Konfigurationsinställning för LCM (Local Configuration Manager).
createdByType	Den typ av identitet som skapade resursen.
Error
ErrorResponse	Felsvar på ett åtgärdsfel
GuestConfigurationAssignment	Gästkonfigurationstilldelning är en association mellan en dator och gästkonfiguration.
GuestConfigurationAssignmentProperties	Egenskaper för gästkonfigurationstilldelning.
GuestConfigurationNavigation	Gästkonfiguration är en artefakt som kapslar in DSC-konfigurationen och dess beroenden. Artefakten är en zip-fil som innehåller DSC-konfiguration (som MOF) och beroende resurser och andra beroenden som moduler.
kind	Typ av gästkonfiguration. Till exempel:DSC
provisioningState	Etableringstillståndet, som bara visas i svaret.
systemData	Metadata som rör skapande och senaste ändring av resursen.
type	Typ av rapport, konsekvens eller initial
VMInfo	Information om den virtuella datorn.
VMSSVMInfo	Information om VMSS VM

actionAfterReboot

Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration

Name	Typ	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Information om gästkonfigurationstilldelningen.

Name	Typ	Description
configuration	ConfigurationInfo	Information om konfigurationen.
name	string	Namnet på gästkonfigurationstilldelningen.

AssignmentReport

Name	Typ	Description
assignment	AssignmentInfo	Konfigurationsinformation för gästkonfigurationstilldelningen.
complianceStatus	complianceStatus	Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.
endTime	string	Slutdatum och tid för kontroll av efterlevnadsstatus för gästkonfigurationstilldelning.
id	string	ARM-resurs-ID för rapporten för gästkonfigurationstilldelningen.
operationType	type	Typ av rapport, konsekvens eller initial
reportId	string	GUID som identifierar rapporten för gästkonfigurationstilldelning under en prenumeration, resursgrupp.
resources	AssignmentReportResource[]	Listan över resurser som gästkonfigurationstilldelningsefterlevnad är markerad för.
startTime	string	Startdatum och tid för kontroll av efterlevnadsstatus för gästkonfigurationstilldelning.
vm	VMInfo	Information om den virtuella datorn.

AssignmentReportResource

Resursen för gästkonfigurationstilldelning.

Name	Typ	Description
complianceStatus	complianceStatus	Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.
properties	object	Egenskaper för en resurs för gästkonfigurationstilldelning.
reasons	AssignmentReportResourceComplianceReason[]	Efterlevnadsorsak och orsakskod för en resurs.
resourceId	string	Namnet på resursinställningen för gästkonfigurationstilldelning.

AssignmentReportResourceComplianceReason

Orsak och kod för kompatibiliteten för gästkonfigurationstilldelningsresursen.

Name	Typ	Description
code	string	Kod för kompatibilitet för gästkonfigurationstilldelningsresursen.
phrase	string	Orsak till kompatibiliteten för gästkonfigurationstilldelningsresursen.

assignmentType

Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.

Name	Typ	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.

Name	Typ	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Information om konfigurationen.

Name	Typ	Description
name	string	Namnet på konfigurationen.
version	string	Version av konfigurationen.

configurationMode

Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.

Name	Typ	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Representerar en konfigurationsparameter.

Name	Typ	Description
name	string	Namnet på konfigurationsparametern.
value	string	Värdet för konfigurationsparametern.

ConfigurationSetting

Konfigurationsinställning för LCM (Local Configuration Manager).

Name	Typ	Standardvärde	Description
actionAfterReboot	actionAfterReboot		Anger vad som händer efter en omstart under tillämpningen av en konfiguration. Möjliga värden är ContinueConfiguration och StopConfiguration
allowModuleOverwrite	boolean		Om sant – nya konfigurationer som hämtats från pull-tjänsten tillåts skriva över de gamla på målnoden. Annars falskt
configurationMode	configurationMode		Anger hur LCM(Local Configuration Manager) faktiskt tillämpar konfigurationen på målnoderna. Möjliga värden är ApplyOnly, ApplyAndMonitor och ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Hur ofta, på några minuter, kontrolleras och tillämpas den aktuella konfigurationen. Den här egenskapen ignoreras om egenskapen ConfigurationMode är inställd på ApplyOnly. Standardvärdet är 15.
rebootIfNeeded	boolean		Ställ in detta på true för att automatiskt starta om noden efter att en konfiguration som kräver omstart har tillämpats. Annars måste du starta om noden manuellt för alla konfigurationer som kräver den. Standardvärdet är falskt. Om du vill använda den här inställningen när ett omstartsvillkor utförs av något annat än DSC (till exempel Windows Installer) kombinerar du den här inställningen med modulen xPendingReboot.
refreshFrequencyMins	number	30	Tidsintervallet, i minuter, där LCM kontrollerar en pull-tjänst för att få uppdaterade konfigurationer. Det här värdet ignoreras om LCM inte har konfigurerats i pull-läge. Standardvärdet är 30.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Name	Typ	Description
code	string	Felkod.
message	string	Detaljerat felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvar på ett åtgärdsfel

Name	Typ	Description
error	Error

GuestConfigurationAssignment

Gästkonfigurationstilldelning är en association mellan en dator och gästkonfiguration.

Name	Typ	Description
id	string	ARM-resurs-ID för gästkonfigurationstilldelningen.
location	string	Region där den virtuella datorn finns.
name	string	Namnet på gästkonfigurationstilldelningen.
properties	GuestConfigurationAssignmentProperties	Egenskaper för gästkonfigurationstilldelningen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen.

GuestConfigurationAssignmentProperties

Egenskaper för gästkonfigurationstilldelning.

Name	Typ	Description
assignmentHash	string	Kombinerad hash för konfigurationspaketet och parametrarna.
complianceStatus	complianceStatus	Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.
context	string	Källan som initierade gästkonfigurationstilldelningen. Ex: Azure Policy
guestConfiguration	GuestConfigurationNavigation	Gästkonfigurationen som ska tilldelas.
lastComplianceStatusChecked	string	Datum och tid då senaste efterlevnadsstatus kontrollerades.
latestAssignmentReport	AssignmentReport	Senast rapporterad rapport om gästkonfigurationstilldelning.
latestReportId	string	ID för den senaste rapporten för gästkonfigurationstilldelningen.
parameterHash	string	parameter-hash för gästkonfigurationstilldelningen.
provisioningState	provisioningState	Etableringstillståndet, som bara visas i svaret.
resourceType	string	Resurstyp – VMSS/VM
targetResourceId	string	Resurs-ID för virtuella datorer.
vmssVMList	VMSSVMInfo[]	Listan över vm-efterlevnadsdata för VMSS

GuestConfigurationNavigation

Gästkonfiguration är en artefakt som kapslar in DSC-konfigurationen och dess beroenden. Artefakten är en zip-fil som innehåller DSC-konfiguration (som MOF) och beroende resurser och andra beroenden som moduler.

Name	Typ	Description
assignmentSource	string	Anger konfigurationens ursprung.
assignmentType	assignmentType	Anger tilldelningstyp och körning av konfigurationen. Möjliga värden är Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect och ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Konfigurationsparametrarna för gästkonfigurationen.
configurationProtectedParameter	ConfigurationParameter[]	De skyddade konfigurationsparametrarna för gästkonfigurationen.
configurationSetting	ConfigurationSetting	Konfigurationsinställningen för gästkonfigurationen.
contentHash	string	Kombinerad hash för gästkonfigurationspaketet och konfigurationsparametrarna.
contentManagedIdentity	string	Hanterad identitet med lagringsåtkomst för gästkonfigurationspaketet och konfigurationsparametrarna.
contentType	string	Anger konfigurationens innehållstyp. Möjliga värden kan vara Inbyggda eller Anpassade.
contentUri	string	Uri för lagringen där gästkonfigurationspaketet laddas upp.
kind	kind	Typ av gästkonfiguration. Till exempel:DSC
name	string	Namnet på gästkonfigurationen.
version	string	Version av gästkonfigurationen.

kind

Typ av gästkonfiguration. Till exempel:DSC

Name	Typ	Description
DSC	string

provisioningState

Etableringstillståndet, som bara visas i svaret.

Name	Typ	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

type

Typ av rapport, konsekvens eller initial

Name	Typ	Description
Consistency	string
Initial	string

VMInfo

Information om den virtuella datorn.

Name	Typ	Description
id	string	Azure-resurs-ID för den virtuella datorn.
uuid	string	UUID (universellt unik identifierare) för den virtuella datorn.

VMSSVMInfo

Information om VMSS VM

Name	Typ	Description
complianceStatus	complianceStatus	Ett värde som anger datorns efterlevnadsstatus för den tilldelade gästkonfigurationen.
lastComplianceChecked	string	Datum och tid då senaste efterlevnadsstatus kontrollerades.
latestReportId	string	ID för den senaste rapporten för gästkonfigurationstilldelningen.
vmId	string	UUID för den virtuella datorn.
vmResourceId	string	Azure-resurs-ID för den virtuella datorn.