Aracılığıyla paylaş


Guest Configuration Assignments - Create Or Update

VM ile konuk yapılandırması arasında ilişki oluşturur

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

URI Parametreleri

Name İçinde Gerekli Tür Description
guestConfigurationAssignmentName
path True

string

Konuk yapılandırma atamasının adı.

resourceGroupName
path True

string

Kaynak grubu adı.

Regex pattern: ^[-\w\._]+$

subscriptionId
path True

string

Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimliği. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.

vmName
path True

string

Sanal makinenin adı.

Regex pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$

api-version
query True

string

İstemci Api Sürümü.

İstek Gövdesi

Name Tür Description
location

string

VM'nin bulunduğu bölge.

name

string

Konuk yapılandırma atamasının adı.

properties

GuestConfigurationAssignmentProperties

Konuk yapılandırma atamasının özellikleri.

Yanıtlar

Name Tür Description
200 OK

GuestConfigurationAssignment

Tamam ögesini seçin. VM için konuk yapılandırma ataması başarıyla güncelleştirildi.

201 Created

GuestConfigurationAssignment

Oluşturulan. VM için konuk yapılandırma ataması başarıyla oluşturuldu.

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create or update guest configuration assignment

Sample Request

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

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

Sample Response

{
  "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,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}
{
  "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,
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Tanımlar

Name Description
actionAfterReboot

Yapılandırmanın uygulanması sırasında yeniden başlatmadan sonra ne olacağını belirtir. Olası değerler ContinueConfiguration ve StopConfiguration'dır

AssignmentInfo

Konuk yapılandırma ataması hakkında bilgi.

AssignmentReport
AssignmentReportResource

Konuk yapılandırma atama kaynağı.

AssignmentReportResourceComplianceReason

Konuk yapılandırma atama kaynağının uyumluluğu için neden ve kod.

assignmentType

Yapılandırmanın atama türünü ve yürütülmesini belirtir. Olası değerler Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect ve ApplyAndMonitor'dır.

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

ConfigurationInfo

Yapılandırma hakkında bilgi.

configurationMode

LCM'nin (Yerel Configuration Manager) yapılandırmayı hedef düğümlere nasıl uygulaydığını belirtir. Olası değerler ApplyOnly, ApplyAndMonitor ve ApplyAndAutoCorrect değerleridir.

ConfigurationParameter

Yapılandırma parametresini temsil eder.

ConfigurationSetting

LCM'nin yapılandırma ayarı (Yerel Configuration Manager).

createdByType

Kaynağı oluşturan kimliğin türü.

Error
ErrorResponse

İşlem hatasının hata yanıtı

GuestConfigurationAssignment

Konuk yapılandırma ataması, makine ve konuk yapılandırması arasındaki ilişkidir.

GuestConfigurationAssignmentProperties

Konuk yapılandırma atama özellikleri.

GuestConfigurationNavigation

Konuk yapılandırması, DSC yapılandırmasını ve bağımlılıklarını kapsülleyen bir yapıttır. Yapıt, DSC yapılandırmasını (MOF olarak) ve bağımlı kaynakları ve modüller gibi diğer bağımlılıkları içeren bir zip dosyasıdır.

kind

Konuk yapılandırmasının türü. Örneğin:DSC

provisioningState

Yalnızca yanıtta görünen sağlama durumu.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

type

Rapor türü, Tutarlılık veya başlangıç

VMInfo

VM hakkında bilgi.

VMSSVMInfo

VMSS VM hakkında bilgi

actionAfterReboot

Yapılandırmanın uygulanması sırasında yeniden başlatmadan sonra ne olacağını belirtir. Olası değerler ContinueConfiguration ve StopConfiguration'dır

Name Tür Description
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Konuk yapılandırma ataması hakkında bilgi.

Name Tür Description
configuration

ConfigurationInfo

Yapılandırma hakkında bilgi.

name

string

Konuk yapılandırma atamasının adı.

AssignmentReport

Name Tür Description
assignment

AssignmentInfo

Konuk yapılandırma atamasının yapılandırma ayrıntıları.

complianceStatus

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

endTime

string

Konuk yapılandırması ataması uyumluluk durumu denetiminin bitiş tarihi ve saati.

id

string

Konuk yapılandırma ataması için raporun ARM kaynak kimliği.

operationType

type

Rapor türü, Tutarlılık veya başlangıç

reportId

string

Bir abonelik, kaynak grubu altında konuk yapılandırma atama raporunu tanımlayan GUID.

resources

AssignmentReportResource[]

Konuk yapılandırma ataması uyumluluğunun denetlendiği kaynakların listesi.

startTime

string

Konuk yapılandırma ataması uyumluluk durumu denetiminin başlangıç tarihi ve saati.

vm

VMInfo

VM hakkında bilgi.

AssignmentReportResource

Konuk yapılandırma atama kaynağı.

Name Tür Description
complianceStatus

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

properties

object

Konuk yapılandırma atama kaynağının özellikleri.

reasons

AssignmentReportResourceComplianceReason[]

Bir kaynağın uyumluluk nedeni ve neden kodu.

resourceId

string

Konuk yapılandırma ataması kaynak ayarının adı.

AssignmentReportResourceComplianceReason

Konuk yapılandırma atama kaynağının uyumluluğu için neden ve kod.

Name Tür Description
code

string

Konuk yapılandırma atama kaynağının uyumluluğu için kod.

phrase

string

Konuk yapılandırma atama kaynağının uyumluluğunun nedeni.

assignmentType

Yapılandırmanın atama türünü ve yürütülmesini belirtir. Olası değerler Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect ve ApplyAndMonitor'dır.

Name Tür Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

Name Tür Description
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Yapılandırma hakkında bilgi.

Name Tür Description
name

string

Yapılandırmanın adı.

version

string

Yapılandırmanın sürümü.

configurationMode

LCM'nin (Yerel Configuration Manager) yapılandırmayı hedef düğümlere nasıl uygulaydığını belirtir. Olası değerler ApplyOnly, ApplyAndMonitor ve ApplyAndAutoCorrect değerleridir.

Name Tür Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Yapılandırma parametresini temsil eder.

Name Tür Description
name

string

Yapılandırma parametresinin adı.

value

string

Yapılandırma parametresinin değeri.

ConfigurationSetting

LCM'nin yapılandırma ayarı (Yerel Configuration Manager).

Name Tür Varsayılan değer Description
actionAfterReboot

actionAfterReboot

Yapılandırmanın uygulanması sırasında yeniden başlatma sonrasında ne olacağını belirtir. Olası değerler ContinueConfiguration ve StopConfiguration'dır

allowModuleOverwrite

boolean

True ise - çekme hizmetinden indirilen yeni yapılandırmaların hedef düğümdeki eski yapılandırmaların üzerine yazmasına izin verilir. Aksi takdirde false

configurationMode

configurationMode

LCM'nin (Yerel Configuration Manager) yapılandırmayı hedef düğümlere nasıl uygulaydığını belirtir. Olası değerler: ApplyOnly, ApplyAndMonitor ve ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

Geçerli yapılandırmanın ne sıklıkta (dakika cinsinden) denetlenip uygulandığı. ConfigurationMode özelliği ApplyOnly olarak ayarlanırsa bu özellik yoksayılır. Varsayılan değer 15'tir.

rebootIfNeeded

boolean

Yeniden başlatma gerektiren bir yapılandırma uygulandıktan sonra düğümü otomatik olarak yeniden başlatmak için bunu true olarak ayarlayın. Aksi takdirde, düğümü gerektiren tüm yapılandırmalar için el ile yeniden başlatmanız gerekir. Varsayılan değer false'tur. Yeniden başlatma koşulu DSC (Windows Installer gibi) dışında bir şey tarafından uygulandığında bu ayarı kullanmak için bu ayarı xPendingReboot modülüyle birleştirin.

refreshFrequencyMins

number

30

LCM'nin güncelleştirilmiş yapılandırmaları almak için çekme hizmetini denetlediği dakika cinsinden zaman aralığı. LCM çekme modunda yapılandırılmamışsa bu değer yoksayılır. Varsayılan değer 30’dur.

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Name Tür Description
code

string

Hata kodu.

message

string

İşlemin neden başarısız olduğunu belirten ayrıntılı hata iletisi.

ErrorResponse

İşlem hatasının hata yanıtı

Name Tür Description
error

Error

GuestConfigurationAssignment

Konuk yapılandırma ataması, makine ve konuk yapılandırması arasındaki ilişkidir.

Name Tür Description
id

string

Konuk yapılandırma atamasının ARM kaynak kimliği.

location

string

VM'nin bulunduğu bölge.

name

string

Konuk yapılandırma atamasının adı.

properties

GuestConfigurationAssignmentProperties

Konuk yapılandırma atamasının özellikleri.

systemData

systemData

Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.

type

string

Kaynağın türü.

GuestConfigurationAssignmentProperties

Konuk yapılandırma atama özellikleri.

Name Tür Description
assignmentHash

string

Yapılandırma paketinin ve parametrelerin birleşik karması.

complianceStatus

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

context

string

Konuk yapılandırma atamasını başlatan kaynak. Örn: Azure İlkesi

guestConfiguration

GuestConfigurationNavigation

Atanacak konuk yapılandırması.

lastComplianceStatusChecked

string

Son uyumluluk durumunun denetlenildiği tarih ve saat.

latestAssignmentReport

AssignmentReport

Son bildirilen konuk yapılandırma atama raporu.

latestReportId

string

Konuk yapılandırma ataması için en son raporun kimliği.

parameterHash

string

konuk yapılandırma ataması için parametre karması.

provisioningState

provisioningState

Yalnızca yanıtta görünen sağlama durumu.

resourceType

string

Kaynağın türü - VMSS / VM

targetResourceId

string

VM kaynak kimliği.

vmssVMList

VMSSVMInfo[]

VMSS için VM Uyumluluk verilerinin listesi

GuestConfigurationNavigation

Konuk yapılandırması, DSC yapılandırmasını ve bağımlılıklarını kapsülleyen bir yapıttır. Yapıt, DSC yapılandırmasını (MOF olarak) ve bağımlı kaynakları ve modüller gibi diğer bağımlılıkları içeren bir zip dosyasıdır.

Name Tür Description
assignmentSource

string

Yapılandırmanın kaynağını belirtir.

assignmentType

assignmentType

Yapılandırmanın atama türünü ve yürütülmesini belirtir. Olası değerler Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect ve ApplyAndMonitor'dır.

configurationParameter

ConfigurationParameter[]

Konuk yapılandırması için yapılandırma parametreleri.

configurationProtectedParameter

ConfigurationParameter[]

Konuk yapılandırması için korumalı yapılandırma parametreleri.

configurationSetting

ConfigurationSetting

Konuk yapılandırması için yapılandırma ayarı.

contentHash

string

Konuk yapılandırma paketinin ve yapılandırma parametrelerinin birleşik karması.

contentType

string

Yapılandırmanın içerik türünü belirtir. Olası değerler Yerleşik veya Özel olabilir.

contentUri

string

Konuk yapılandırma paketinin karşıya yüklendiği depolama alanının Uri'si.

kind

kind

Konuk yapılandırmasının türü. Örneğin:DSC

name

string

Konuk yapılandırmasının adı.

version

string

Konuk yapılandırmasının sürümü.

kind

Konuk yapılandırmasının türü. Örneğin:DSC

Name Tür Description
DSC

string

provisioningState

Yalnızca yanıtta görünen sağlama durumu.

Name Tür Description
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

type

Rapor türü, Tutarlılık veya başlangıç

Name Tür Description
Consistency

string

Initial

string

VMInfo

VM hakkında bilgi.

Name Tür Description
id

string

VM'nin Azure kaynak kimliği.

uuid

string

VM'nin UUID(Evrensel Benzersiz Tanımlayıcısı).

VMSSVMInfo

VMSS VM hakkında bilgi

Name Tür Description
complianceStatus

complianceStatus

Atanan konuk yapılandırması için makinenin uyumluluk durumunu gösteren değer.

lastComplianceChecked

string

Son uyumluluk durumunun denetlenildiği tarih ve saat.

latestReportId

string

Konuk yapılandırma ataması için en son raporun kimliği.

vmId

string

VM'nin UUID değeri.

vmResourceId

string

VM'nin Azure kaynak kimliği.