Guest Configuration Assignments - RG List
Вывод списка всех назначений гостевой конфигурации для группы ресурсов.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Regex pattern: |
subscription
|
path | True |
string |
Идентификатор подписки, который однозначно идентифицирует подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API клиента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
204 No Content |
Нет содержимого |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
List all guest configuration assignments for a resource group
Sample Request
Sample Response
[
{
"location": "centraluseuap",
"id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2",
"name": "AuditSecureProtocol2",
"properties": {
"complianceStatus": "Compliant",
"assignmentHash": "content hash",
"latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
"lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
"context": null,
"guestConfiguration": {
"kind": null,
"name": "AuditSecureProtocol2",
"version": "1.0.0.3",
"contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip",
"contentHash": "content hash",
"configurationParameter": [],
"configurationSetting": null
},
"provisioningState": null
}
},
{
"location": "centraluseuap",
"id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment",
"name": "myAssignment",
"properties": {
"complianceStatus": "Compliant",
"assignmentHash": "content hash",
"latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
"lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
"context": null,
"guestConfiguration": {
"kind": null,
"name": "myAssignment",
"version": "1.0.0.3",
"contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip",
"contentHash": "content hash",
"configurationParameter": [],
"configurationSetting": null
},
"provisioningState": null
}
}
]
Определения
Имя | Описание |
---|---|
action |
Указывает, что будет происходить после перезагрузки в процессе применения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration. |
Assignment |
Сведения о назначении гостевой конфигурации. |
Assignment |
|
Assignment |
Ресурс назначения гостевой конфигурации. |
Assignment |
Причина и код для соответствия ресурса назначения гостевой конфигурации. |
assignment |
Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor. |
compliance |
Значение , указывающее состояние соответствия компьютера для назначенной гостевой конфигурации. |
Configuration |
Сведения о конфигурации. |
configuration |
Указывает, как LCM(Local Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect. |
Configuration |
Представляет параметр конфигурации. |
Configuration |
Параметр конфигурации LCM (local Configuration Manager). |
created |
Тип удостоверения, создавшего ресурс. |
Error | |
Error |
Ответ об ошибке при сбое операции |
Guest |
Назначение гостевой конфигурации — это связь между компьютером и гостевой конфигурацией. |
Guest |
Ответ операции назначения гостевой конфигурации списка. |
Guest |
Свойства назначения гостевой конфигурации. |
Guest |
Гостевая конфигурация — это артефакт, который инкапсулирует конфигурацию DSC и ее зависимости. Артефакт представляет собой ZIP-файл, содержащий конфигурацию DSC (в виде MOF), зависимые ресурсы и другие зависимости, такие как модули. |
kind |
Тип гостевой конфигурации. Например: DSC |
provisioning |
Состояние подготовки, которое отображается только в ответе. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
type |
Тип отчета, согласованность или начальная |
VMInfo |
Сведения о виртуальной машине. |
VMSSVMInfo |
Сведения о виртуальной машине VMSS |
actionAfterReboot
Указывает, что будет происходить после перезагрузки в процессе применения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration.
Имя | Тип | Описание |
---|---|---|
ContinueConfiguration |
string |
|
StopConfiguration |
string |
AssignmentInfo
Сведения о назначении гостевой конфигурации.
Имя | Тип | Описание |
---|---|---|
configuration |
Сведения о конфигурации. |
|
name |
string |
Имя назначения гостевой конфигурации. |
AssignmentReport
Имя | Тип | Описание |
---|---|---|
assignment |
Сведения о конфигурации назначения гостевой конфигурации. |
|
complianceStatus |
Значение , указывающее состояние соответствия компьютера для назначенной гостевой конфигурации. |
|
endTime |
string |
Дата и время окончания состояния соответствия назначения гостевой конфигурации проверка. |
id |
string |
Идентификатор ресурса ARM отчета для назначения гостевой конфигурации. |
operationType |
Тип отчета, согласованность или начальная |
|
reportId |
string |
GUID, идентифицирующий отчет о назначении гостевой конфигурации в подписке, группе ресурсов. |
resources |
Список ресурсов, для которых проверяется соответствие назначению гостевой конфигурации. |
|
startTime |
string |
Дата и время начала состояния соответствия назначения гостевой конфигурации проверка. |
vm |
Сведения о виртуальной машине. |
AssignmentReportResource
Ресурс назначения гостевой конфигурации.
Имя | Тип | Описание |
---|---|---|
complianceStatus |
Значение , указывающее состояние соответствия компьютера для назначенной гостевой конфигурации. |
|
properties |
object |
Свойства ресурса назначения гостевой конфигурации. |
reasons |
Причина соответствия и код причины для ресурса. |
|
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).
Имя | Тип | Значение по умолчанию | Описание |
---|---|---|---|
actionAfterReboot |
Указывает, что будет происходить после перезагрузки в процессе применения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration. |
||
allowModuleOverwrite |
boolean |
Если значение равно true, новые конфигурации, скачанные из опрашиваемой службы, могут перезаписывать старые конфигурации на целевом узле. В противном случае — false. |
|
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 |
GuestConfigurationAssignment
Назначение гостевой конфигурации — это связь между компьютером и гостевой конфигурацией.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса ARM для назначения гостевой конфигурации. |
location |
string |
Регион, в котором находится виртуальная машина. |
name |
string |
Имя назначения гостевой конфигурации. |
properties |
Свойства назначения гостевой конфигурации. |
|
systemData |
Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy. |
|
type |
string |
Тип ресурса. |
GuestConfigurationAssignmentList
Ответ операции назначения гостевой конфигурации списка.
Имя | Тип | Описание |
---|---|---|
value |
Результат операции назначения гостевой конфигурации списка. |
GuestConfigurationAssignmentProperties
Свойства назначения гостевой конфигурации.
Имя | Тип | Описание |
---|---|---|
assignmentHash |
string |
Объединенный хэш пакета конфигурации и параметров. |
complianceStatus |
Значение , указывающее состояние соответствия компьютера для назначенной гостевой конфигурации. |
|
context |
string |
Источник, который инициировал назначение гостевой конфигурации. Например, Политика Azure |
guestConfiguration |
Назначаемая гостевая конфигурация. |
|
lastComplianceStatusChecked |
string |
Дата и время проверки последнего состояния соответствия. |
latestAssignmentReport |
Последний отчет о назначении гостевой конфигурации. |
|
latestReportId |
string |
Идентификатор последнего отчета для назначения гостевой конфигурации. |
parameterHash |
string |
хэш параметра для назначения гостевой конфигурации. |
provisioningState |
Состояние подготовки, которое отображается только в ответе. |
|
resourceType |
string |
Тип ресурса — VMSS / VM |
targetResourceId |
string |
Идентификатор ресурса виртуальной машины. |
vmssVMList |
Список данных о соответствии виртуальных машин для VMSS |
GuestConfigurationNavigation
Гостевая конфигурация — это артефакт, который инкапсулирует конфигурацию DSC и ее зависимости. Артефакт представляет собой ZIP-файл, содержащий конфигурацию DSC (в виде MOF), зависимые ресурсы и другие зависимости, такие как модули.
Имя | Тип | Описание |
---|---|---|
assignmentSource |
string |
Указывает источник конфигурации. |
assignmentType |
Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor. |
|
configurationParameter |
Параметры конфигурации для гостевой конфигурации. |
|
configurationProtectedParameter |
Параметры защищенной конфигурации для гостевой конфигурации. |
|
configurationSetting |
Параметр конфигурации для гостевой конфигурации. |
|
contentHash |
string |
Объединенный хэш пакета гостевой конфигурации и параметров конфигурации. |
contentType |
string |
Указывает тип содержимого конфигурации. Возможные значения: Builtin или Custom. |
contentUri |
string |
URI хранилища, куда отправляется пакет гостевой конфигурации. |
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 |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое последним изменял ресурс. |
lastModifiedByType |
Тип удостоверения, которое последним изменял ресурс. |
type
Тип отчета, согласованность или начальная
Имя | Тип | Описание |
---|---|---|
Consistency |
string |
|
Initial |
string |
VMInfo
Сведения о виртуальной машине.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса Azure виртуальной машины. |
uuid |
string |
UUID (универсальный уникальный идентификатор) виртуальной машины. |
VMSSVMInfo
Сведения о виртуальной машине VMSS
Имя | Тип | Описание |
---|---|---|
complianceStatus |
Значение , указывающее состояние соответствия компьютера для назначенной гостевой конфигурации. |
|
lastComplianceChecked |
string |
Дата и время проверки последнего состояния соответствия. |
latestReportId |
string |
Идентификатор последнего отчета для назначения гостевой конфигурации. |
vmId |
string |
UUID виртуальной машины. |
vmResourceId |
string |
Идентификатор ресурса Azure виртуальной машины. |