共用方式為


Guest Configuration Assignments - Subscription List

列出訂用帳戶的所有客體設定指派。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25

URI 參數

名稱 位於 必要 類型 Description
subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶標識碼。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

回應

名稱 類型 Description
200 OK

GuestConfigurationAssignmentList

確定

204 No Content

沒有內容

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 模擬您的用戶帳戶

範例

List all guest configuration assignments for a subscription

範例要求

GET https://management.azure.com/subscriptions/mySubscriptionId/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25

範例回覆

[
  {
    "location": "centraluseuap",
    "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2",
    "name": "AuditSecureProtocol2",
    "properties": {
      "complianceStatus": "Compliant",
      "assignmentHash": "content hash",
      "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
      "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
      "context": null,
      "guestConfiguration": {
        "kind": null,
        "name": "AuditSecureProtocol2",
        "version": "1.0.0.3",
        "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip",
        "contentHash": "content hash",
        "configurationParameter": [],
        "configurationSetting": null
      },
      "provisioningState": null
    }
  },
  {
    "location": "centraluseuap",
    "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment",
    "name": "myAssignment",
    "properties": {
      "complianceStatus": "Compliant",
      "assignmentHash": "content hash",
      "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
      "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
      "context": null,
      "guestConfiguration": {
        "kind": null,
        "name": "myAssignment",
        "version": "1.0.0.3",
        "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip",
        "contentHash": "content hash",
        "configurationParameter": [],
        "configurationSetting": null
      },
      "provisioningState": null
    }
  }
]

定義

名稱 Description
actionAfterReboot

指定套用設定期間在重新開機後的動作。 可能的值為 ContinueConfiguration 和 StopConfiguration

AssignmentInfo

客體設定指派的相關信息。

AssignmentReport
AssignmentReportResource

客體設定指派資源。

AssignmentReportResourceComplianceReason

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

assignmentType

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

complianceStatus

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

ConfigurationInfo

組態的相關信息。

configurationMode

指定 LCM (本機 Configuration Manager) 實際將設定套用至目標節點的方式。 可能的值為 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。

ConfigurationParameter

表示組態參數。

ConfigurationSetting

LCM (本機 Configuration Manager) 的組態設定。

createdByType

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

Error
ErrorResponse

作業失敗的錯誤回應

GuestConfigurationAssignment

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

GuestConfigurationAssignmentList

清單來賓設定指派作業的回應。

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 (本機 Configuration Manager) 實際將設定套用至目標節點的方式。 可能的值為 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。

名稱 類型 Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

表示組態參數。

名稱 類型 Description
name

string

組態參數的名稱。

value

string

組態參數的值。

ConfigurationSetting

LCM (本機 Configuration Manager) 的組態設定。

名稱 類型 預設值 Description
actionAfterReboot

actionAfterReboot

指定套用設定期間在重新開機後的動作。 可能的值為 ContinueConfiguration 和 StopConfiguration

allowModuleOverwrite

boolean

如果為 true - 允許從提取服務下載的新組態覆寫目標節點上的舊組態。 否則為 false

configurationMode

configurationMode

指定 LCM (本機 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

Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。

type

string

資源類型。

GuestConfigurationAssignmentList

清單來賓設定指派作業的回應。

名稱 類型 Description
value

GuestConfigurationAssignment[]

清單來賓設定指派作業的結果。

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

客體組態套件和組態參數的合併哈希。

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

UUID (VM 的通用唯一標識碼) 。

VMSSVMInfo

VMSS VM 的相關信息

名稱 類型 Description
complianceStatus

complianceStatus

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

lastComplianceChecked

string

檢查上次合規性狀態的日期和時間。

latestReportId

string

來賓組態指派的最新報告標識碼。

vmId

string

VM 的 UUID。

vmResourceId

string

VM 的 Azure 資源識別碼。