Virtual Machine Scale Set Extensions - Get

Service:

Compute

API Version:

2024-03-01

拡張機能を取得する操作。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmScaleSetName	path	True	string	拡張機能を含む VM スケール セットの名前。
vmssExtensionName	path	True	string	VM スケール セット拡張機能の名前。
api-version	query	True	string	クライアント API のバージョン。
$expand	query		string	操作に適用する展開式。

応答

名前	型	説明
200 OK	VirtualMachineScaleSetExtension	OK
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

VirtualMachineScaleSetExtension_Get_MaximumSet_Gen

VirtualMachineScaleSetExtension_Get_MinimumSet_Gen

VirtualMachineScaleSetExtension_Get_MaximumSet_Gen

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "name": "{extension-name}",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisioningState": "aaa",
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  },
  "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
  "id": "aaaaaaaa"
}

VirtualMachineScaleSetExtension_Get_MinimumSet_Gen

Sample Request

HTTP

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

Sample Response

Status code:

200

{}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティング サービスからのエラー応答。
InnerError	内部エラーの詳細。
KeyVaultSecretReference	Key Vault シークレットへの参照について説明します
SubResource
VirtualMachineScaleSetExtension	仮想マシン スケール セット拡張機能について説明します。

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	例外の種類。

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

名前	型	説明
secretUrl	string	Key Vault内のシークレットを参照する URL。
sourceVault	SubResource	シークレットを含むKey Vaultの相対 URL。

SubResource

名前	型	説明
id	string	リソース ID

VirtualMachineScaleSetExtension

仮想マシン スケール セット拡張機能について説明します。

名前	型	説明
id	string	リソース ID
name	string	拡張機能の名前です。
properties.autoUpgradeMinorVersion	boolean	展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。
properties.enableAutomaticUpgrade	boolean	新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。
properties.forceUpdateTag	string	値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。
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	スクリプト ハンドラーのバージョンを指定します。
type	string	リソースの種類