Virtual Machine Extensions - Get
Операция получения расширения.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?$expand={$expand}&api-version=2024-03-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
vm
|
path | True |
string |
Имя расширения виртуальной машины. |
vm
|
path | True |
string |
Имя виртуальной машины, содержащей расширение. |
api-version
|
query | True |
string |
Версия API клиента. |
$expand
|
query |
string |
Выражение expand, применяемое к операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Virtual |
Virtual |
VirtualMachineExtension_Get_MaximumSet_Gen
Образец запроса
Пример ответа
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
VirtualMachineExtension_Get_MinimumSet_Gen
Образец запроса
Пример ответа
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
Определения
Имя | Описание |
---|---|
Api |
Ошибка API. |
Api |
База ошибок API. |
Cloud |
Ответ об ошибке от службы вычислений. |
Inner |
Сведения о внутренней ошибке. |
Instance |
Состояние представления экземпляра. |
Key |
Описание ссылки на секрет Key Vault |
Status |
Код уровня. |
Sub |
|
Virtual |
Описывает расширение виртуальной машины. |
Virtual |
Представление экземпляра расширения виртуальной машины. |
ApiError
Ошибка API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
details |
Сведения об ошибке API |
|
innererror |
Внутренняя ошибка API |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
CloudError
Ответ об ошибке от службы вычислений.
Имя | Тип | Описание |
---|---|---|
error |
Ошибка API. |
InnerError
Сведения о внутренней ошибке.
Имя | Тип | Описание |
---|---|---|
errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
exceptiontype |
string |
Тип исключения. |
InstanceViewStatus
Состояние представления экземпляра.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код состояния. |
displayStatus |
string |
Короткая локализуемая метка для состояния. |
level |
Код уровня. |
|
message |
string |
Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. |
time |
string |
Время состояния. |
KeyVaultSecretReference
Описание ссылки на секрет Key Vault
Имя | Тип | Описание |
---|---|---|
secretUrl |
string |
URL-адрес, ссылающийся на секрет в Key Vault. |
sourceVault |
Относительный URL-адрес Key Vault, содержащего секрет. |
StatusLevelTypes
Код уровня.
Имя | Тип | Описание |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
VirtualMachineExtension
Описывает расширение виртуальной машины.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
location |
string |
Расположение ресурса |
name |
string |
Имя ресурса |
properties.autoUpgradeMinorVersion |
boolean |
Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. |
properties.enableAutomaticUpgrade |
boolean |
Указывает, должно ли расширение автоматически обновляться платформой, если доступна более новая версия расширения. |
properties.forceUpdateTag |
string |
Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась. |
properties.instanceView |
Представление экземпляра расширения виртуальной машины. |
|
properties.protectedSettings |
object |
Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров. |
properties.protectedSettingsFromKeyVault |
Расширения защищают параметры, которые передаются по ссылке и используются из хранилища ключей. |
|
properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которых необходимо подготовить это расширение. |
properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
properties.publisher |
string |
Имя издателя обработчика расширений. |
properties.settings |
object |
Общедоступные параметры расширения в формате JSON. |
properties.suppressFailures |
boolean |
Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
properties.type |
string |
Указывает тип расширения; пример : CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
tags |
object |
Теги ресурсов |
type |
string |
Тип ресурса |
VirtualMachineExtensionInstanceView
Представление экземпляра расширения виртуальной машины.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя расширения виртуальной машины. |
statuses |
Сведения о состоянии ресурса. |
|
substatuses |
Сведения о состоянии ресурса. |
|
type |
string |
Указывает тип расширения; пример : CustomScriptExtension. |
typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |