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


Virtual Machine Scale Set VM Extensions - Get

Операция для получения расширения виртуальной машины VMSS.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}?$expand={$expand}&api-version=2024-03-01

Параметры URI

Имя В Обязательно Тип Описание
instanceId
path True

string

Идентификатор экземпляра виртуальной машины.

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

vmExtensionName
path True

string

Имя расширения виртуальной машины.

vmScaleSetName
path True

string

Имя масштабируемого набора виртуальных машин.

api-version
query True

string

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

$expand
query

string

Выражение expand, применяемое к операции.

Ответы

Имя Тип Описание
200 OK

VirtualMachineScaleSetVMExtension

ОК

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

Get VirtualMachineScaleSet VM extension.

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

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension?api-version=2024-03-01

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

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  },
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"
}

Определения

Имя Описание
ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

CloudError

Ответ об ошибке от службы вычислений.

InnerError

Сведения о внутренней ошибке.

InstanceViewStatus

Состояние представления экземпляра.

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

StatusLevelTypes

Код уровня.

SubResource
VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

VirtualMachineScaleSetVMExtension

Описывает расширение виртуальной машины VMSS.

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

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

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

CloudError

Ответ об ошибке от службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

InnerError

Сведения о внутренней ошибке.

Имя Тип Описание
errordetail

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

InstanceViewStatus

Состояние представления экземпляра.

Имя Тип Описание
code

string

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

displayStatus

string

Короткая локализуемая метка для состояния.

level

StatusLevelTypes

Код уровня.

message

string

Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.

time

string

Время состояния.

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

Имя Тип Описание
secretUrl

string

URL-адрес, ссылающийся на секрет в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащего секрет.

StatusLevelTypes

Код уровня.

Имя Тип Описание
Error

string

Info

string

Warning

string

SubResource

Имя Тип Описание
id

string

Идентификатор ресурса

VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

Имя Тип Описание
name

string

Имя расширения виртуальной машины.

statuses

InstanceViewStatus[]

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

substatuses

InstanceViewStatus[]

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

type

string

Указывает тип расширения; пример : CustomScriptExtension.

typeHandlerVersion

string

Указывает версию обработчика скрипта.

VirtualMachineScaleSetVMExtension

Описывает расширение виртуальной машины VMSS.

Имя Тип Описание
id

string

Идентификатор ресурса

location

string

Расположение расширения.

name

string

Имя модуля.

properties.autoUpgradeMinorVersion

boolean

Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true.

properties.enableAutomaticUpgrade

boolean

Указывает, должно ли расширение автоматически обновляться платформой, если доступна более новая версия расширения.

properties.forceUpdateTag

string

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

properties.instanceView

VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

properties.protectedSettings

object

Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Расширения защищают параметры, которые передаются по ссылке и используются из хранилища ключей.

properties.provisionAfterExtensions

string[]

Коллекция имен расширений, после которых необходимо подготовить это расширение.

properties.provisioningState

string

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

properties.publisher

string

Имя издателя обработчика расширений.

properties.settings

object

Общедоступные параметры расширения в формате JSON.

properties.suppressFailures

boolean

Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.

properties.type

string

Указывает тип расширения; пример : CustomScriptExtension.

properties.typeHandlerVersion

string

Указывает версию обработчика скрипта.

type

string

Тип ресурса