VirtualMachineExtension interface
仮想マシン拡張機能について説明します。
- Extends
プロパティ
auto |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 |
enable |
使用可能な拡張機能の新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 |
force |
拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 |
instance |
仮想マシン拡張機能インスタンス ビュー。 |
protected |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。 |
protected |
参照渡しされ、キー コンテナーから使用される拡張機能で保護された設定 |
provision |
この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 |
provisioning |
プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
publisher | 拡張ハンドラーパブリッシャーの名前。 |
settings | 拡張機能の Json 形式のパブリック設定。 |
suppress |
拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの運用エラーは、この値に関係なく抑制されません)。 既定値は false です。 |
type |
スクリプト ハンドラーのバージョンを指定します。 |
type |
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 |
継承されたプロパティ
id | リソース ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
location | リソースの場所 |
name | リソース名注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
tags | リソース タグ |
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
プロパティ値
provisionAfterExtensions
この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。
provisionAfterExtensions?: string[]
プロパティ値
string[]
provisioningState
プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
publisher
拡張ハンドラーパブリッシャーの名前。
publisher?: string
プロパティ値
string
settings
拡張機能の Json 形式のパブリック設定。
settings?: any
プロパティ値
any
suppressFailures
拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの運用エラーは、この値に関係なく抑制されません)。 既定値は false です。
suppressFailures?: boolean
プロパティ値
boolean
typeHandlerVersion
スクリプト ハンドラーのバージョンを指定します。
typeHandlerVersion?: string
プロパティ値
string
typePropertiesType
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
typePropertiesType?: string
プロパティ値
string
継承されたプロパティの詳細
id
リソース ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
id?: string
プロパティ値
string
location
name
リソース名注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name?: string
プロパティ値
string
tags
リソース タグ
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
type
リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type?: string
プロパティ値
string