Guest Configuration Assignments - Get
ゲスト構成の割り当てに関する情報を取得する
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2022-01-25
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
guest
|
path | True |
string |
ゲスト構成の割り当て名。 |
resource
|
path | True |
string |
リソース グループ名。 Regex pattern: |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
vm
|
path | True |
string |
仮想マシンの名前。 Regex pattern: |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 ゲスト構成の割り当てが正常に返されました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Get a guest configuration assignment
Sample Request
GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/SecureProtocol?api-version=2022-01-25
Sample Response
{
"location": "centraluseuap",
"id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol",
"name": "AuditSecureProtocol",
"properties": {
"complianceStatus": "Compliant",
"assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
"latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
"lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
"context": null,
"guestConfiguration": {
"kind": null,
"name": "AuditSecureProtocol",
"version": "1.0.0.3",
"contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip",
"contentHash": "content hash",
"configurationParameter": [],
"configurationSetting": null
},
"provisioningState": "Succeeded"
}
}
定義
名前 | 説明 |
---|---|
action |
構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。 |
Assignment |
ゲスト構成の割り当てに関する情報。 |
Assignment |
|
Assignment |
ゲスト構成の割り当てリソース。 |
Assignment |
ゲスト構成割り当てリソースのコンプライアンスに関する理由とコード。 |
assignment |
構成の割り当ての種類と実行を指定します。 使用できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。 |
compliance |
割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。 |
Configuration |
構成に関する情報。 |
configuration |
LCM(ローカル Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 |
Configuration |
構成パラメーターを表します。 |
Configuration |
LCM の構成設定 (ローカル Configuration Manager)。 |
created |
リソースを作成した ID の種類。 |
Error | |
Error |
操作エラーのエラー応答 |
Guest |
ゲスト構成の割り当ては、マシンとゲスト構成の間の関連付けです。 |
Guest |
ゲスト構成の割り当てプロパティ。 |
Guest |
ゲスト構成は、DSC 構成とその依存関係をカプセル化する成果物です。 成果物は、DSC 構成 (MOF として) と依存リソース、およびモジュールなどのその他の依存関係を含む zip ファイルです。 |
kind |
ゲスト構成の種類。 例: DSC |
provisioning |
プロビジョニング状態。これは応答にのみ表示されます。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
type |
レポートの種類、整合性、または初期 |
VMInfo |
VM に関する情報。 |
VMSSVMInfo |
VMSS VM に関する情報 |
actionAfterReboot
構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。
名前 | 型 | 説明 |
---|---|---|
ContinueConfiguration |
string |
|
StopConfiguration |
string |
AssignmentInfo
ゲスト構成の割り当てに関する情報。
名前 | 型 | 説明 |
---|---|---|
configuration |
構成に関する情報。 |
|
name |
string |
ゲスト構成の割り当ての名前。 |
AssignmentReport
名前 | 型 | 説明 |
---|---|---|
assignment |
ゲスト構成割り当ての構成の詳細。 |
|
complianceStatus |
割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。 |
|
endTime |
string |
ゲスト構成の割り当てコンプライアンス状態チェックの終了日時。 |
id |
string |
ゲスト構成割り当てのレポートの ARM リソース ID。 |
operationType |
レポートの種類、整合性、または初期 |
|
reportId |
string |
サブスクリプションのリソース グループでゲスト構成割り当てレポートを識別する GUID。 |
resources |
ゲスト構成の割り当てコンプライアンスがチェックされるリソースの一覧。 |
|
startTime |
string |
ゲスト構成の割り当てコンプライアンス状態チェックの開始日時。 |
vm |
VM に関する情報。 |
AssignmentReportResource
ゲスト構成の割り当てリソース。
名前 | 型 | 説明 |
---|---|---|
complianceStatus |
割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。 |
|
properties |
object |
ゲスト構成割り当てリソースのプロパティ。 |
reasons |
リソースのコンプライアンス理由と理由コード。 |
|
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(ローカル Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。
名前 | 型 | 説明 |
---|---|---|
ApplyAndAutoCorrect |
string |
|
ApplyAndMonitor |
string |
|
ApplyOnly |
string |
ConfigurationParameter
構成パラメーターを表します。
名前 | 型 | 説明 |
---|---|---|
name |
string |
構成パラメーターの名前。 |
value |
string |
構成パラメーターの値。 |
ConfigurationSetting
LCM の構成設定 (ローカル Configuration Manager)。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
actionAfterReboot |
構成の適用中の再起動後の動作を指定します。 指定できる値は ContinueConfiguration と StopConfiguration です。 |
||
allowModuleOverwrite |
boolean |
true の場合、 プル サービスからダウンロードされた新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合は false |
|
configurationMode |
LCM(ローカル Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、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 |
GuestConfigurationAssignment
ゲスト構成の割り当ては、マシンとゲスト構成の間の関連付けです。
名前 | 型 | 説明 |
---|---|---|
id |
string |
ゲスト構成割り当ての ARM リソース ID。 |
location |
string |
VM が配置されているリージョン。 |
name |
string |
ゲスト構成の割り当ての名前。 |
properties |
ゲスト構成割り当てのプロパティ。 |
|
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
type |
string |
リソースの型。 |
GuestConfigurationAssignmentProperties
ゲスト構成の割り当てプロパティ。
名前 | 型 | 説明 |
---|---|---|
assignmentHash |
string |
構成パッケージとパラメーターの結合ハッシュ。 |
complianceStatus |
割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。 |
|
context |
string |
ゲスト構成の割り当てを開始したソース。 例: Azure Policy |
guestConfiguration |
割り当てるゲスト構成。 |
|
lastComplianceStatusChecked |
string |
最後のコンプライアンス状態が確認された日時。 |
latestAssignmentReport |
最後に報告されたゲスト構成の割り当てレポート。 |
|
latestReportId |
string |
ゲスト構成割り当ての最新のレポートの ID。 |
parameterHash |
string |
ゲスト構成割り当てのパラメーター ハッシュ。 |
provisioningState |
プロビジョニング状態。これは応答にのみ表示されます。 |
|
resourceType |
string |
リソースの種類 - VMSS/VM |
targetResourceId |
string |
VM リソース ID。 |
vmssVMList |
VMSS の VM コンプライアンス データの一覧 |
GuestConfigurationNavigation
ゲスト構成は、DSC 構成とその依存関係をカプセル化する成果物です。 成果物は、DSC 構成 (MOF として) と依存リソース、およびモジュールなどのその他の依存関係を含む zip ファイルです。
名前 | 型 | 説明 |
---|---|---|
assignmentSource |
string |
構成の配信元を指定します。 |
assignmentType |
構成の割り当ての種類と実行を指定します。 使用できる値は、Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect、ApplyAndMonitor です。 |
|
configurationParameter |
ゲスト構成の構成パラメーター。 |
|
configurationProtectedParameter |
ゲスト構成の保護された構成パラメーター。 |
|
configurationSetting |
ゲスト構成の構成設定。 |
|
contentHash |
string |
ゲスト構成パッケージと構成パラメーターの結合ハッシュ。 |
contentType |
string |
構成のコンテンツ タイプを指定します。 指定できる値は Builtin または Custom です。 |
contentUri |
string |
ゲスト構成パッケージがアップロードされるストレージの URI。 |
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 |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
type
レポートの種類、整合性、または初期
名前 | 型 | 説明 |
---|---|---|
Consistency |
string |
|
Initial |
string |
VMInfo
VM に関する情報。
名前 | 型 | 説明 |
---|---|---|
id |
string |
VM の Azure リソース ID。 |
uuid |
string |
VM の UUID (ユニバーサル一意識別子)。 |
VMSSVMInfo
VMSS VM に関する情報
名前 | 型 | 説明 |
---|---|---|
complianceStatus |
割り当てられたゲスト構成のマシンのコンプライアンス状態を示す値。 |
|
lastComplianceChecked |
string |
最後のコンプライアンス状態が確認された日時。 |
latestReportId |
string |
ゲスト構成割り当ての最新のレポートの ID。 |
vmId |
string |
VM の UUID。 |
vmResourceId |
string |
VM の Azure リソース ID。 |