Guest Configuration Assignments - Create Or Update

Служба:: Guest Configuration

Версия API:: 2024-04-05

Создает связь между виртуальной машиной и гостевой конфигурацией

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

Имя.	В	Обязательно	Тип	Описание
guestConfigurationAssignmentName	path	True	string	Имя назначения гостевой конфигурации.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	Имя виртуальной машины.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя.	Обязательно	Тип	Описание
name	True	string	Имя назначения гостевой конфигурации.
location		string	Регион, в котором находится виртуальная машина.
properties		GuestConfigurationAssignmentProperties	Свойства назначения гостевой конфигурации.

Ответы

Имя.	Тип	Описание
200 OK	GuestConfigurationAssignment	Операция обновления ресурса 'GuestConfigurationAssignment' выполнена успешно
201 Created	GuestConfigurationAssignment	Операция по созданию ресурса 'GuestConfigurationAssignment' выполнена успешно
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя.	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create or update guest configuration assignment

Образец запроса

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.guestconfig import GuestConfigurationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-guestconfig
# USAGE
    python create_or_update_guest_configuration_assignment.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = GuestConfigurationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.guest_configuration_assignments.create_or_update(
        guest_configuration_assignment_name="NotInstalledApplicationForWindows",
        resource_group_name="myResourceGroupName",
        vm_name="myVMName",
        parameters={
            "location": "westcentralus",
            "name": "NotInstalledApplicationForWindows",
            "properties": {
                "context": "Azure policy",
                "guestConfiguration": {
                    "assignmentType": "ApplyAndAutoCorrect",
                    "configurationParameter": [
                        {"name": "[InstalledApplication]NotInstalledApplicationResource1;Name", "value": "NotePad,sql"}
                    ],
                    "contentHash": "123contenthash",
                    "contentManagedIdentity": "test_identity",
                    "contentUri": "https://thisisfake/pacakge",
                    "name": "NotInstalledApplicationForWindows",
                    "version": "1.0.0.3",
                },
            },
        },
    )
    print(response)


# x-ms-original-file: 2024-04-05/createOrUpdateGuestConfigurationAssignment.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armguestconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration/v2"
)

// Generated from example definition: 2024-04-05/createOrUpdateGuestConfigurationAssignment.json
func ExampleAssignmentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armguestconfiguration.NewClientFactory("mySubscriptionId", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAssignmentsClient().CreateOrUpdate(ctx, "NotInstalledApplicationForWindows", "myResourceGroupName", "myVMName", armguestconfiguration.Assignment{
		Name:     to.Ptr("NotInstalledApplicationForWindows"),
		Location: to.Ptr("westcentralus"),
		Properties: &armguestconfiguration.AssignmentProperties{
			Context: to.Ptr("Azure policy"),
			GuestConfiguration: &armguestconfiguration.Navigation{
				Name:           to.Ptr("NotInstalledApplicationForWindows"),
				AssignmentType: to.Ptr(armguestconfiguration.AssignmentTypeApplyAndAutoCorrect),
				ConfigurationParameter: []*armguestconfiguration.ConfigurationParameter{
					{
						Name:  to.Ptr("[InstalledApplication]NotInstalledApplicationResource1;Name"),
						Value: to.Ptr("NotePad,sql"),
					},
				},
				ContentHash:            to.Ptr("123contenthash"),
				ContentManagedIdentity: to.Ptr("test_identity"),
				ContentURI:             to.Ptr("https://thisisfake/pacakge"),
				Version:                to.Ptr("1.0.0.3"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armguestconfiguration.AssignmentsClientCreateOrUpdateResponse{
	// 	Assignment: armguestconfiguration.Assignment{
	// 		Name: to.Ptr("NotInstalledApplicationForWindows"),
	// 		ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows"),
	// 		Location: to.Ptr("westcentralus"),
	// 		Properties: &armguestconfiguration.AssignmentProperties{
	// 			AssignmentHash: nil,
	// 			ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusPending),
	// 			Context: to.Ptr("Azure policy"),
	// 			GuestConfiguration: &armguestconfiguration.Navigation{
	// 				Name: to.Ptr("NotInstalledApplicationForWindows"),
	// 				AssignmentSource: to.Ptr("AzurePolicy"),
	// 				ConfigurationParameter: []*armguestconfiguration.ConfigurationParameter{
	// 					{
	// 						Name: to.Ptr("[InstalledApplication]NotInstalledApplicationResource1;Name"),
	// 						Value: to.Ptr("NotePad,sql"),
	// 					},
	// 				},
	// 				ContentType: nil,
	// 				Version: to.Ptr("1.0.0.3"),
	// 			},
	// 			LastComplianceStatusChecked: nil,
	// 			LatestReportID: nil,
	// 			ProvisioningState: to.Ptr(armguestconfiguration.ProvisioningStateSucceeded),
	// 			ResourceType: nil,
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { GuestConfigurationClient } = require("@azure/arm-guestconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates an association between a VM and guest configuration
 *
 * @summary creates an association between a VM and guest configuration
 * x-ms-original-file: 2024-04-05/createOrUpdateGuestConfigurationAssignment.json
 */
async function createOrUpdateGuestConfigurationAssignment() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "mySubscriptionId";
  const client = new GuestConfigurationClient(credential, subscriptionId);
  const result = await client.guestConfigurationAssignments.createOrUpdate(
    "NotInstalledApplicationForWindows",
    "myResourceGroupName",
    "myVMName",
    {
      name: "NotInstalledApplicationForWindows",
      location: "westcentralus",
      properties: {
        context: "Azure policy",
        guestConfiguration: {
          name: "NotInstalledApplicationForWindows",
          assignmentType: "ApplyAndAutoCorrect",
          configurationParameter: [
            {
              name: "[InstalledApplication]NotInstalledApplicationResource1;Name",
              value: "NotePad,sql",
            },
          ],
          contentHash: "123contenthash",
          contentManagedIdentity: "test_identity",
          contentUri: "https://thisisfake/pacakge",
          version: "1.0.0.3",
        },
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

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

Код состояния:: 201

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

Определения

Имя.	Описание
ActionAfterReboot	Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration
AssignmentInfo	Сведения о назначении гостевой конфигурации.
AssignmentReport
AssignmentReportResource	Ресурс назначения гостевой конфигурации.
AssignmentReportResourceComplianceReason	Причина и код соответствия ресурса назначения гостевой конфигурации.
AssignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.
ComplianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
ConfigurationInfo	Сведения о конфигурации.
ConfigurationMode	Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.
ConfigurationParameter	Представляет параметр конфигурации.
ConfigurationSetting	Параметр конфигурации LCM (Local Configuration Manager).
createdByType	Тип удостоверения, создавшего ресурс.
Error
ErrorResponse	Реакция на ошибку при сбое операции.
GuestConfigurationAssignment	Назначение гостевой конфигурации — это связь между компьютером и гостевой конфигурацией.
GuestConfigurationAssignmentProperties	Свойства назначения гостевой конфигурации.
GuestConfigurationNavigation	Гостевая конфигурация — это артефакт, инкапсулирующий конфигурацию DSC и ее зависимости. Артефакт — это ZIP-файл, содержащий конфигурацию DSC (как MOF) и зависимые ресурсы и другие зависимости, такие как модули.
Kind	Тип гостевой конфигурации. Например:DSC
ProvisioningState	Состояние подготовки, которое отображается только в ответе.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Type	Тип отчета, согласованности или начальной
VMInfo	Сведения о виртуальной машине.
VMSSVMInfo	Сведения о виртуальной машине VMSS

ActionAfterReboot

Перечисление

Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration

Значение	Описание
ContinueConfiguration
StopConfiguration

AssignmentInfo

Объект

Сведения о назначении гостевой конфигурации.

Имя.	Тип	Описание
configuration	ConfigurationInfo	Сведения о конфигурации.
name	string	Имя назначения гостевой конфигурации.

AssignmentReport

Объект

Имя.	Тип	Описание
assignment	AssignmentInfo	Сведения о конфигурации назначения гостевой конфигурации.
complianceStatus	ComplianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
endTime	string (date-time)	Дата окончания и время проверки состояния соответствия назначения гостевой конфигурации.
id	string	Идентификатор ресурса ARM отчета для назначения гостевой конфигурации.
operationType	Type	Тип отчета, согласованности или начальной
reportId	string	GUID, определяющий отчет о назначении гостевой конфигурации в подписке, группе ресурсов.
resources	AssignmentReportResource[]	Список ресурсов, для которых проверяется соответствие назначения гостевой конфигурации.
startTime	string (date-time)	Дата и время начала проверки состояния соответствия назначения гостевой конфигурации.
vm	VMInfo	Сведения о виртуальной машине.

AssignmentReportResource

Объект

Ресурс назначения гостевой конфигурации.

Имя.	Тип	Описание
complianceStatus	ComplianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
properties		Свойства ресурса назначения гостевой конфигурации.
reasons	AssignmentReportResourceComplianceReason[]	Причина соответствия и код причины для ресурса.
resourceId	string	Имя параметра ресурса назначения гостевой конфигурации.

AssignmentReportResourceComplianceReason

Объект

Причина и код соответствия ресурса назначения гостевой конфигурации.

Имя.	Тип	Описание
code	string	Код соответствия ресурса назначения гостевой конфигурации.
phrase	string	Причина соответствия ресурса назначения гостевой конфигурации.

AssignmentType

Перечисление

Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.

Значение	Описание
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

Перечисление

Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.

Значение	Описание
Compliant
NonCompliant
Pending

ConfigurationInfo

Объект

Сведения о конфигурации.

Имя.	Тип	Описание
name	string	Имя конфигурации.
version	string	Версия конфигурации.

ConfigurationMode

Перечисление

Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.

Значение	Описание
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Объект

Представляет параметр конфигурации.

Имя.	Тип	Описание
name	string	Имя параметра конфигурации.
value	string	Значение параметра конфигурации.

ConfigurationSetting

Объект

Параметр конфигурации LCM (Local Configuration Manager).

Имя.	Тип	Значение по умолчанию	Описание
actionAfterReboot	ActionAfterReboot		Указывает, что происходит после перезагрузки во время приложения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration
allowModuleOverwrite	boolean		Если значение true — новые конфигурации, скачанные из службы извлечения, могут перезаписать старые конфигурации на целевом узле. В противном случае — значение false
configurationMode	ConfigurationMode		Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.
configurationModeFrequencyMins	number (float)	15	Как часто текущая конфигурация проверяется и применяется в минутах. Это свойство игнорируется, если для свойства ConfigurationMode задано значение ApplyOnly. Значение по умолчанию — 15.
rebootIfNeeded	boolean		Установите для этого значение true, чтобы автоматически перезагрузить узел после настройки, требующей перезагрузки. В противном случае необходимо вручную перезагрузить узел для любой конфигурации, требующей ее. Значение по умолчанию — false. Чтобы использовать этот параметр при принятии условия перезагрузки, отличном от DSC (например, установщика Windows), объедините этот параметр с модулем xPendingReboot.
refreshFrequencyMins	number (float)	30	Интервал времени в минутах, в течение которого LCM проверяет службу извлечения, чтобы получить обновленные конфигурации. Это значение игнорируется, если LCM не настроен в режиме извлечения. Значение по умолчанию — 30.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

Error

Объект

Имя.	Тип	Описание
code	string	Код ошибки.
message	string	Подробное сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Объект

Реакция на ошибку при сбое операции.

Имя.	Тип	Описание
error	Error