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	Имя группы ресурсов. Шаблон регулярного выражения: ^[-\w\._]+$
subscriptionId	path	True	string	Идентификатор подписки, однозначно определяющий подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
vmName	path	True	string	Имя виртуальной машины. Шаблон регулярного выражения: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	Версия клиентского API.

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

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

Ответы

Имя	Тип	Описание
200 OK	GuestConfigurationAssignment	ХОРОШО. Назначение гостевой конфигурации виртуальной машины было успешно обновлено.
201 Created	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

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

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

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

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

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

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

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

Определения

Имя	Описание
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	string
StopConfiguration	string

AssignmentInfo

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

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

AssignmentReport

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

AssignmentReportResource

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

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

AssignmentReportResourceComplianceReason

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

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

assignmentType

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

Имя	Тип	Описание
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

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

Имя	Тип	Описание
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

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

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

configurationMode

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

Имя	Тип	Описание
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

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

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

ConfigurationSetting

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

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

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

Error

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

ErrorResponse

Ответ на ошибку сбоя операции

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

GuestConfigurationAssignment

Назначение гостевой конфигурации — это связь между компьютером и гостевой конфигурацией.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM назначения гостевой конфигурации.
location	string	Регион, в котором находится виртуальная машина.
name	string	Имя назначения гостевой конфигурации.
properties	GuestConfigurationAssignmentProperties	Свойства назначения гостевой конфигурации.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса.

GuestConfigurationAssignmentProperties

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

Имя	Тип	Описание
assignmentHash	string	Объединенный хэш пакета конфигурации и параметров.
complianceStatus	complianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
context	string	Источник, инициирующий назначение гостевой конфигурации. Например: политика Azure
guestConfiguration	GuestConfigurationNavigation	Назначаемая гостевая конфигурация.
lastComplianceStatusChecked	string	Дата и время проверки последнего состояния соответствия.
latestAssignmentReport	AssignmentReport	Последний отчет о назначении гостевой конфигурации.
latestReportId	string	Идентификатор последнего отчета для назначения гостевой конфигурации.
parameterHash	string	хэш параметра для назначения гостевой конфигурации.
provisioningState	provisioningState	Состояние подготовки, которое отображается только в ответе.
resourceType	string	Тип ресурса — VMSS/ VM
targetResourceId	string	Идентификатор ресурса виртуальной машины.
vmssVMList	VMSSVMInfo[]	Список данных о соответствии виртуальных машин для VMSS

GuestConfigurationNavigation

Гостевая конфигурация — это артефакт, инкапсулирующий конфигурацию DSC и ее зависимости. Артефакт — это ZIP-файл, содержащий конфигурацию DSC (как MOF) и зависимые ресурсы и другие зависимости, такие как модули.

Имя	Тип	Описание
assignmentSource	string	Указывает источник конфигурации.
assignmentType	assignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Параметры конфигурации гостевой конфигурации.
configurationProtectedParameter	ConfigurationParameter[]	Защищенные параметры конфигурации для гостевой конфигурации.
configurationSetting	ConfigurationSetting	Параметр конфигурации для гостевой конфигурации.
contentHash	string	Объединенный хэш пакета гостевой конфигурации и параметров конфигурации.
contentManagedIdentity	string	Управляемое удостоверение с доступом к хранилищу пакета гостевой конфигурации и параметров конфигурации.
contentType	string	Указывает тип контента конфигурации. Возможные значения могут быть встроенными или настраиваемыми.
contentUri	string	Uri хранилища, в котором отправляется пакет гостевой конфигурации.
kind	kind	Тип гостевой конфигурации. Например:DSC
name	string	Имя гостевой конфигурации.
version	string	Версия гостевой конфигурации.

kind

Тип гостевой конфигурации. Например:DSC

Имя	Тип	Описание
DSC	string

provisioningState

Состояние подготовки, которое отображается только в ответе.

Имя	Тип	Описание
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

type

Тип отчета, согласованности или начальной

Имя	Тип	Описание
Consistency	string
Initial	string

VMInfo

Сведения о виртуальной машине.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure виртуальной машины.
uuid	string	UUID (универсальный уникальный идентификатор) виртуальной машины.

VMSSVMInfo

Сведения о виртуальной машине VMSS

Имя	Тип	Описание
complianceStatus	complianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
lastComplianceChecked	string	Дата и время проверки последнего состояния соответствия.
latestReportId	string	Идентификатор последнего отчета для назначения гостевой конфигурации.
vmId	string	UUID виртуальной машины.
vmResourceId	string	Идентификатор ресурса Azure виртуальной машины.