Guest Configuration Assignments - Create Or Update

Service:

Guest Configuration

API-versie:

2024-04-05

Hiermee maakt u een koppeling tussen een VM en een gastconfiguratie

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

Name	In	Vereist	Type	Description
guestConfigurationAssignmentName	path	True	string	Naam van de toewijzing van de gastconfiguratie.
resourceGroupName	path	True	string	De naam van de resourcegroep. Regex-patroon: ^[-\w\._]+$
subscriptionId	path	True	string	Abonnements-id die het Microsoft Azure-abonnement uniek identificeert. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
vmName	path	True	string	De naam van de virtuele machine. Regex-patroon: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
location	string	Regio waar de VIRTUELE machine zich bevindt.
name	string	Naam van de toewijzing van de gastconfiguratie.
properties	GuestConfigurationAssignmentProperties	Eigenschappen van de toewijzing van de gastconfiguratie.

Antwoorden

Name	Type	Description
200 OK	GuestConfigurationAssignment	OK. De toewijzing van de gastconfiguratie voor de virtuele machine is bijgewerkt.
201 Created	GuestConfigurationAssignment	Geschapen. De toewijzing van de gastconfiguratie voor de VIRTUELE machine is gemaakt.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create or update guest configuration assignment

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
actionAfterReboot	Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration
AssignmentInfo	Informatie over de toewijzing van de gastconfiguratie.
AssignmentReport
AssignmentReportResource	De resource voor de toewijzing van gastconfiguraties.
AssignmentReportResourceComplianceReason	Reden en code voor de naleving van de toewijzingsresource van de gastconfiguratie.
assignmentType	Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor.
complianceStatus	Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.
ConfigurationInfo	Informatie over de configuratie.
configurationMode	Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect.
ConfigurationParameter	Vertegenwoordigt een configuratieparameter.
ConfigurationSetting	Configuratie-instelling van LCM (Local Configuration Manager).
createdByType	Het type identiteit waarmee de resource is gemaakt.
Error
ErrorResponse	Foutreactie van een bewerkingsfout
GuestConfigurationAssignment	Toewijzing van gastconfiguratie is een koppeling tussen een computer en gastconfiguratie.
GuestConfigurationAssignmentProperties	Eigenschappen van gastconfiguratietoewijzing.
GuestConfigurationNavigation	Gastconfiguratie is een artefact dat DSC-configuratie en de bijbehorende afhankelijkheden inkapselt. Het artefact is een ZIP-bestand met DSC-configuratie (als MOF) en afhankelijke resources en andere afhankelijke afhankelijkheden, zoals modules.
kind	Soort gastconfiguratie. Bijvoorbeeld: DSC
provisioningState	De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	Type rapport, consistentie of initiële
VMInfo	Informatie over de VIRTUELE machine.
VMSSVMInfo	Informatie over VMSS-VM

actionAfterReboot

Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration

Name	Type	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informatie over de toewijzing van de gastconfiguratie.

Name	Type	Description
configuration	ConfigurationInfo	Informatie over de configuratie.
name	string	Naam van de toewijzing van de gastconfiguratie.

AssignmentReport

Name	Type	Description
assignment	AssignmentInfo	Configuratiedetails van de toewijzing van de gastconfiguratie.
complianceStatus	complianceStatus	Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.
endTime	string	Einddatum en tijd van de nalevingsstatus van de gastconfiguratietoewijzing.
id	string	ARM-resource-id van het rapport voor de toewijzing van de gastconfiguratie.
operationType	type	Type rapport, consistentie of initiële
reportId	string	GUID die het rapport voor gastconfiguratietoewijzing identificeert onder een abonnement, resourcegroep.
resources	AssignmentReportResource[]	De lijst met resources waarvoor naleving van gastconfiguratietoewijzingen is gecontroleerd.
startTime	string	Begindatum en -tijd van de nalevingsstatus van de gastconfiguratietoewijzing.
vm	VMInfo	Informatie over de VIRTUELE machine.

AssignmentReportResource

De resource voor de toewijzing van gastconfiguraties.

Name	Type	Description
complianceStatus	complianceStatus	Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.
properties	object	Eigenschappen van een resource voor gastconfiguratietoewijzing.
reasons	AssignmentReportResourceComplianceReason[]	Reden en reden voor naleving voor een resource.
resourceId	string	Naam van de resource-instelling van de gastconfiguratietoewijzing.

AssignmentReportResourceComplianceReason

Reden en code voor de naleving van de toewijzingsresource van de gastconfiguratie.

Name	Type	Description
code	string	Code voor de naleving van de resource voor gastconfiguratietoewijzing.
phrase	string	Reden voor de naleving van de toewijzingsresource van de gastconfiguratie.

assignmentType

Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor.

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.

Name	Type	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informatie over de configuratie.

Name	Type	Description
name	string	Naam van de configuratie.
version	string	Versie van de configuratie.

configurationMode

Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect.

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Vertegenwoordigt een configuratieparameter.

Name	Type	Description
name	string	Naam van de configuratieparameter.
value	string	Waarde van de configuratieparameter.

ConfigurationSetting

Configuratie-instelling van LCM (Local Configuration Manager).

Name	Type	Default value	Description
actionAfterReboot	actionAfterReboot		Hiermee geeft u op wat er gebeurt na het opnieuw opstarten tijdens de toepassing van een configuratie. De mogelijke waarden zijn ContinueConfiguration en StopConfiguration
allowModuleOverwrite	boolean		Indien waar: nieuwe configuraties die zijn gedownload van de pull-service, mogen de oude configuraties op het doelknooppunt overschrijven. Anders, onwaar
configurationMode	configurationMode		Hiermee geeft u op hoe de LCM (Local Configuration Manager) de configuratie daadwerkelijk toepast op de doelknooppunten. Mogelijke waarden zijn ApplyOnly, ApplyAndMonitor en ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Hoe vaak, in minuten, de huidige configuratie wordt gecontroleerd en toegepast. Deze eigenschap wordt genegeerd als de eigenschap ConfigurationMode is ingesteld op ApplyOnly. De standaardwaarde is 15.
rebootIfNeeded	boolean		Stel dit in op True om het knooppunt automatisch opnieuw op te starten nadat een configuratie waarvoor opnieuw opstarten is vereist, is toegepast. Anders moet u het knooppunt handmatig opnieuw opstarten voor elke configuratie die dit vereist. De standaardwaarde is onwaar. Als u deze instelling wilt gebruiken wanneer een voorwaarde voor opnieuw opstarten wordt uitgevoerd door iets anders dan DSC (zoals Windows Installer), combineert u deze instelling met de xPendingReboot-module.
refreshFrequencyMins	number	30	Het tijdsinterval, in minuten, waarmee de LCM een pull-service controleert om bijgewerkte configuraties op te halen. Deze waarde wordt genegeerd als de LCM niet is geconfigureerd in de pull-modus. De standaardwaarde is 30.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Name	Type	Description
code	string	Foutcode.
message	string	Detailfoutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Foutreactie van een bewerkingsfout

Name	Type	Description
error	Error

GuestConfigurationAssignment

Toewijzing van gastconfiguratie is een koppeling tussen een computer en gastconfiguratie.

Name	Type	Description
id	string	ARM-resource-id van de toewijzing van de gastconfiguratie.
location	string	Regio waar de VIRTUELE machine zich bevindt.
name	string	Naam van de toewijzing van de gastconfiguratie.
properties	GuestConfigurationAssignmentProperties	Eigenschappen van de toewijzing van de gastconfiguratie.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource.

GuestConfigurationAssignmentProperties

Eigenschappen van gastconfiguratietoewijzing.

Name	Type	Description
assignmentHash	string	Gecombineerde hash van het configuratiepakket en de parameters.
complianceStatus	complianceStatus	Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.
context	string	De bron waarmee de toewijzing van de gastconfiguratie is gestart. Bijvoorbeeld: Azure Policy
guestConfiguration	GuestConfigurationNavigation	De gastconfiguratie die moet worden toegewezen.
lastComplianceStatusChecked	string	Datum en tijd waarop de laatste nalevingsstatus is gecontroleerd.
latestAssignmentReport	AssignmentReport	Rapport over de laatste gerapporteerde gastconfiguratietoewijzing.
latestReportId	string	Id van het meest recente rapport voor de toewijzing van de gastconfiguratie.
parameterHash	string	parameter-hash voor de toewijzing van de gastconfiguratie.
provisioningState	provisioningState	De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.
resourceType	string	Type van de resource - VMSS/VM
targetResourceId	string	VM-resource-id.
vmssVMList	VMSSVMInfo[]	De lijst met VM-nalevingsgegevens voor VMSS

GuestConfigurationNavigation

Gastconfiguratie is een artefact dat DSC-configuratie en de bijbehorende afhankelijkheden inkapselt. Het artefact is een ZIP-bestand met DSC-configuratie (als MOF) en afhankelijke resources en andere afhankelijke afhankelijkheden, zoals modules.

Name	Type	Description
assignmentSource	string	Hiermee geeft u de oorsprong van de configuratie.
assignmentType	assignmentType	Hiermee geeft u het toewijzingstype en de uitvoering van de configuratie. Mogelijke waarden zijn Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect en ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	De configuratieparameters voor de gastconfiguratie.
configurationProtectedParameter	ConfigurationParameter[]	De beveiligde configuratieparameters voor de gastconfiguratie.
configurationSetting	ConfigurationSetting	De configuratie-instelling voor de gastconfiguratie.
contentHash	string	Gecombineerde hash van het gastconfiguratiepakket en configuratieparameters.
contentManagedIdentity	string	Beheerde identiteit met opslagtoegang tot het gastconfiguratiepakket en configuratieparameters.
contentType	string	Hiermee geeft u het inhoudstype van de configuratie. Mogelijke waarden kunnen ingebouwde of aangepaste waarden zijn.
contentUri	string	Uri van de opslag waar het gastconfiguratiepakket wordt geüpload.
kind	kind	Soort gastconfiguratie. Bijvoorbeeld: DSC
name	string	Naam van de gastconfiguratie.
version	string	Versie van de gastconfiguratie.

kind

Soort gastconfiguratie. Bijvoorbeeld: DSC

Name	Type	Description
DSC	string

provisioningState

De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.

Name	Type	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

type

Type rapport, consistentie of initiële

Name	Type	Description
Consistency	string
Initial	string

VMInfo

Informatie over de VIRTUELE machine.

Name	Type	Description
id	string	Azure-resource-id van de VIRTUELE machine.
uuid	string	UUID (Universally Unique Identifier) van de VIRTUELE machine.

VMSSVMInfo

Informatie over VMSS-VM

Name	Type	Description
complianceStatus	complianceStatus	Een waarde die de nalevingsstatus van de machine aangeeft voor de toegewezen gastconfiguratie.
lastComplianceChecked	string	Datum en tijd waarop de laatste nalevingsstatus is gecontroleerd.
latestReportId	string	Id van het meest recente rapport voor de toewijzing van de gastconfiguratie.
vmId	string	UUID van de VIRTUELE machine.
vmResourceId	string	Azure-resource-id van de VIRTUELE machine.