Guest Agents - Create

Ссылка

Служба:: Azure Arc enabled SCVMM

Версия API:: 2024-06-01

Реализует метод GuestAgent PUT.
Создание или обновление GuestAgent.

PUT 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 minLength: 1	Версия API, используемая для этой операции.

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

Имя	Тип	Описание
properties.credentials	GuestCredential	Учетные данные имени пользователя и пароля для подготовки гостевого агента.
properties.httpProxyConfig	HttpProxyConfiguration	Конфигурация прокси-сервера HTTP для виртуальной машины.
properties.privateLinkScopeResourceId	string (arm-id)	Идентификатор ресурса области приватного канала, которому назначен этот компьютер, если таковой имеется.
properties.provisioningAction	ProvisioningAction	Возвращает или задает действие подготовки гостевого агента.

Ответы

Имя	Тип	Описание
200 OK	GuestAgent	Операция обновления ресурса GuestAgent выполнена успешно
201 Created	GuestAgent	Операция создания ресурса "GuestAgent" выполнена успешно Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

GuestAgent

Операция обновления ресурса GuestAgent выполнена успешно

201 Created

GuestAgent

Операция создания ресурса "GuestAgent" выполнена успешно

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

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

HTTP

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

{
  "properties": {
    "credentials": {
      "username": "jqxuwirrcpfv",
      "password": "gkvbnmuahumuoibvscoxzfdqwvfuf"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install"
  }
}

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

Код состояния:: 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"
  }
}

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

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "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_Create_MinimumSet

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

HTTP

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

{}

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

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

{}

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

Azure-AsyncOperation: https://contoso.com/operationstatus

{}

Определения

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

createdByType

Перечисление

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

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

GuestAgent

Object

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

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.credentials	GuestCredential	Учетные данные имени пользователя и пароля для подготовки гостевого агента.
properties.customResourceName	string	Возвращает имя соответствующего ресурса в Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Конфигурация прокси-сервера HTTP для виртуальной машины.
properties.privateLinkScopeResourceId	string (arm-id)	Идентификатор ресурса области приватного канала, которому назначен этот компьютер, если таковой имеется.
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

Object

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

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

HttpProxyConfiguration

Object

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

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

ProvisioningAction

Перечисление

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

Значение	Описание
install	Установите гостевой агент.
repair	Восстановление гостевого агента.
uninstall	Удалите гостевой агент.

ProvisioningState

Перечисление

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

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

systemData

Object

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

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

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

Guest Agents - Create

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

GuestAgents_Create_MaximumSet

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

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

GuestAgents_Create_MinimumSet

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

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

Определения

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData

Дополнительные ресурсы