Guest Configuration Assignments - Create Or Update

サービス:

Guest Configuration

API バージョン:

2024-04-05

VM とゲスト構成の間の関連付けを作成します

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2024-04-05

URI パラメーター

名前	/	必須	型	説明
guestConfigurationAssignmentName	path	True	string	ゲスト構成割り当ての名前。
resourceGroupName	path	True	string	リソース グループ名。 正規表現パターン: ^[-\w\._]+$
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
vmName	path	True	string	仮想マシンの名前。 正規表現パターン: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
location	string	VM が配置されているリージョン。
name	string	ゲスト構成割り当ての名前。
properties	GuestConfigurationAssignmentProperties	ゲスト構成割り当てのプロパティ。

応答

名前	型	説明
200 OK	GuestConfigurationAssignment	わかりました。 VM のゲスト構成の割り当てが正常に更新されました。
201 Created	GuestConfigurationAssignment	作成。 VM のゲスト構成の割り当てが正常に作成されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Create or update guest configuration assignment

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows?api-version=2024-04-05

{
  "location": "westcentralus",
  "name": "NotInstalledApplicationForWindows",
  "properties": {
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "version": "1.0.0.3",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "contentManagedIdentity": "test_identity",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.GuestConfiguration.Models;
using Azure.ResourceManager.GuestConfiguration;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionId";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Compute/virtualMachines/{2}", subscriptionId, resourceGroupName, vmName));
GuestConfigurationVmAssignmentCollection collection = client.GetGuestConfigurationVmAssignments(scopeId);

// invoke the operation
string guestConfigurationAssignmentName = "NotInstalledApplicationForWindows";
GuestConfigurationAssignmentData data = new GuestConfigurationAssignmentData()
{
    Properties = new GuestConfigurationAssignmentProperties()
    {
        GuestConfiguration = new GuestConfigurationNavigation()
        {
            Name = "NotInstalledApplicationForWindows",
            Version = "1.0.0.3",
            ContentUri = new Uri("https://thisisfake/pacakge"),
            ContentHash = "123contenthash",
            ContentManagedIdentity = "test_identity",
            AssignmentType = GuestConfigurationAssignmentType.ApplyAndAutoCorrect,
            ConfigurationParameters =
            {
            new GuestConfigurationParameter()
            {
            Name = "[InstalledApplication]NotInstalledApplicationResource1;Name",
            Value = "NotePad,sql",
            }
            },
        },
        Context = "Azure policy",
    },
    Name = "NotInstalledApplicationForWindows",
    Location = new AzureLocation("westcentralus"),
};
ArmOperation<GuestConfigurationVmAssignmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, guestConfigurationAssignmentName, data);
GuestConfigurationVmAssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GuestConfigurationAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

201

{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "name": "NotInstalledApplicationForWindows",
  "properties": {
    "complianceStatus": "Pending",
    "assignmentHash": null,
    "latestReportId": null,
    "lastComplianceStatusChecked": null,
    "context": "Azure policy",
    "resourceType": null,
    "vmssVMList": null,
    "guestConfiguration": {
      "kind": null,
      "name": "NotInstalledApplicationForWindows",
      "version": "1.0.0.3",
      "contentUri": null,
      "contentHash": null,
      "contentType": null,
      "contentManagedIdentity": null,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

状態コード:

200

{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "name": "NotInstalledApplicationForWindows",
  "properties": {
    "complianceStatus": "Pending",
    "assignmentHash": null,
    "latestReportId": null,
    "lastComplianceStatusChecked": null,
    "context": "Azure policy",
    "resourceType": null,
    "vmssVMList": null,
    "guestConfiguration": {
      "kind": null,
      "name": "NotInstalledApplicationForWindows",
      "version": "1.0.0.3",
      "contentUri": null,
      "contentHash": null,
      "contentType": null,
      "contentManagedIdentity": null,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

定義

名前	説明
actionAfterReboot	構成の適用中に再起動した後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。
AssignmentInfo	ゲスト構成の割り当てに関する情報。
AssignmentReport
AssignmentReportResource	ゲスト構成の割り当てリソース。
AssignmentReportResourceComplianceReason	ゲスト構成割り当てリソースのコンプライアンスの理由とコード。
assignmentType	構成の割り当ての種類と実行を指定します。 指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。
complianceStatus	割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。
ConfigurationInfo	構成に関する情報。
configurationMode	LCM (ローカル構成マネージャー) が実際にターゲット ノードに構成を適用する方法を指定します。 指定できる値は、ApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrect です。
ConfigurationParameter	構成パラメーターを表します。
ConfigurationSetting	LCM の構成設定 (ローカル構成マネージャー)。
createdByType	リソースを作成した ID の種類。
Error
ErrorResponse	操作エラーのエラー応答
GuestConfigurationAssignment	ゲスト構成の割り当ては、マシンとゲスト構成の間の関連付けです。
GuestConfigurationAssignmentProperties	ゲスト構成の割り当てプロパティ。
GuestConfigurationNavigation	ゲスト構成は、DSC 構成とその依存関係をカプセル化する成果物です。 成果物は、DSC 構成 (MOF) と依存リソース、およびモジュールなどのその他の依存関係を含む zip ファイルです。
kind	ゲスト構成の種類。 例: DSC
provisioningState	プロビジョニング状態。応答にのみ表示されます。
systemData	リソースの作成と最後の変更に関連するメタデータ。
type	レポートの種類、整合性、または初期
VMInfo	VM に関する情報。
VMSSVMInfo	VMSS VM に関する情報

actionAfterReboot

構成の適用中に再起動した後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。

名前	型	説明
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

ゲスト構成の割り当てに関する情報。

名前	型	説明
configuration	ConfigurationInfo	構成に関する情報。
name	string	ゲスト構成割り当ての名前。

AssignmentReport

名前	型	説明
assignment	AssignmentInfo	ゲスト構成割り当ての構成の詳細。
complianceStatus	complianceStatus	割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。
endTime	string	ゲスト構成の割り当てコンプライアンス状態チェックの終了日時。
id	string	ゲスト構成割り当てのレポートの ARM リソース ID。
operationType	type	レポートの種類、整合性、または初期
reportId	string	サブスクリプションのリソース グループの下にあるゲスト構成割り当てレポートを識別する GUID。
resources	AssignmentReportResource[]	ゲスト構成の割り当てコンプライアンスがチェックされるリソースの一覧。
startTime	string	ゲスト構成の割り当てコンプライアンス状態チェックの開始日時。
vm	VMInfo	VM に関する情報。

AssignmentReportResource

ゲスト構成の割り当てリソース。

名前	型	説明
complianceStatus	complianceStatus	割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。
properties	object	ゲスト構成割り当てリソースのプロパティ。
reasons	AssignmentReportResourceComplianceReason[]	リソースのコンプライアンス理由と理由コード。
resourceId	string	ゲスト構成割り当てリソース設定の名前。

AssignmentReportResourceComplianceReason

ゲスト構成割り当てリソースのコンプライアンスの理由とコード。

名前	型	説明
code	string	ゲスト構成の割り当てリソースに準拠するためのコード。
phrase	string	ゲスト構成割り当てリソースのコンプライアンスの理由。

assignmentType

構成の割り当ての種類と実行を指定します。 指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。

名前	型	説明
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。

名前	型	説明
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

構成に関する情報。

名前	型	説明
name	string	構成の名前。
version	string	構成のバージョン。

configurationMode

LCM (ローカル構成マネージャー) が実際にターゲット ノードに構成を適用する方法を指定します。 指定できる値は、ApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrect です。

名前	型	説明
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

構成パラメーターを表します。

名前	型	説明
name	string	構成パラメーターの名前。
value	string	構成パラメーターの値。

ConfigurationSetting

LCM の構成設定 (ローカル構成マネージャー)。

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

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

Error

名前	型	説明
code	string	エラー コード。
message	string	操作が失敗した理由を示す詳細エラー メッセージ。

ErrorResponse

操作エラーのエラー応答

名前	型	説明
error	Error

GuestConfigurationAssignment

ゲスト構成の割り当ては、マシンとゲスト構成の間の関連付けです。

名前	型	説明
id	string	ゲスト構成割り当ての ARM リソース ID。
location	string	VM が配置されているリージョン。
name	string	ゲスト構成割り当ての名前。
properties	GuestConfigurationAssignmentProperties	ゲスト構成割り当てのプロパティ。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。

GuestConfigurationAssignmentProperties

ゲスト構成の割り当てプロパティ。

名前	型	説明
assignmentHash	string	構成パッケージとパラメーターの結合ハッシュ。
complianceStatus	complianceStatus	割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。
context	string	ゲスト構成の割り当てを開始したソース。 例: Azure Policy
guestConfiguration	GuestConfigurationNavigation	割り当てるゲスト構成。
lastComplianceStatusChecked	string	最後のコンプライアンスの状態が確認された日時。
latestAssignmentReport	AssignmentReport	最後に報告されたゲスト構成の割り当てレポート。
latestReportId	string	ゲスト構成割り当ての最新のレポートの ID。
parameterHash	string	ゲスト構成割り当てのパラメーター ハッシュ。
provisioningState	provisioningState	プロビジョニング状態。応答にのみ表示されます。
resourceType	string	リソースの種類 - VMSS/VM
targetResourceId	string	VM リソース ID。
vmssVMList	VMSSVMInfo[]	VMSS の VM コンプライアンス データの一覧

GuestConfigurationNavigation

ゲスト構成は、DSC 構成とその依存関係をカプセル化する成果物です。 成果物は、DSC 構成 (MOF) と依存リソース、およびモジュールなどのその他の依存関係を含む zip ファイルです。

名前	型	説明
assignmentSource	string	構成の配信元を指定します。
assignmentType	assignmentType	構成の割り当ての種類と実行を指定します。 指定できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。
configurationParameter	ConfigurationParameter[]	ゲスト構成の構成パラメーター。
configurationProtectedParameter	ConfigurationParameter[]	ゲスト構成の保護された構成パラメーター。
configurationSetting	ConfigurationSetting	ゲスト構成の構成設定。
contentHash	string	ゲスト構成パッケージと構成パラメーターの結合ハッシュ。
contentManagedIdentity	string	ゲスト構成パッケージと構成パラメーターのストレージ アクセス権を持つマネージド ID。
contentType	string	構成のコンテンツ タイプを指定します。 指定できる値は、Builtin または Custom です。
contentUri	string	ゲスト構成パッケージがアップロードされるストレージの URI。
kind	kind	ゲスト構成の種類。 例: DSC
name	string	ゲスト構成の名前。
version	string	ゲスト構成のバージョン。

kind

ゲスト構成の種類。 例: DSC

名前	型	説明
DSC	string

provisioningState

プロビジョニング状態。応答にのみ表示されます。

名前	型	説明
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

type

レポートの種類、整合性、または初期

名前	型	説明
Consistency	string
Initial	string

VMInfo

VM に関する情報。

名前	型	説明
id	string	VM の Azure リソース ID。
uuid	string	VM の UUID (汎用一意識別子)。

VMSSVMInfo

VMSS VM に関する情報

名前	型	説明
complianceStatus	complianceStatus	割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。
lastComplianceChecked	string	最後のコンプライアンスの状態が確認された日時。
latestReportId	string	ゲスト構成割り当ての最新のレポートの ID。
vmId	string	VM の UUID。
vmResourceId	string	VM の Azure リソース ID。