Поделиться через


Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2022-01-25

Параметры 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

Все в порядке. Назначение гостевой конфигурации для подключенной виртуальной машины Sphere было успешно обновлено.

201 Created

GuestConfigurationAssignment

Создан. Назначение гостевой конфигурации для подключенной виртуальной машины Sphere создано успешно.

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.ConnectedVMwarevSphere/virtualmachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows?api-version=2022-01-25

{
  "location": "westcentralus",
  "name": "NotInstalledApplicationForWindows",
  "properties": {
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "version": "1.0.0.0",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

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

{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}
{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/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,
      "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 (локальный 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 (локальный 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 или виртуальная машина

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

Объединенный хэш пакета гостевой конфигурации и параметров конфигурации.

contentType

string

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

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 виртуальной машины.