Guest Agents - Get

Служба:

Azure Arc enabled SCVMM

Версия API:

2024-06-01

Возвращает GuestAgent.
Реализует метод Get GuestAgent.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceUri	path	True	string	Полный идентификатор Azure Resource Manager ресурса.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	GuestAgent	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

GuestAgents_Get_MaximumSet

GuestAgents_Get_MinimumSet

GuestAgents_Get_MaximumSet

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

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

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

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

200

{
  "properties": {
    "uuid": "hbsgztyakewtgbuxbesezncnzu",
    "credentials": {
      "username": "jqxuwirrcpfv"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install",
    "status": "jpoukrzfenzrmjdahimkl",
    "customResourceName": "mhqymxkapuvsugd",
    "provisioningState": "Succeeded",
    "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default",
  "name": "rwecpthzyt",
  "type": "dkcgcbtlwtsedxzhvtu",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

GuestAgents_Get_MinimumSet

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

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

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

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

200

{}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GuestAgent	Определяет GuestAgent.
GuestCredential	Имя пользователя и учетные данные пароля для подключения к гостевой системе.
HttpProxyConfiguration	Конфигурация прокси-сервера HTTP для виртуальной машины.
ProvisioningAction	Действие подготовки гостевого агента.
ProvisioningState	Состояние подготовки ресурса.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

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

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

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GuestAgent

Определяет GuestAgent.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.credentials	GuestCredential	Учетные данные имени пользователя и пароля для подготовки гостевого агента.
properties.customResourceName	string	Возвращает имя соответствующего ресурса в Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Конфигурация прокси-сервера HTTP для виртуальной машины.
properties.privateLinkScopeResourceId	string	Идентификатор ресурса области приватного канала, которому назначен этот компьютер, если таковой имеется.
properties.provisioningAction	ProvisioningAction	Возвращает или задает действие подготовки гостевого агента.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса.
properties.status	string	Возвращает состояние гостевого агента.
properties.uuid	string	Возвращает уникальный идентификатор для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

GuestCredential

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

Имя	Тип	Описание
password	string	Возвращает или задает пароль для подключения к гостевой системе.
username	string	Возвращает или задает имя пользователя для подключения к гостевой системе.

HttpProxyConfiguration

Конфигурация прокси-сервера HTTP для виртуальной машины.

Имя	Тип	Описание
httpsProxy	string	Возвращает или задает URL-адрес httpsProxy.

ProvisioningAction

Действие подготовки гостевого агента.

Имя	Тип	Описание
install	string	Установите гостевой агент.
repair	string	Восстановление гостевого агента.
uninstall	string	Удалите гостевой агент.

ProvisioningState

Состояние подготовки ресурса.

Имя	Тип	Описание
Accepted	string	Ресурс был принят.
Canceled	string	Создание ресурсов было отменено.
Created	string	Ресурс был создан.
Deleting	string	Ресурс удаляется.
Failed	string	Не удалось создать ресурс.
Provisioning	string	Ресурс подготавливается.
Succeeded	string	Ресурс создан.
Updating	string	Ресурс обновляется.

systemData

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

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