Udostępnij za pośrednictwem


Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

Tworzy skojarzenie między połączoną maszyną vm Sphere i konfiguracją gościa

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
guestConfigurationAssignmentName
path True

string

Nazwa przypisania konfiguracji gościa.

Wzorzec wyrażenia regularnego: ^[^<>%&:\\?/#]*$

resourceGroupName
path True

string

Nazwa grupy zasobów.

Wzorzec wyrażenia regularnego: ^[-\w\._]+$

subscriptionId
path True

string

Identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

vmName
path True

string

Nazwa maszyny wirtualnej.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$

api-version
query True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa Typ Opis
location

string

Region, w którym znajduje się maszyna wirtualna.

name

string

Nazwa przypisania konfiguracji gościa.

properties

GuestConfigurationAssignmentProperties

Właściwości przypisania konfiguracji gościa.

Odpowiedzi

Nazwa Typ Opis
200 OK

GuestConfigurationAssignment

OK. Przypisanie konfiguracji gościa dla maszyny połączonej maszyny wirtualnej zostało pomyślnie zaktualizowane.

201 Created

GuestConfigurationAssignment

Utworzone. Przypisanie konfiguracji gościa dla maszyny połączonej maszyny wirtualnej zostało pomyślnie utworzone.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create or update guest configuration assignment

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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.0",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

Przykładowa odpowiedź

{
  "location": "westcentralus",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/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.ConnectedVMwarevSphere/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"
  }
}

Definicje

Nazwa Opis
actionAfterReboot

Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration

AssignmentInfo

Informacje o przypisaniu konfiguracji gościa.

AssignmentReport
AssignmentReportResource

Zasób przypisania konfiguracji gościa.

AssignmentReportResourceComplianceReason

Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.

assignmentType

Określa typ przypisania i wykonanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

ConfigurationInfo

Informacje o konfiguracji.

configurationMode

Określa, w jaki sposób LCM(lokalna Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.

ConfigurationParameter

Reprezentuje parametr konfiguracji.

ConfigurationSetting

Ustawienie konfiguracji LCM (Configuration Manager lokalne).

createdByType

Typ tożsamości, która utworzyła zasób.

Error
ErrorResponse

Odpowiedź na błąd operacji

GuestConfigurationAssignment

Przypisanie konfiguracji gościa to skojarzenie między maszyną a konfiguracją gościa.

GuestConfigurationAssignmentProperties

Właściwości przypisania konfiguracji gościa.

GuestConfigurationNavigation

Konfiguracja gościa to artefakt, który hermetyzuje konfigurację DSC i jej zależności. Artefakt jest plikiem zip zawierającym konfigurację DSC (jako MOF) i zasoby zależne oraz inne zależności, takie jak moduły.

kind

Rodzaj konfiguracji gościa. Na przykład:DSC

provisioningState

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

type

Typ raportu, spójności lub początkowego

VMInfo

Informacje o maszynie wirtualnej.

VMSSVMInfo

Informacje o maszynie wirtualnej usługi VMSS

actionAfterReboot

Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration

Nazwa Typ Opis
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Informacje o przypisaniu konfiguracji gościa.

Nazwa Typ Opis
configuration

ConfigurationInfo

Informacje o konfiguracji.

name

string

Nazwa przypisania konfiguracji gościa.

AssignmentReport

Nazwa Typ Opis
assignment

AssignmentInfo

Szczegóły konfiguracji przypisania konfiguracji gościa.

complianceStatus

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

endTime

string

Data i godzina zakończenia sprawdzania stanu zgodności przypisania konfiguracji gościa.

id

string

Identyfikator zasobu usługi ARM raportu dla przypisania konfiguracji gościa.

operationType

type

Typ raportu, spójności lub początkowego

reportId

string

Identyfikator GUID identyfikujący raport przypisania konfiguracji gościa w ramach subskrypcji, grupy zasobów.

resources

AssignmentReportResource[]

Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.

startTime

string

Data i godzina rozpoczęcia sprawdzania stanu zgodności przypisania konfiguracji gościa.

vm

VMInfo

Informacje o maszynie wirtualnej.

AssignmentReportResource

Zasób przypisania konfiguracji gościa.

Nazwa Typ Opis
complianceStatus

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

properties

object

Właściwości zasobu przypisania konfiguracji gościa.

reasons

AssignmentReportResourceComplianceReason[]

Przyczyna zgodności i kod przyczyny zasobu.

resourceId

string

Nazwa ustawienia zasobu przypisania konfiguracji gościa.

AssignmentReportResourceComplianceReason

Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.

Nazwa Typ Opis
code

string

Kod zgodności zasobu przypisania konfiguracji gościa.

phrase

string

Przyczyna zgodności zasobu przypisania konfiguracji gościa.

assignmentType

Określa typ przypisania i wykonanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.

Nazwa Typ Opis
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

Nazwa Typ Opis
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Informacje o konfiguracji.

Nazwa Typ Opis
name

string

Nazwa konfiguracji.

version

string

Wersja konfiguracji.

configurationMode

Określa, w jaki sposób LCM(lokalna Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.

Nazwa Typ Opis
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Reprezentuje parametr konfiguracji.

Nazwa Typ Opis
name

string

Nazwa parametru konfiguracji.

value

string

Wartość parametru konfiguracji.

ConfigurationSetting

Ustawienie konfiguracji LCM (Configuration Manager lokalne).

Nazwa Typ Domyślna wartość Opis
actionAfterReboot

actionAfterReboot

Określa, co się dzieje po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration

allowModuleOverwrite

boolean

Jeśli prawda — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz

configurationMode

configurationMode

Określa, w jaki sposób LCM(lokalna Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

Jak często, w minutach, bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.

rebootIfNeeded

boolean

Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla dowolnej konfiguracji, która jej wymaga. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego rozruchu zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.

refreshFrequencyMins

number

30

Interwał czasu, w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Szczegółowy komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd operacji

Nazwa Typ Opis
error

Error

GuestConfigurationAssignment

Przypisanie konfiguracji gościa to skojarzenie między maszyną a konfiguracją gościa.

Nazwa Typ Opis
id

string

Identyfikator zasobu usługi ARM przypisania konfiguracji gościa.

location

string

Region, w którym znajduje się maszyna wirtualna.

name

string

Nazwa przypisania konfiguracji gościa.

properties

GuestConfigurationAssignmentProperties

Właściwości przypisania konfiguracji gościa.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

type

string

Typ zasobu.

GuestConfigurationAssignmentProperties

Właściwości przypisania konfiguracji gościa.

Nazwa Typ Opis
assignmentHash

string

Połączony skrót pakietu konfiguracji i parametrów.

complianceStatus

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

context

string

Źródło, które zainicjowało przypisanie konfiguracji gościa. Na przykład: Azure Policy

guestConfiguration

GuestConfigurationNavigation

Konfiguracja gościa do przypisania.

lastComplianceStatusChecked

string

Data i godzina sprawdzenia ostatniego stanu zgodności.

latestAssignmentReport

AssignmentReport

Ostatni raport dotyczący przypisania konfiguracji gościa.

latestReportId

string

Identyfikator najnowszego raportu dla przypisania konfiguracji gościa.

parameterHash

string

skrót parametru dla przypisania konfiguracji gościa.

provisioningState

provisioningState

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

resourceType

string

Typ zasobu — VMSS/VM

targetResourceId

string

Identyfikator zasobu maszyny wirtualnej.

vmssVMList

VMSSVMInfo[]

Lista danych zgodności maszyn wirtualnych dla usługi VMSS

GuestConfigurationNavigation

Konfiguracja gościa to artefakt, który hermetyzuje konfigurację DSC i jej zależności. Artefakt jest plikiem zip zawierającym konfigurację DSC (jako MOF) i zasoby zależne oraz inne zależności, takie jak moduły.

Nazwa Typ Opis
assignmentSource

string

Określa pochodzenie konfiguracji.

assignmentType

assignmentType

Określa typ przypisania i wykonanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.

configurationParameter

ConfigurationParameter[]

Parametry konfiguracji dla konfiguracji gościa.

configurationProtectedParameter

ConfigurationParameter[]

Parametry konfiguracji chronionej dla konfiguracji gościa.

configurationSetting

ConfigurationSetting

Ustawienie konfiguracji dla konfiguracji gościa.

contentHash

string

Połączony skrót pakietu konfiguracji gościa i parametrów konfiguracji.

contentType

string

Określa typ zawartości konfiguracji. Możliwe wartości mogą być wbudowane lub niestandardowe.

contentUri

string

Identyfikator URI magazynu, w którym jest przekazywany pakiet konfiguracji gościa.

kind

kind

Rodzaj konfiguracji gościa. Na przykład:DSC

name

string

Nazwa konfiguracji gościa.

version

string

Wersja konfiguracji gościa.

kind

Rodzaj konfiguracji gościa. Na przykład:DSC

Nazwa Typ Opis
DSC

string

provisioningState

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

Nazwa Typ Opis
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

type

Typ raportu, spójności lub początkowego

Nazwa Typ Opis
Consistency

string

Initial

string

VMInfo

Informacje o maszynie wirtualnej.

Nazwa Typ Opis
id

string

Identyfikator zasobu platformy Azure maszyny wirtualnej.

uuid

string

UUID(uniwersalny unikatowy identyfikator) maszyny wirtualnej.

VMSSVMInfo

Informacje o maszynie wirtualnej usługi VMSS

Nazwa Typ Opis
complianceStatus

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

lastComplianceChecked

string

Data i godzina sprawdzenia ostatniego stanu zgodności.

latestReportId

string

Identyfikator najnowszego raportu dla przypisania konfiguracji gościa.

vmId

string

Identyfikator UUID maszyny wirtualnej.

vmResourceId

string

Identyfikator zasobu platformy Azure maszyny wirtualnej.