Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

[アーティクル]
12/21/2024

Bicep リソース定義

guestConfigurationAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: '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: 'string'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {}
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {}
    ]
  }
}

プロパティ値

AssignmentInfo

名前	形容	価値
構成	構成に関する情報。	ConfigurationInfo

AssignmentReport

名前	形容	価値
割り当て	ゲスト構成割り当ての構成の詳細。	AssignmentInfo
リソース	ゲスト構成の割り当てコンプライアンスがチェックされるリソースの一覧。	AssignmentReportResource[]
vm	VM に関する情報。	VMInfo をする

AssignmentReportResource

名前	形容	価値
理由	リソースのコンプライアンス理由と理由コード。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名前	形容	価値

ConfigurationInfo

名前	形容	価値

ConfigurationParameter

名前	形容	価値
名前	構成パラメーターの名前。	糸
価値	構成パラメーターの値。	糸

ConfigurationSetting

名前	形容	価値
actionAfterReboot	構成の適用中に再起動した後の動作を指定します。指定できる値は ContinueConfiguration と StopConfiguration です。	'ContinueConfiguration' 'StopConfiguration'
allowModuleOverwrite	true の場合、プルサービスからダウンロードされた新しい構成は、ターゲットノード上の古い構成を上書きできます。それ以外の場合は false	bool
configurationMode	LCM (ローカル構成マネージャー) が実際にターゲットノードに構成を適用する方法を指定します。指定できる値は、ApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrect です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly'
configurationModeFrequencyMins	現在の構成を確認して適用する頻度 (分単位)。 ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。既定値は 15 です。	int
rebootIfNeeded	再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。それ以外の場合は、必要な構成に対してノードを手動で再起動する必要があります。既定値は false です。 DSC 以外 (Windows インストーラーなど) によって再起動条件が適用された場合にこの設定を使用するには、この設定を xPendingReboot モジュールと組み合わせます。	bool
refreshFrequencyMins	LCM がプルサービスをチェックして更新された構成を取得する時間間隔 (分)。 LCM がプルモードで構成されていない場合、この値は無視されます。既定値は 30 です。	int

GuestConfigurationAssignmentProperties

名前	形容	価値
文脈	ゲスト構成の割り当てを開始したソース。例: Azure Policy	糸
guestConfiguration	割り当てるゲスト構成。	GuestConfigurationNavigation
latestAssignmentReport	最後に報告されたゲスト構成の割り当てレポート。	AssignmentReport
vmssVMList	VMSS の VM コンプライアンスデータの一覧	VmssvmInfo[]

GuestConfigurationNavigation

名前	形容	価値
assignmentType	構成の割り当ての種類と実行を指定します。指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	ゲスト構成の構成パラメーター。	ConfigurationParameter[]
configurationProtectedParameter	ゲスト構成の保護された構成パラメーター。	ConfigurationParameter[]
configurationSetting	ゲスト構成の構成設定。	ConfigurationSetting
contentHash	ゲスト構成パッケージと構成パラメーターの結合ハッシュ。	糸
contentUri	ゲスト構成パッケージがアップロードされるストレージの URI。	糸
種類	ゲスト構成の種類。例: DSC	'DSC'
名前	ゲスト構成の名前。	糸
バージョン	ゲスト構成のバージョン。	糸

Microsoft.GuestConfiguration/guestConfigurationAssignments

名前	形容	価値
場所	VM が配置されているリージョン。	糸
名前	リソース名	string (必須)
プロパティ	ゲスト構成割り当てのプロパティ。	GuestConfigurationAssignmentProperties
スコープ	デプロイスコープとは異なるスコープでリソースを作成するときに使用します。	このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。

VMInfo

名前	形容	価値

VmssvmInfo

名前	形容	価値

使用例

Azure クイックスタートのサンプル

次 Azure クイックスタートテンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル	形容
IIS VM & SQL Server 2014 VM	VNET で 1 つまたは 2 つの IIS Windows 2012 R2 Web サーバーと 1 つのバックエンド SQL Server 2014 を作成します。
Azure のセキュリティで保護されたベースラインを使用して Windows VM をする	このテンプレートでは、パブリック IP アドレスを使用して、Windows Server を実行する仮想マシンを新しい仮想ネットワークに作成します。マシンがデプロイされると、ゲスト構成拡張機能がインストールされ、Windows Server 用の Azure のセキュリティで保護されたベースラインが適用されます。マシンの構成がずれている場合は、テンプレートをもう一度デプロイすることで、設定を再適用できます。

Bicep ファイル

形容

IIS VM & SQL Server 2014 VM

VNET で 1 つまたは 2 つの IIS Windows 2012 R2 Web サーバーと 1 つのバックエンド SQL Server 2014 を作成します。

Azure のセキュリティで保護されたベースラインを使用して Windows VM をする

このテンプレートでは、パブリック IP アドレスを使用して、Windows Server を実行する仮想マシンを新しい仮想ネットワークに作成します。マシンがデプロイされると、ゲスト構成拡張機能がインストールされ、Windows Server 用の Azure のセキュリティで保護されたベースラインが適用されます。マシンの構成がずれている場合は、テンプレートをもう一度デプロイすることで、設定を再適用できます。

ARM テンプレートリソース定義

guestConfigurationAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2021-01-25",
  "name": "string",
  "location": "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": "string",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {
        }
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {
      }
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

プロパティ値

AssignmentInfo

名前	形容	価値
構成	構成に関する情報。	ConfigurationInfo

AssignmentReport

名前	形容	価値
割り当て	ゲスト構成割り当ての構成の詳細。	AssignmentInfo
リソース	ゲスト構成の割り当てコンプライアンスがチェックされるリソースの一覧。	AssignmentReportResource[]
vm	VM に関する情報。	VMInfo をする

AssignmentReportResource

名前	形容	価値
理由	リソースのコンプライアンス理由と理由コード。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名前	形容	価値

ConfigurationInfo

名前	形容	価値

ConfigurationParameter

名前	形容	価値
名前	構成パラメーターの名前。	糸
価値	構成パラメーターの値。	糸

ConfigurationSetting

名前	形容	価値
actionAfterReboot	構成の適用中に再起動した後の動作を指定します。指定できる値は ContinueConfiguration と StopConfiguration です。	'ContinueConfiguration' 'StopConfiguration'
allowModuleOverwrite	true の場合、プルサービスからダウンロードされた新しい構成は、ターゲットノード上の古い構成を上書きできます。それ以外の場合は false	bool
configurationMode	LCM (ローカル構成マネージャー) が実際にターゲットノードに構成を適用する方法を指定します。指定できる値は、ApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrect です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly'
configurationModeFrequencyMins	現在の構成を確認して適用する頻度 (分単位)。 ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。既定値は 15 です。	int
rebootIfNeeded	再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。それ以外の場合は、必要な構成に対してノードを手動で再起動する必要があります。既定値は false です。 DSC 以外 (Windows インストーラーなど) によって再起動条件が適用された場合にこの設定を使用するには、この設定を xPendingReboot モジュールと組み合わせます。	bool
refreshFrequencyMins	LCM がプルサービスをチェックして更新された構成を取得する時間間隔 (分)。 LCM がプルモードで構成されていない場合、この値は無視されます。既定値は 30 です。	int

GuestConfigurationAssignmentProperties

名前	形容	価値
文脈	ゲスト構成の割り当てを開始したソース。例: Azure Policy	糸
guestConfiguration	割り当てるゲスト構成。	GuestConfigurationNavigation
latestAssignmentReport	最後に報告されたゲスト構成の割り当てレポート。	AssignmentReport
vmssVMList	VMSS の VM コンプライアンスデータの一覧	VmssvmInfo[]

GuestConfigurationNavigation

名前	形容	価値
assignmentType	構成の割り当ての種類と実行を指定します。指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	ゲスト構成の構成パラメーター。	ConfigurationParameter[]
configurationProtectedParameter	ゲスト構成の保護された構成パラメーター。	ConfigurationParameter[]
configurationSetting	ゲスト構成の構成設定。	ConfigurationSetting
contentHash	ゲスト構成パッケージと構成パラメーターの結合ハッシュ。	糸
contentUri	ゲスト構成パッケージがアップロードされるストレージの URI。	糸
種類	ゲスト構成の種類。例: DSC	'DSC'
名前	ゲスト構成の名前。	糸
バージョン	ゲスト構成のバージョン。	糸

Microsoft.GuestConfiguration/guestConfigurationAssignments

名前	形容	価値
apiVersion	API のバージョン	'2021-01-25'
場所	VM が配置されているリージョン。	糸
名前	リソース名	string (必須)
プロパティ	ゲスト構成割り当てのプロパティ。	GuestConfigurationAssignmentProperties
種類	リソースの種類	'Microsoft.GuestConfiguration/guestConfigurationAssignments'

VMInfo

名前	形容	価値

VmssvmInfo

名前	形容	価値

使用例

Azure クイックスタートテンプレート

このリソースの種類デプロイする Azure クイックスタートテンプレート次に示します。

テンプレート	形容
IIS VM & SQL Server 2014 VM Azure にデプロイする	VNET で 1 つまたは 2 つの IIS Windows 2012 R2 Web サーバーと 1 つのバックエンド SQL Server 2014 を作成します。
Azure のセキュリティで保護されたベースラインを使用して Windows VM をする Azure にデプロイする	このテンプレートでは、パブリック IP アドレスを使用して、Windows Server を実行する仮想マシンを新しい仮想ネットワークに作成します。マシンがデプロイされると、ゲスト構成拡張機能がインストールされ、Windows Server 用の Azure のセキュリティで保護されたベースラインが適用されます。マシンの構成がずれている場合は、テンプレートをもう一度デプロイすることで、設定を再適用できます。

テンプレート

形容

IIS VM & SQL Server 2014 VM

Azure にデプロイする

VNET で 1 つまたは 2 つの IIS Windows 2012 R2 Web サーバーと 1 つのバックエンド SQL Server 2014 を作成します。

Azure のセキュリティで保護されたベースラインを使用して Windows VM をする

Azure にデプロイする

Terraform (AzAPI プロバイダー) リソース定義

guestConfigurationAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.GuestConfiguration/guestConfigurationAssignments リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
  name = "string"
  parent_id = "string"
  location = "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 = "string"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {
          }
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {
        }
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

プロパティ値

AssignmentInfo

名前	形容	価値
構成	構成に関する情報。	ConfigurationInfo

AssignmentReport

名前	形容	価値
割り当て	ゲスト構成割り当ての構成の詳細。	AssignmentInfo
リソース	ゲスト構成の割り当てコンプライアンスがチェックされるリソースの一覧。	AssignmentReportResource[]
vm	VM に関する情報。	VMInfo をする

AssignmentReportResource

名前	形容	価値
理由	リソースのコンプライアンス理由と理由コード。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名前	形容	価値

ConfigurationInfo

名前	形容	価値

ConfigurationParameter

名前	形容	価値
名前	構成パラメーターの名前。	糸
価値	構成パラメーターの値。	糸

ConfigurationSetting

名前	形容	価値
actionAfterReboot	構成の適用中に再起動した後の動作を指定します。指定できる値は ContinueConfiguration と StopConfiguration です。	'ContinueConfiguration' 'StopConfiguration'
allowModuleOverwrite	true の場合、プルサービスからダウンロードされた新しい構成は、ターゲットノード上の古い構成を上書きできます。それ以外の場合は false	bool
configurationMode	LCM (ローカル構成マネージャー) が実際にターゲットノードに構成を適用する方法を指定します。指定できる値は、ApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrect です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'ApplyOnly'
configurationModeFrequencyMins	現在の構成を確認して適用する頻度 (分単位)。 ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。既定値は 15 です。	int
rebootIfNeeded	再起動を必要とする構成が適用された後にノードを自動的に再起動するには、これを true に設定します。それ以外の場合は、必要な構成に対してノードを手動で再起動する必要があります。既定値は false です。 DSC 以外 (Windows インストーラーなど) によって再起動条件が適用された場合にこの設定を使用するには、この設定を xPendingReboot モジュールと組み合わせます。	bool
refreshFrequencyMins	LCM がプルサービスをチェックして更新された構成を取得する時間間隔 (分)。 LCM がプルモードで構成されていない場合、この値は無視されます。既定値は 30 です。	int

GuestConfigurationAssignmentProperties

名前	形容	価値
文脈	ゲスト構成の割り当てを開始したソース。例: Azure Policy	糸
guestConfiguration	割り当てるゲスト構成。	GuestConfigurationNavigation
latestAssignmentReport	最後に報告されたゲスト構成の割り当てレポート。	AssignmentReport
vmssVMList	VMSS の VM コンプライアンスデータの一覧	VmssvmInfo[]

GuestConfigurationNavigation

名前	形容	価値
assignmentType	構成の割り当ての種類と実行を指定します。指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	ゲスト構成の構成パラメーター。	ConfigurationParameter[]
configurationProtectedParameter	ゲスト構成の保護された構成パラメーター。	ConfigurationParameter[]
configurationSetting	ゲスト構成の構成設定。	ConfigurationSetting
contentHash	ゲスト構成パッケージと構成パラメーターの結合ハッシュ。	糸
contentUri	ゲスト構成パッケージがアップロードされるストレージの URI。	糸
種類	ゲスト構成の種類。例: DSC	'DSC'
名前	ゲスト構成の名前。	糸
バージョン	ゲスト構成のバージョン。	糸

Microsoft.GuestConfiguration/guestConfigurationAssignments

名前	形容	価値
場所	VM が配置されているリージョン。	糸
名前	リソース名	string (必須)
parent_id	この拡張リソースを適用するリソースの ID。	string (必須)
プロパティ	ゲスト構成割り当てのプロパティ。	GuestConfigurationAssignmentProperties
種類	リソースの種類	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"

VMInfo

名前	形容	価値

VmssvmInfo

名前	形容	価値

次の方法で共有

Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Bicep リソース定義

リソースの形式

プロパティ値

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

使用例

Azure クイック スタートのサンプル

ARM テンプレート リソース定義

リソースの形式

プロパティ値

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

使用例

Azure クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

プロパティ値

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

フィードバック

その他のリソース

Azure クイックスタートのサンプル

ARM テンプレートリソース定義

Azure クイックスタートテンプレート