Microsoft.Compute virtualMachines/extensions 2021-07-01
Bicep リソース定義
virtualMachines/extensions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2021-07-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
instanceView: {
name: 'string'
statuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
substatuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
type: 'string'
typeHandlerVersion: 'string'
}
protectedSettings: any()
publisher: 'string'
settings: any()
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
プロパティ値
virtualMachines/extensions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースの場所 | string (必須) |
| tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: virtualMachines |
| properties | 仮想マシン拡張機能のプロパティについて説明します。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 | [bool] |
| enableAutomaticUpgrade | 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 | [bool] |
| forceUpdateTag | 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 | string |
| instanceView | 仮想マシン拡張機能インスタンス ビュー。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 | Bicep の場合は、 any() 関数を使用できます。 |
| publisher | 拡張ハンドラーの発行元の名前。 | string |
| settings | 拡張機能の Json 形式のパブリック設定。 | Bicep の場合は、 any() 関数を使用できます。 |
| suppressFailures | 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 | [bool] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
VirtualMachineExtensionInstanceView
| 名前 | 説明 | 値 |
|---|---|---|
| name | 仮想マシンの拡張機能名。 | string |
| statuses | リソースの状態情報。 | InstanceViewStatus[] |
| substatuses | リソースの状態情報。 | InstanceViewStatus[] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
InstanceViewStatus
| 名前 | 説明 | 値 |
|---|---|---|
| code | ステータス コード。 | string |
| displayStatus | 状態の短いローカライズ可能なラベル。 | string |
| レベル | レベル コード。 | 'Error' 'Info' '警告' |
| message | アラートとエラー メッセージを含む詳細なステータス メッセージ。 | string |
| time | 状態の時刻。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
マルウェア対策拡張機能が有効になっている Windows VM を作成する |
このテンプレートは、Windows VM を作成し、マルウェア対策保護を設定します |
| Windows VM で DSC 拡張機能を使用する IIS サーバー |
このテンプレートでは、Windows VM を作成し、DSC 拡張機能を使用して IIS サーバーを設定します。 Azure Storage を使用している場合は、DSC 構成モジュールで SAS トークンを渡す必要があることに注意してください。 GitHub からの DSC モジュール リンク (このテンプレートの既定値) の場合、これは必要ありません。 |
| ESET VM 拡張機能 |
ESET 拡張機能を使用して VM を作成します |
| Windows VM 上の McAfee Endpoint Security (試用版ライセンス) |
このテンプレートは、Windows VM を作成し、McAfee Endpoint Security の試用版を設定します |
| OMS 拡張機能を使用して Ubuntu VM をデプロイする |
このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Ubuntu VM をデプロイできます |
| OMS 拡張機能を使用して Windows VM をデプロイする |
このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Windows VM をデプロイできます |
| Windows VM での Symantec Endpoint Protection 拡張機能の試用版 |
このテンプレートでは、Windows VM を作成し、Symantec Endpoint Protection の試用版を設定します |
| Ubuntu VM 上のカスタム スクリプト拡張機能 |
このテンプレートでは、Ubuntu VM を作成し、CustomScript 拡張機能をインストールします |
| Ubuntu VM での OS 修正プログラムの適用拡張機能 |
このテンプレートは、Ubuntu VM を作成し、OSPatching 拡張機能をインストールします |
| 診断を使用して Premium Windows VM をデプロイする |
このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンを使用して、Windows バージョンのいくつかの異なるオプションを使用して Premium Windows VM をデプロイできます。 |
| 監視と診断を使用して単純な Windows VM をデプロイする |
このテンプレートを使用すると、VM の監視と診断を可能にする診断拡張機能と共に単純な Windows VM をデプロイできます |
| スクリプト拡張機能を使用して Mongo DB を Ubuntu VM にインストールする |
このテンプレートでは、2 つの異なるスクリプトで Mongo DB を構成して Ubuntu 仮想マシンにインストールします。 このテンプレートは、同じ仮想マシンで実行されている 2 つのスクリプト間の依存関係を表現する方法を示す良い例です。 このテンプレートでは、ストレージ アカウント、Virtual Network、パブリック IP アドレス、ネットワーク インターフェイスもデプロイされます。 |
ARM テンプレート リソース定義
virtualMachines/extensions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/virtualMachines/extensions",
"apiVersion": "2021-07-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"instanceView": {
"name": "string",
"statuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"substatuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"type": "string",
"typeHandlerVersion": "string"
},
"protectedSettings": {},
"publisher": "string",
"settings": {},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
プロパティ値
virtualMachines/extensions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Compute/virtualMachines/extensions' |
| apiVersion | リソース API のバージョン | '2021-07-01' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースの場所 | string (必須) |
| tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| properties | 仮想マシン拡張機能のプロパティについて説明します。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 | [bool] |
| enableAutomaticUpgrade | 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 | [bool] |
| forceUpdateTag | 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 | string |
| instanceView | 仮想マシン拡張機能インスタンス ビュー。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 | |
| publisher | 拡張ハンドラーの発行元の名前。 | string |
| settings | 拡張機能の Json 形式のパブリック設定。 | |
| suppressFailures | 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 | [bool] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
VirtualMachineExtensionInstanceView
| 名前 | 説明 | 値 |
|---|---|---|
| name | 仮想マシンの拡張機能名。 | string |
| statuses | リソースの状態情報。 | InstanceViewStatus[] |
| substatuses | リソースの状態情報。 | InstanceViewStatus[] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
InstanceViewStatus
| 名前 | 説明 | 値 |
|---|---|---|
| code | ステータス コード。 | string |
| displayStatus | 状態の短いローカライズ可能なラベル。 | string |
| レベル | レベル コード。 | 'Error' 'Info' '警告' |
| message | アラートとエラー メッセージを含む詳細なステータス メッセージ。 | string |
| time | 状態の時刻。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| マルウェア対策拡張機能が有効になっている Windows VM を作成する |
このテンプレートは、Windows VM を作成し、マルウェア対策保護を設定します |
| Windows VM で DSC 拡張機能を使用する IIS サーバー |
このテンプレートでは、Windows VM を作成し、DSC 拡張機能を使用して IIS サーバーを設定します。 Azure Storage を使用している場合は、DSC 構成モジュールで SAS トークンを渡す必要があることに注意してください。 GitHub からの DSC モジュール リンク (このテンプレートの既定値) の場合、これは必要ありません。 |
| ESET VM 拡張機能 |
ESET 拡張機能を使用して VM を作成します |
| Windows VM 上の McAfee Endpoint Security (試用版ライセンス) |
このテンプレートは、Windows VM を作成し、McAfee Endpoint Security の試用版を設定します |
| OMS 拡張機能を使用して Ubuntu VM をデプロイする |
このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Ubuntu VM をデプロイできます |
| OMS 拡張機能を使用して Windows VM をデプロイする |
このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Windows VM をデプロイできます |
| Windows VM での Symantec Endpoint Protection 拡張機能の試用版 |
このテンプレートでは、Windows VM を作成し、Symantec Endpoint Protection の試用版を設定します |
| Ubuntu VM 上のカスタム スクリプト拡張機能 |
このテンプレートでは、Ubuntu VM を作成し、CustomScript 拡張機能をインストールします |
| Ubuntu VM での OS 修正プログラムの適用拡張機能 |
このテンプレートは、Ubuntu VM を作成し、OSPatching 拡張機能をインストールします |
| 診断を使用して Premium Windows VM をデプロイする |
このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンを使用して、Windows バージョンのいくつかの異なるオプションを使用して Premium Windows VM をデプロイできます。 |
| 監視と診断を使用して単純な Windows VM をデプロイする |
このテンプレートを使用すると、VM の監視と診断を可能にする診断拡張機能と共に単純な Windows VM をデプロイできます |
| スクリプト拡張機能を使用して Mongo DB を Ubuntu VM にインストールする |
このテンプレートでは、2 つの異なるスクリプトで Mongo DB を構成して Ubuntu 仮想マシンにインストールします。 このテンプレートは、同じ仮想マシンで実行されている 2 つのスクリプト間の依存関係を表現する方法を示す良い例です。 このテンプレートでは、ストレージ アカウント、Virtual Network、パブリック IP アドレス、ネットワーク インターフェイスもデプロイされます。 |
Terraform (AzAPI プロバイダー) リソース定義
virtualMachines/extensions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachines/extensions@2021-07-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
instanceView = {
name = "string"
statuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
substatuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
type = "string"
typeHandlerVersion = "string"
}
publisher = "string"
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
})
}
プロパティ値
virtualMachines/extensions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Compute/virtualMachines/extensions@2021-07-01" |
| name | リソース名 | string (必須) |
| location | リソースの場所 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: virtualMachines |
| tags | リソース タグ | タグ名と値のディクショナリ。 |
| properties | 仮想マシン拡張機能のプロパティについて説明します。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 | [bool] |
| enableAutomaticUpgrade | 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 | [bool] |
| forceUpdateTag | 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 | string |
| instanceView | 仮想マシン拡張機能インスタンス ビュー。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 | |
| publisher | 拡張ハンドラーの発行元の名前。 | string |
| settings | 拡張機能の Json 形式のパブリック設定。 | |
| suppressFailures | 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 | [bool] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
VirtualMachineExtensionInstanceView
| 名前 | 説明 | 値 |
|---|---|---|
| name | 仮想マシンの拡張機能名。 | string |
| statuses | リソースの状態情報。 | InstanceViewStatus[] |
| substatuses | リソースの状態情報。 | InstanceViewStatus[] |
| 型 | 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 | string |
| typeHandlerVersion | スクリプト ハンドラーのバージョンを指定します。 | string |
InstanceViewStatus
| 名前 | 説明 | 値 |
|---|---|---|
| code | ステータス コード。 | string |
| displayStatus | 状態の短いローカライズ可能なラベル。 | string |
| レベル | レベル コード。 | "エラー" "Info" "Warning" |
| message | アラートやエラー メッセージを含む詳細なステータス メッセージ。 | string |
| time | 状態の時刻。 | string |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示