Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20
Bicep リソース定義
guestConfigurationAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope
使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
properties: {
context: 'string'
guestConfiguration: {
assignmentType: 'string'
configurationParameter: [
{
name: 'string'
value: 'string'
}
]
configurationProtectedParameter: [
{
name: 'string'
value: 'string'
}
]
configurationSetting: {
actionAfterReboot: 'string'
allowModuleOverwrite: bool
configurationMode: 'string'
configurationModeFrequencyMins: int
rebootIfNeeded: bool
refreshFrequencyMins: int
}
contentHash: 'string'
contentUri: 'string'
kind: 'DSC'
name: 'string'
version: 'string'
}
vmssVMList: [
{
}
]
}
}
プロパティの値
guestConfigurationAssignments
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) |
location | VM が配置されているリージョン。 | string |
scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
properties | ゲスト構成割り当てのプロパティ。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
context | ゲスト構成の割り当てを開始したソース。 例: Azure Policy | string |
guestConfiguration | 割り当てるゲスト構成。 | GuestConfigurationNavigation |
vmssVMList | VMSS の VM コンプライアンス データの一覧 | VmssvmInfo[] |
GuestConfigurationNavigation
名前 | 説明 | 値 |
---|---|---|
assignmentType | 構成の割り当ての種類と実行を指定します。 使用できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。 | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect' |
configurationParameter | ゲスト構成の構成パラメーター。 | ConfigurationParameter[] |
configurationProtectedParameter | ゲスト構成の保護された構成パラメーター。 | ConfigurationParameter[] |
configurationSetting | ゲスト構成の構成設定。 | ConfigurationSetting |
contentHash | ゲスト構成パッケージと構成パラメーターの結合ハッシュ。 | string |
contentUri | ゲスト構成パッケージがアップロードされるストレージの URI。 | string |
kind | ゲスト構成の種類。 例: DSC | 'DSC' |
name | ゲスト構成の名前。 | string |
version | ゲスト構成のバージョン。 | string |
ConfigurationParameter
名前 | 説明 | 値 |
---|---|---|
name | 構成パラメーターの名前。 | string |
value | 構成パラメーターの値。 | string |
ConfigurationSetting
名前 | 説明 | 値 |
---|---|---|
actionAfterReboot | 構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。 | 'ContinueConfiguration' 'StopConfiguration' |
allowModuleOverwrite | true の場合、 プル サービスからダウンロードされた新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合は false | [bool] |
configurationMode | LCM(ローカル Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
configurationModeFrequencyMins | 現在の構成がチェックおよび適用される頻度 (分単位) ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。 既定値は 15 です。 | INT |
rebootIfNeeded | 再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。 設定しない場合は、再起動が必要な構成のノードを手動で再起動する必要があります。 既定値は false です。 DSC 以外 (Windows インストーラーなど) で再起動の条件が有効化されている場合にこの設定を使用するには、この設定を xPendingReboot モジュールと併用します。 | [bool] |
refreshFrequencyMins | LCM がプル サービスをチェックして最新の構成を取得する時間間隔 (分)。 この値は、LCM がプル モードで構成されていない場合は無視されます。 既定値は 30 です。 | INT |
VmssvmInfo
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure セキュリティで保護されたベースラインを使用した Windows VM |
テンプレートは、パブリック IP アドレスを使用して、新しい仮想ネットワークで Windows Server を実行する仮想マシンを作成します。 マシンがデプロイされると、ゲスト構成拡張機能がインストールされ、Windows Server 用の Azure セキュリティで保護されたベースラインが適用されます。 マシンの構成がずれている場合は、テンプレートをもう一度デプロイして設定を再適用できます。 |
ARM テンプレート リソース定義
guestConfigurationAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope
使用して、このリソースのスコープを設定します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
"apiVersion": "2018-11-20",
"name": "string",
"location": "string",
"scope": "string",
"properties": {
"context": "string",
"guestConfiguration": {
"assignmentType": "string",
"configurationParameter": [
{
"name": "string",
"value": "string"
}
],
"configurationProtectedParameter": [
{
"name": "string",
"value": "string"
}
],
"configurationSetting": {
"actionAfterReboot": "string",
"allowModuleOverwrite": "bool",
"configurationMode": "string",
"configurationModeFrequencyMins": "int",
"rebootIfNeeded": "bool",
"refreshFrequencyMins": "int"
},
"contentHash": "string",
"contentUri": "string",
"kind": "DSC",
"name": "string",
"version": "string"
},
"vmssVMList": [
{
}
]
}
}
プロパティの値
guestConfigurationAssignments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.GuestConfiguration/guestConfigurationAssignments' |
apiVersion | リソース API のバージョン | '2018-11-20' |
name | リソース名 | string (必須) |
location | VM が配置されているリージョン。 | string |
scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定 します 。 |
properties | ゲスト構成割り当てのプロパティ。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
context | ゲスト構成の割り当てを開始したソース。 例: Azure Policy | string |
guestConfiguration | 割り当てるゲスト構成。 | GuestConfigurationNavigation |
vmssVMList | VMSS の VM コンプライアンス データの一覧 | VmssvmInfo[] |
GuestConfigurationNavigation
名前 | 説明 | 値 |
---|---|---|
assignmentType | 構成の割り当ての種類と実行を指定します。 使用できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。 | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect' |
configurationParameter | ゲスト構成の構成パラメーター。 | ConfigurationParameter[] |
configurationProtectedParameter | ゲスト構成の保護された構成パラメーター。 | ConfigurationParameter[] |
configurationSetting | ゲスト構成の構成設定。 | ConfigurationSetting |
contentHash | ゲスト構成パッケージと構成パラメーターの結合ハッシュ。 | string |
contentUri | ゲスト構成パッケージがアップロードされるストレージの URI。 | string |
kind | ゲスト構成の種類。 例: DSC | 'DSC' |
name | ゲスト構成の名前。 | string |
version | ゲスト構成のバージョン。 | string |
ConfigurationParameter
名前 | 説明 | 値 |
---|---|---|
name | 構成パラメーターの名前。 | string |
value | 構成パラメーターの値。 | string |
ConfigurationSetting
名前 | 説明 | 値 |
---|---|---|
actionAfterReboot | 構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。 | 'ContinueConfiguration' 'StopConfiguration' |
allowModuleOverwrite | true の場合、 プル サービスからダウンロードした新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合は false | [bool] |
configurationMode | LCM(ローカル Configuration Manager) がターゲット ノードに構成を実際に適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 | 'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly' |
configurationModeFrequencyMins | 現在の構成がチェックおよび適用される頻度 (分単位) ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。 既定値は 15 です。 | INT |
rebootIfNeeded | 再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。 設定しない場合は、再起動が必要な構成のノードを手動で再起動する必要があります。 既定値は false です。 DSC 以外 (Windows インストーラーなど) で再起動の条件が有効化されている場合にこの設定を使用するには、この設定を xPendingReboot モジュールと併用します。 | [bool] |
refreshFrequencyMins | LCM がプル サービスをチェックして最新の構成を取得する時間間隔 (分)。 この値は、LCM がプル モードで構成されていない場合は無視されます。 既定値は 30 です。 | INT |
VmssvmInfo
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure セキュリティで保護されたベースラインを使用した Windows VM |
テンプレートは、パブリック IP アドレスを使用して、新しい仮想ネットワークで Windows Server を実行している仮想マシンを作成します。 マシンがデプロイされると、ゲスト構成拡張機能がインストールされ、Windows Server 用の Azure セキュリティで保護されたベースラインが適用されます。 マシンの構成がずれている場合は、テンプレートをもう一度デプロイして設定を再適用できます。 |
Terraform (AzAPI プロバイダー) リソース定義
guestConfigurationAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを parent_id
設定するには、このリソースの プロパティを使用します。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
name = "string"
location = "string"
parent_id = "string"
body = jsonencode({
properties = {
context = "string"
guestConfiguration = {
assignmentType = "string"
configurationParameter = [
{
name = "string"
value = "string"
}
]
configurationProtectedParameter = [
{
name = "string"
value = "string"
}
]
configurationSetting = {
actionAfterReboot = "string"
allowModuleOverwrite = bool
configurationMode = "string"
configurationModeFrequencyMins = int
rebootIfNeeded = bool
refreshFrequencyMins = int
}
contentHash = "string"
contentUri = "string"
kind = "DSC"
name = "string"
version = "string"
}
vmssVMList = [
{
}
]
}
})
}
プロパティの値
guestConfigurationAssignments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20" |
name | リソース名 | string (必須) |
location | VM が配置されているリージョン。 | string |
parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
properties | ゲスト構成割り当てのプロパティ。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
context | ゲスト構成の割り当てを開始したソース。 例: Azure Policy | string |
guestConfiguration | 割り当てるゲスト構成。 | GuestConfigurationNavigation |
vmssVMList | VMSS の VM コンプライアンス データの一覧 | VmssvmInfo[] |
GuestConfigurationNavigation
名前 | 説明 | 値 |
---|---|---|
assignmentType | 構成の割り当ての種類と実行を指定します。 使用できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。 | "ApplyAndAutoCorrect" "ApplyAndMonitor" "監査" "DeployAndAutoCorrect" |
configurationParameter | ゲスト構成の構成パラメーター。 | ConfigurationParameter[] |
configurationProtectedParameter | ゲスト構成の保護された構成パラメーター。 | ConfigurationParameter[] |
configurationSetting | ゲスト構成の構成設定。 | ConfigurationSetting |
contentHash | ゲスト構成パッケージと構成パラメーターの結合ハッシュ。 | string |
contentUri | ゲスト構成パッケージがアップロードされるストレージの URI。 | string |
kind | ゲスト構成の種類。 例: DSC | "DSC" |
name | ゲスト構成の名前。 | string |
version | ゲスト構成のバージョン。 | string |
ConfigurationParameter
名前 | 説明 | 値 |
---|---|---|
name | 構成パラメーターの名前。 | string |
value | 構成パラメーターの値。 | string |
ConfigurationSetting
名前 | 説明 | 値 |
---|---|---|
actionAfterReboot | 構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。 | "ContinueConfiguration" "StopConfiguration" |
allowModuleOverwrite | true の場合、 プル サービスからダウンロードした新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合は false | [bool] |
configurationMode | LCM(ローカル Configuration Manager) がターゲット ノードに構成を実際に適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 | "ApplyAndAutoCorrect" "ApplyAndMonitor" "ApplyOnly" |
configurationModeFrequencyMins | 現在の構成がチェックおよび適用される頻度 (分単位) ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。 既定値は 15 です。 | INT |
rebootIfNeeded | 再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。 設定しない場合は、再起動が必要な構成のノードを手動で再起動する必要があります。 既定値は false です。 DSC 以外 (Windows インストーラーなど) で再起動の条件が有効化されている場合にこの設定を使用するには、この設定を xPendingReboot モジュールと併用します。 | [bool] |
refreshFrequencyMins | LCM がプル サービスをチェックして最新の構成を取得する時間間隔 (分)。 この値は、LCM がプル モードで構成されていない場合は無視されます。 既定値は 30 です。 | INT |
VmssvmInfo
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示