VirtualMachineExtensionProperties interface
仮想マシン拡張機能のプロパティについて説明します。
プロパティ
| auto |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 |
| enable |
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 |
| force |
拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 |
| instance |
仮想マシン拡張機能インスタンス ビュー。 |
| protected |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 |
| protected |
参照によって渡され、キー コンテナーから使用される、拡張機能で保護された設定 |
| publisher | 拡張ハンドラーの発行元の名前。 |
| settings | 拡張機能の Json 形式のパブリック設定。 |
| suppress |
拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 |
| type | 拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 |
| type |
スクリプト ハンドラーのバージョンを指定します。 |
プロパティの詳細
autoUpgradeMinorVersion
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。
autoUpgradeMinorVersion?: boolean
プロパティ値
boolean
enableAutomaticUpgrade
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。
enableAutomaticUpgrade?: boolean
プロパティ値
boolean
forceUpdateTag
拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。
forceUpdateTag?: string
プロパティ値
string
instanceView
仮想マシン拡張機能インスタンス ビュー。
instanceView?: VirtualMachineExtensionInstanceView
プロパティ値
protectedSettings
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
protectedSettings?: any
プロパティ値
any
protectedSettingsFromKeyVault
参照によって渡され、キー コンテナーから使用される、拡張機能で保護された設定
protectedSettingsFromKeyVault?: KeyVaultSecretReference
プロパティ値
publisher
拡張ハンドラーの発行元の名前。
publisher?: string
プロパティ値
string
settings
拡張機能の Json 形式のパブリック設定。
settings?: any
プロパティ値
any
suppressFailures
拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。
suppressFailures?: boolean
プロパティ値
boolean
type
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
type?: string
プロパティ値
string
typeHandlerVersion
スクリプト ハンドラーのバージョンを指定します。
typeHandlerVersion?: string
プロパティ値
string