Virtual Machine Scale Set Extensions - Update
拡張機能を更新する操作。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2024-07-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。 |
vm
|
path | True |
string |
拡張機能を更新する必要がある VM スケール セットの名前。 |
vmss
|
path | True |
string |
VM スケール セット拡張機能の名前。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.autoUpgradeMinorVersion |
boolean |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 |
properties.enableAutomaticUpgrade |
boolean |
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 |
properties.forceUpdateTag |
string |
値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 |
properties.protectedSettings |
object |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 |
properties.protectedSettingsFromKeyVault |
参照によって渡され、キー コンテナーから使用される、拡張機能で保護された設定 |
|
properties.provisionAfterExtensions |
string[] |
この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 |
properties.publisher |
string |
拡張ハンドラーの発行元の名前。 |
properties.settings |
object |
拡張機能の Json 形式のパブリック設定。 |
properties.suppressFailures |
boolean |
拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 |
properties.type |
string |
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 |
properties.typeHandlerVersion |
string |
スクリプト ハンドラーのバージョンを指定します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
201 Created |
作成 |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
Virtual |
Virtual |
VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
要求のサンプル
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2024-07-01
{
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
}
}
応答のサンプル
{
"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"
}
location: https://foo.com/operationstatus
{
"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_Update_MinimumSet_Gen
要求のサンプル
応答のサンプル
{}
location: https://foo.com/operationstatus
{}
定義
名前 | 説明 |
---|---|
Api |
API エラー。 |
Api |
API エラーベース。 |
Cloud |
コンピューティング サービスからのエラー応答。 |
Inner |
内部エラーの詳細。 |
Key |
Key Vault シークレットへの参照について説明します |
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 |
例外の種類。 |
KeyVaultSecretReference
Key Vault シークレットへの参照について説明します
名前 | 型 | 説明 |
---|---|---|
secretUrl |
string |
Key Vault 内のシークレットを参照する URL。 |
sourceVault |
シークレットを含む 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 |
参照によって渡され、キー コンテナーから使用される、拡張機能で保護された設定 |
|
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 |
リソースの種類 |
VirtualMachineScaleSetExtensionUpdate
仮想マシン スケール セット拡張機能について説明します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID |
name |
string |
拡張機能の名前。 |
properties.autoUpgradeMinorVersion |
boolean |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 |
properties.enableAutomaticUpgrade |
boolean |
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 |
properties.forceUpdateTag |
string |
値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 |
properties.protectedSettings |
object |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 |
properties.protectedSettingsFromKeyVault |
参照によって渡され、キー コンテナーから使用される、拡張機能で保護された設定 |
|
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 |
リソースの種類 |