Virtual Machine Extensions - Get

Service:

Compute

API Version:

2024-03-01

取得延伸模組的作業。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vmExtensionName	path	True	string	虛擬機擴充功能的名稱。
vmName	path	True	string	包含擴充功能的虛擬機名稱。
api-version	query	True	string	用戶端 API 版本。
$expand	query		string	要套用至作業的展開表達式。

回應

名稱	類型	Description
200 OK	VirtualMachineExtension	確定
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VirtualMachineExtension_Get_MaximumSet_Gen

VirtualMachineExtension_Get_MinimumSet_Gen

VirtualMachineExtension_Get_MaximumSet_Gen

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaa?$expand=aaaaaa&api-version=2024-03-01

Java

/**
 * Samples for VirtualMachineExtensions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineExtension_Get_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineExtensionGetMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineExtensions().getWithResponse("rgcompute",
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaa", "aaaaaa", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_extension_get_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_extensions.get(
        resource_group_name="rgcompute",
        vm_name="aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        vm_extension_name="aaaaaaa",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json
func ExampleVirtualMachineExtensionsClient_Get_virtualMachineExtensionGetMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineExtensionsClient().Get(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaa", &armcompute.VirtualMachineExtensionsClientGetOptions{Expand: to.Ptr("aaaaaa")})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineExtension = armcompute.VirtualMachineExtension{
	// 	Name: to.Ptr("myVMExtension"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"key9183": to.Ptr("aa"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineExtensionProperties{
	// 		Type: to.Ptr("extType"),
	// 		AutoUpgradeMinorVersion: to.Ptr(true),
	// 		EnableAutomaticUpgrade: to.Ptr(true),
	// 		ForceUpdateTag: to.Ptr("a"),
	// 		InstanceView: &armcompute.VirtualMachineExtensionInstanceView{
	// 			Name: to.Ptr("aaaaaaaaaaaaaaaaa"),
	// 			Type: to.Ptr("aaaaaaaaa"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
	// 					DisplayStatus: to.Ptr("aaaaaa"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Message: to.Ptr("a"),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.522Z"); return t}()),
	// 			}},
	// 			Substatuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
	// 					DisplayStatus: to.Ptr("aaaaaa"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Message: to.Ptr("a"),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.522Z"); return t}()),
	// 			}},
	// 			TypeHandlerVersion: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 		},
	// 		ProtectedSettings: map[string]any{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Publisher: to.Ptr("extPublisher"),
	// 		Settings: map[string]any{
	// 		},
	// 		SuppressFailures: to.Ptr(true),
	// 		TypeHandlerVersion: to.Ptr("1.2"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation to get the extension.
 *
 * @summary The operation to get the extension.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json
 */
async function virtualMachineExtensionGetMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const vmExtensionName = "aaaaaaa";
  const expand = "aaaaaa";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineExtensions.get(
    resourceGroupName,
    vmName,
    vmExtensionName,
    options,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

Sample Request

HTTP

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

Java

/**
 * Samples for VirtualMachineExtensions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineExtension_Get_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineExtensionGetMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineExtensions().getWithResponse("rgcompute",
            "myVM", "myVMExtension", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_extension_get_minimum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_extensions.get(
        resource_group_name="rgcompute",
        vm_name="myVM",
        vm_extension_name="myVMExtension",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json
func ExampleVirtualMachineExtensionsClient_Get_virtualMachineExtensionGetMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineExtensionsClient().Get(ctx, "rgcompute", "myVM", "myVMExtension", &armcompute.VirtualMachineExtensionsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineExtension = armcompute.VirtualMachineExtension{
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"),
	// 	Location: to.Ptr("westus"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation to get the extension.
 *
 * @summary The operation to get the extension.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json
 */
async function virtualMachineExtensionGetMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "myVM";
  const vmExtensionName = "myVMExtension";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineExtensions.get(
    resourceGroupName,
    vmName,
    vmExtensionName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

定義

名稱	Description
ApiError	Api 錯誤。
ApiErrorBase	Api 錯誤基底。
CloudError	計算服務的錯誤回應。
InnerError	內部錯誤詳細數據。
InstanceViewStatus	實例檢視狀態。
KeyVaultSecretReference	描述 金鑰保存庫 秘密的參考
StatusLevelTypes	層級程序代碼。
SubResource
VirtualMachineExtension	描述虛擬機擴充功能。
VirtualMachineExtensionInstanceView	虛擬機擴充功能的實例檢視。

ApiError

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	API 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

Api 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

CloudError

計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

InnerError

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或例外狀況傾印。
exceptiontype	string	例外狀況型別。

InstanceViewStatus

實例檢視狀態。

名稱	類型	Description
code	string	狀態碼。
displayStatus	string	狀態的簡短可當地語系化標籤。
level	StatusLevelTypes	層級程序代碼。
message	string	詳細的狀態消息，包括警示和錯誤訊息。
time	string	狀態的時間。

KeyVaultSecretReference

描述 金鑰保存庫 秘密的參考

名稱	類型	Description
secretUrl	string	參考 金鑰保存庫 秘密的 URL。
sourceVault	SubResource	包含秘密之 金鑰保存庫的相對 URL。

StatusLevelTypes

層級程序代碼。

名稱	類型	Description
Error	string
Info	string
Warning	string

SubResource

名稱	類型	Description
id	string	資源標識碼

VirtualMachineExtension

描述虛擬機擴充功能。

名稱	類型	Description
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	指出延伸模組的失敗是否會隱藏 (作業失敗，例如不會連線到 VM，而不論此值) 為何。 預設值為 false。
properties.type	string	指定延伸模組的類型;範例為 「CustomScriptExtension」。。
properties.typeHandlerVersion	string	指定文稿處理程式的版本。
tags	object	資源標籤
type	string	資源類型

VirtualMachineExtensionInstanceView

虛擬機擴充功能的實例檢視。

名稱	類型	Description
name	string	虛擬機擴充功能名稱。
statuses	InstanceViewStatus[]	資源狀態資訊。
substatuses	InstanceViewStatus[]	資源狀態資訊。
type	string	指定延伸模組的類型;範例為 「CustomScriptExtension」。。
typeHandlerVersion	string	指定文稿處理程式的版本。