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 參數

名稱	位於	必要	類型	Description
guestConfigurationAssignmentName	path	True	string	來賓組態指派的名稱。
resourceGroupName	path	True	string	資源組名。 Regex 模式: ^[-\w\._]+$
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶標識碼。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
vmName	path	True	string	虛擬機的名稱。 Regex 模式: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
location	string	VM 所在的區域。
name	string	來賓組態指派的名稱。
properties	GuestConfigurationAssignmentProperties	來賓組態指派的屬性。

回應

名稱	類型	Description
200 OK	GuestConfigurationAssignment	還行。 已成功更新 VM 的客體設定指派。
201 Created	GuestConfigurationAssignment	創建。 已成功建立 VM 的客體設定指派。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
actionAfterReboot	指定在設定應用程式期間重新啟動後會發生什麼情況。 可能的值為 ContinueConfiguration 和 StopConfiguration
AssignmentInfo	來賓設定指派的相關信息。
AssignmentReport
AssignmentReportResource	來賓設定指派資源。
AssignmentReportResourceComplianceReason	客體設定指派資源合規性的原因和程序代碼。
assignmentType	指定組態的指派類型和執行。 可能的值為 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。
complianceStatus	值，指出指派之客體設定之計算機的合規性狀態。
ConfigurationInfo	組態的相關信息。
configurationMode	指定 LCM（Local Configuration Manager） 如何實際將設定套用至目標節點。 可能的值為 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。
ConfigurationParameter	表示組態參數。
ConfigurationSetting	LCM 的組態設定（本機組態管理員）。
createdByType	建立資源的身分識別類型。
Error
ErrorResponse	作業失敗的錯誤回應
GuestConfigurationAssignment	客體設定指派是計算機與客體設定之間的關聯。
GuestConfigurationAssignmentProperties	來賓設定指派屬性。
GuestConfigurationNavigation	客體設定是封裝 DSC 組態及其相依性的成品。 成品是一個 ZIP 檔案，其中包含 DSC 組態（如 MOF），以及相依資源和其他相依性，例如模組。
kind	客體設定的種類。 例如：DSC
provisioningState	只出現在回應中的布建狀態。
systemData	與建立和上次修改資源相關的元數據。
type	報表類型、一致性或初始
VMInfo	VM 的相關信息。
VMSSVMInfo	VMSS VM 的相關信息

actionAfterReboot

指定在設定應用程式期間重新啟動後會發生什麼情況。 可能的值為 ContinueConfiguration 和 StopConfiguration

名稱	類型	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

來賓設定指派的相關信息。

名稱	類型	Description
configuration	ConfigurationInfo	組態的相關信息。
name	string	來賓組態指派的名稱。

AssignmentReport

名稱	類型	Description
assignment	AssignmentInfo	客體設定指派的組態詳細數據。
complianceStatus	complianceStatus	值，指出指派之客體設定之計算機的合規性狀態。
endTime	string	客體設定指派合規性狀態檢查的結束日期和時間。
id	string	客體設定指派之報告的 ARM 資源識別碼。
operationType	type	報表類型、一致性或初始
reportId	string	GUID，識別訂用帳戶、資源群組底下的來賓設定指派報告。
resources	AssignmentReportResource[]	檢查客體設定指派合規性的資源清單。
startTime	string	客體設定指派合規性狀態檢查的開始日期和時間。
vm	VMInfo	VM 的相關信息。

AssignmentReportResource

來賓設定指派資源。

名稱	類型	Description
complianceStatus	complianceStatus	值，指出指派之客體設定之計算機的合規性狀態。
properties	object	客體設定指派資源的屬性。
reasons	AssignmentReportResourceComplianceReason[]	資源的合規性原因和原因代碼。
resourceId	string	來賓設定指派資源設定的名稱。

AssignmentReportResourceComplianceReason

客體設定指派資源合規性的原因和程序代碼。

名稱	類型	Description
code	string	客體設定指派資源合規性的程序代碼。
phrase	string	客體設定指派資源合規性的原因。

assignmentType

指定組態的指派類型和執行。 可能的值為 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。

名稱	類型	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

值，指出指派之客體設定之計算機的合規性狀態。

名稱	類型	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

組態的相關信息。

名稱	類型	Description
name	string	組態的名稱。
version	string	組態的版本。

configurationMode

指定 LCM（Local Configuration Manager） 如何實際將設定套用至目標節點。 可能的值為 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。

名稱	類型	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

表示組態參數。

名稱	類型	Description
name	string	組態參數的名稱。
value	string	組態參數的值。

ConfigurationSetting

LCM 的組態設定（本機組態管理員）。

名稱	類型	預設值	Description
actionAfterReboot	actionAfterReboot		指定在設定應用程式期間重新啟動後會發生什麼情況。 可能的值為 ContinueConfiguration 和 StopConfiguration
allowModuleOverwrite	boolean		如果為 true - 允許從提取服務下載的新組態覆寫目標節點上的舊組態。 否則為 false
configurationMode	configurationMode		指定 LCM（Local Configuration Manager） 如何實際將設定套用至目標節點。 可能的值為 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。
configurationModeFrequencyMins	number	15	在幾分鐘內，檢查並套用目前的設定的頻率。 如果 ConfigurationMode 屬性設定為 ApplyOnly，則會忽略這個屬性。 預設值為 15。
rebootIfNeeded	boolean		將此選項設定為 true，以在套用需要重新啟動的設定之後自動重新啟動節點。 否則，您必須針對需要節點的任何設定手動重新啟動節點。 默認值為 false。 若要在 DSC 以外的專案（例如 Windows Installer）制定重新啟動條件時使用此設定，請將此設定與 xPendingReboot 模組結合。
refreshFrequencyMins	number	30	時間間隔，以分鐘為單位，LCM 會檢查提取服務以取得更新的組態。 如果未在提取模式中設定 LCM，則會忽略此值。 預設值為 30。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

名稱	類型	Description
code	string	錯誤碼。
message	string	詳細數據錯誤訊息，指出作業失敗的原因。

ErrorResponse

作業失敗的錯誤回應

名稱	類型	Description
error	Error

GuestConfigurationAssignment

客體設定指派是計算機與客體設定之間的關聯。

名稱	類型	Description
id	string	客體設定指派的 ARM 資源識別碼。
location	string	VM 所在的區域。
name	string	來賓組態指派的名稱。
properties	GuestConfigurationAssignmentProperties	來賓組態指派的屬性。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。

GuestConfigurationAssignmentProperties

來賓設定指派屬性。

名稱	類型	Description
assignmentHash	string	組態套件和參數的合併哈希。
complianceStatus	complianceStatus	值，指出指派之客體設定之計算機的合規性狀態。
context	string	起始客體設定指派的來源。 例如：Azure 原則
guestConfiguration	GuestConfigurationNavigation	要指派的來賓設定。
lastComplianceStatusChecked	string	上次檢查合規性狀態的日期和時間。
latestAssignmentReport	AssignmentReport	上次回報的來賓設定指派報告。
latestReportId	string	客體設定指派的最新報告標識碼。
parameterHash	string	客體組態指派的參數哈希。
provisioningState	provisioningState	只出現在回應中的布建狀態。
resourceType	string	資源類型 - VMSS / VM
targetResourceId	string	VM 資源識別碼。
vmssVMList	VMSSVMInfo[]	VMSS 的 VM 合規性數據清單

GuestConfigurationNavigation

客體設定是封裝 DSC 組態及其相依性的成品。 成品是一個 ZIP 檔案，其中包含 DSC 組態（如 MOF），以及相依資源和其他相依性，例如模組。

名稱	類型	Description
assignmentSource	string	指定組態的來源。
assignmentType	assignmentType	指定組態的指派類型和執行。 可能的值為 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。
configurationParameter	ConfigurationParameter[]	客體設定的組態參數。
configurationProtectedParameter	ConfigurationParameter[]	來賓設定的受保護組態參數。
configurationSetting	ConfigurationSetting	來賓設定的組態設定。
contentHash	string	客體組態套件和組態參數的合併哈希。
contentManagedIdentity	string	具有客體組態套件和組態參數記憶體存取權的受控識別。
contentType	string	指定組態的內容類型。 可能的值為 Builtin 或 Custom。
contentUri	string	上傳客體設定套件之記憶體的 URI。
kind	kind	客體設定的種類。 例如：DSC
name	string	來賓組態的名稱。
version	string	客體設定的版本。

kind

客體設定的種類。 例如：DSC

名稱	類型	Description
DSC	string

provisioningState

只出現在回應中的布建狀態。

名稱	類型	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

type

報表類型、一致性或初始

名稱	類型	Description
Consistency	string
Initial	string

VMInfo

VM 的相關信息。

名稱	類型	Description
id	string	VM 的 Azure 資源識別碼。
uuid	string	VM 的 UUID（通用唯一識別符）。

VMSSVMInfo

VMSS VM 的相關信息

名稱	類型	Description
complianceStatus	complianceStatus	值，指出指派之客體設定之計算機的合規性狀態。
lastComplianceChecked	string	上次檢查合規性狀態的日期和時間。
latestReportId	string	客體設定指派的最新報告標識碼。
vmId	string	VM 的 UUID。
vmResourceId	string	VM 的 Azure 資源識別碼。