Guest Configuration Assignments - RG List

Ссылка

Service:: Guest Configuration

API Version:: 2020-06-25

Вывод списка всех назначений гостевой конфигурации для группы ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2020-06-25

Параметры URI

Name In Required Type Description

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Имя группы ресурсов. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Идентификатор подписки, однозначно определяющий Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

resourceGroupName

path

True

string

Имя группы ресурсов.

Regex pattern: ^[-\w\._]+$

subscriptionId

path

True

string

Идентификатор подписки, однозначно определяющий Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version

query

True

string

Версия API клиента.

Ответы

Name	Type	Description
200 OK	GuestConfigurationAssignmentList	ОК
204 No Content		Нет содержимого
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

List all guest configuration assignments for a resource group

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2020-06-25

package armguestconfiguration_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listRGGuestConfigurationAssignments.json
func ExampleAssignmentsClient_NewRGListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armguestconfiguration.NewAssignmentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewRGListPager("<resource-group-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

[
  {
    "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
    }
  }
]

Status code:: 204

Определения

actionAfterReboot	Указывает, что будет происходить после перезагрузки в процессе применения конфигурации. Возможные значения: ContinueConfiguration и StopConfiguration
AssignmentInfo	Сведения о назначении гостевой конфигурации.
AssignmentReport
AssignmentReportResource	Ресурс назначения гостевой конфигурации.
AssignmentReportResourceComplianceReason	Причина и код соответствия ресурса назначения гостевой конфигурации.
assignmentType	Указывает тип назначения и выполнение конфигурации. Возможные значения: Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect и ApplyAndMonitor.
complianceStatus	Значение, указывающее состояние соответствия компьютера для назначенной гостевой конфигурации.
ConfigurationInfo	Сведения о конфигурации.
configurationMode	Указывает, как LCM(Локальный Configuration Manager) фактически применяет конфигурацию к целевым узлам. Возможные значения: ApplyOnly, ApplyAndMonitor и ApplyAndAutoCorrect.
ConfigurationParameter	Представляет параметр конфигурации.
ConfigurationSetting	Параметр конфигурации LCM (локальный Configuration Manager).
Error
ErrorResponse	Ответ об ошибке при сбое операции
GuestConfigurationAssignment	Назначение гостевой конфигурации — это связь между компьютером и гостевой конфигурацией.
GuestConfigurationAssignmentList	Ответ операции назначения гостевой конфигурации списка.
GuestConfigurationAssignmentProperties	Свойства назначения гостевой конфигурации.
GuestConfigurationNavigation	Гостевая конфигурация — это артефакт, инкапсулирующий конфигурацию DSC и ее зависимости. Артефакт — это ZIP-файл, содержащий конфигурацию DSC (как MOF) и зависимые ресурсы и другие зависимости, такие как модули.
kind	Тип гостевой конфигурации. Например: DSC
provisioningState	Состояние подготовки, которое отображается только в ответе.
type	Тип отчета, согласованности или инициализации
VMInfo	Сведения о виртуальной машине.
VMSSVMInfo	Сведения о виртуальной машине VMSS

actionAfterReboot

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

Name	Type	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

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

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

AssignmentReport

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

AssignmentReportResource

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

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

AssignmentReportResourceComplianceReason

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

Name	Type	Description
code	string	Код соответствия ресурса назначения гостевой конфигурации.
phrase	string	Причина соответствия ресурса назначения гостевой конфигурации.

assignmentType

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

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

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

Name	Type	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

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

Name	Type	Description
name	string	Имя конфигурации.
version	string	Версия конфигурации.

configurationMode

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

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

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

Name	Type	Description
name	string	Имя параметра конфигурации.
value	string	Значение параметра конфигурации.

ConfigurationSetting

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

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

Error

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

ErrorResponse

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

Name	Type	Description
error	Error

GuestConfigurationAssignment

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

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

GuestConfigurationAssignmentList

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

Name	Type	Description
value	GuestConfigurationAssignment[]	Результат операции назначения гостевой конфигурации списка.

GuestConfigurationAssignmentProperties

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

Name	Type	Description
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) и зависимые ресурсы и другие зависимости, такие как модули.

Name	Type	Description
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

Name	Type	Description
DSC	string

provisioningState

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

Name	Type	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

type

Тип отчета, согласованности или инициализации

Name	Type	Description
Consistency	string
Initial	string

VMInfo

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

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

VMSSVMInfo

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

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