Compartir a través de


Guest Configuration Connected VM warev Sphere Assignments - Create Or Update

Crea una asociación entre una máquina virtual conectada y una configuración de invitado

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
guestConfigurationAssignmentName
path True

string

Nombre de la asignación de configuración de invitado.

Patrón de Regex: ^[^<>%&:\\?/#]*$

resourceGroupName
path True

string

El nombre del grupo de recursos.

Patrón de Regex: ^[-\w\._]+$

subscriptionId
path True

string

Identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.

vmName
path True

string

El nombre de la máquina virtual.

Patrón de Regex: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$

api-version
query True

string

Versión de api de cliente.

Cuerpo de la solicitud

Nombre Tipo Description
location

string

Región donde se encuentra la máquina virtual.

name

string

Nombre de la asignación de configuración de invitado.

properties

GuestConfigurationAssignmentProperties

Propiedades de la asignación de configuración de invitado.

Respuestas

Nombre Tipo Description
200 OK

GuestConfigurationAssignment

Aceptar. La asignación de configuración de invitado para la máquina de Vm Sphere conectada se actualizó correctamente.

201 Created

GuestConfigurationAssignment

Creado. La asignación de configuración de invitado para la máquina de Vm Sphere conectada se creó correctamente.

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Create or update guest configuration assignment

Solicitud de ejemplo

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"
        }
      ]
    }
  }
}

Respuesta de muestra

{
  "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"
  }
}

Definiciones

Nombre Description
actionAfterReboot

Especifica lo que ocurre tras un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration.

AssignmentInfo

Información sobre la asignación de configuración de invitado.

AssignmentReport
AssignmentReportResource

Recurso de asignación de configuración de invitado.

AssignmentReportResourceComplianceReason

Motivo y código para el cumplimiento del recurso de asignación de configuración de invitado.

assignmentType

Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor.

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

ConfigurationInfo

Información sobre la configuración.

configurationMode

Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.

ConfigurationParameter

Representa un parámetro de configuración.

ConfigurationSetting

Configuración de LCM (Configuration Manager local).

createdByType

Tipo de identidad que creó el recurso.

Error
ErrorResponse

Respuesta de error de un error de operación

GuestConfigurationAssignment

La asignación de configuración de invitado es una asociación entre una máquina y una configuración de invitado.

GuestConfigurationAssignmentProperties

Propiedades de asignación de configuración de invitado.

GuestConfigurationNavigation

La configuración de invitado es un artefacto que encapsula la configuración de DSC y sus dependencias. El artefacto es un archivo ZIP que contiene la configuración de DSC (como MOF) y recursos dependientes y otras dependencias, como módulos.

kind

Tipo de configuración de invitado. Por ejemplo: DSC

provisioningState

El estado de aprovisionamiento, que solo aparece en la respuesta.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

type

Tipo de informe, coherencia o inicial

VMInfo

Información sobre la máquina virtual.

VMSSVMInfo

Información sobre la máquina virtual de VMSS

actionAfterReboot

Especifica lo que ocurre tras un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration.

Nombre Tipo Description
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Información sobre la asignación de configuración de invitado.

Nombre Tipo Description
configuration

ConfigurationInfo

Información sobre la configuración.

name

string

Nombre de la asignación de configuración de invitado.

AssignmentReport

Nombre Tipo Description
assignment

AssignmentInfo

Detalles de configuración de la asignación de configuración de invitado.

complianceStatus

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

endTime

string

Fecha y hora de finalización de la comprobación de estado de cumplimiento de la asignación de configuración de invitado.

id

string

Identificador de recurso de ARM del informe para la asignación de configuración de invitado.

operationType

type

Tipo de informe, coherencia o inicial

reportId

string

GUID que identifica el informe de asignación de configuración de invitado en una suscripción, grupo de recursos.

resources

AssignmentReportResource[]

Lista de recursos para los que se comprueba el cumplimiento de la asignación de configuración de invitado.

startTime

string

Fecha y hora de inicio de la comprobación de estado de cumplimiento de la asignación de configuración de invitado.

vm

VMInfo

Información sobre la máquina virtual.

AssignmentReportResource

Recurso de asignación de configuración de invitado.

Nombre Tipo Description
complianceStatus

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

properties

object

Propiedades de un recurso de asignación de configuración de invitado.

reasons

AssignmentReportResourceComplianceReason[]

Motivo de cumplimiento y código de motivo para un recurso.

resourceId

string

Nombre de la configuración del recurso de asignación de configuración de invitado.

AssignmentReportResourceComplianceReason

Motivo y código para el cumplimiento del recurso de asignación de configuración de invitado.

Nombre Tipo Description
code

string

Código para el cumplimiento del recurso de asignación de configuración de invitado.

phrase

string

Motivo del cumplimiento del recurso de asignación de configuración de invitado.

assignmentType

Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor.

Nombre Tipo Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

Nombre Tipo Description
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Información sobre la configuración.

Nombre Tipo Description
name

string

Nombre de la configuración.

version

string

Versión de la configuración.

configurationMode

Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.

Nombre Tipo Description
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Representa un parámetro de configuración.

Nombre Tipo Description
name

string

Nombre del parámetro de configuración.

value

string

Valor del parámetro de configuración.

ConfigurationSetting

Configuración de LCM (Configuration Manager local).

Nombre Tipo Valor predeterminado Description
actionAfterReboot

actionAfterReboot

Especifica lo que ocurre tras un reinicio durante la aplicación de una configuración. Los valores posibles son ContinueConfiguration y StopConfiguration

allowModuleOverwrite

boolean

Si es true: las nuevas configuraciones descargadas desde el servicio de extracción pueden sobrescribir las antiguas en el nodo de destino. De lo contrario, false

configurationMode

configurationMode

Especifica cómo LCM(Local Configuration Manager) aplica realmente la configuración a los nodos de destino. Los valores posibles son ApplyOnly, ApplyAndMonitor y ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

La frecuencia, en minutos, con que se comprueba y aplica la configuración actual. Esta propiedad se omite si la propiedad ConfigurationMode se establece en ApplyOnly. El valor predeterminado es 15.

rebootIfNeeded

boolean

Establézcalo en true para reiniciar automáticamente el nodo después de aplicar una configuración que requiera reiniciar. De lo contrario, tendrá que reiniciar manualmente el nodo de configuración que lo requiera. El valor predeterminado es false. Para usar esta configuración cuando una instancia distinta de DSC (como Windows Installer) implementa una condición de reinicio, combine la configuración con el módulo xPendingReboot.

refreshFrequencyMins

number

30

El intervalo de tiempo, en minutos, que emplea el LCM para comprobar un servicio de extracción en busca de configuraciones actualizadas. Este valor se omite si el LCM no está configurado en el modo de extracción. El valor predeterminado es 30.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Nombre Tipo Description
code

string

Código de error.

message

string

Mensaje de error detallado que indica por qué se produjo un error en la operación.

ErrorResponse

Respuesta de error de un error de operación

Nombre Tipo Description
error

Error

GuestConfigurationAssignment

La asignación de configuración de invitado es una asociación entre una máquina y una configuración de invitado.

Nombre Tipo Description
id

string

Identificador de recurso de ARM de la asignación de configuración de invitado.

location

string

Región donde se encuentra la máquina virtual.

name

string

Nombre de la asignación de configuración de invitado.

properties

GuestConfigurationAssignmentProperties

Propiedades de la asignación de configuración de invitado.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.

type

string

Tipo de recurso.

GuestConfigurationAssignmentProperties

Propiedades de asignación de configuración de invitado.

Nombre Tipo Description
assignmentHash

string

Hash combinado del paquete de configuración y los parámetros.

complianceStatus

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

context

string

Origen que inició la asignación de configuración de invitado. Por ejemplo: Azure Policy

guestConfiguration

GuestConfigurationNavigation

Configuración de invitado que se va a asignar.

lastComplianceStatusChecked

string

Fecha y hora en que se comprobó el último estado de cumplimiento.

latestAssignmentReport

AssignmentReport

Informe de asignación de configuración de invitado notificado por última vez.

latestReportId

string

Identificador del informe más reciente para la asignación de configuración de invitado.

parameterHash

string

hash de parámetros para la asignación de configuración de invitado.

provisioningState

provisioningState

El estado de aprovisionamiento, que solo aparece en la respuesta.

resourceType

string

Tipo del recurso: VMSS/VM

targetResourceId

string

Identificador de recurso de máquina virtual.

vmssVMList

VMSSVMInfo[]

Lista de datos de cumplimiento de máquinas virtuales para VMSS

GuestConfigurationNavigation

La configuración de invitado es un artefacto que encapsula la configuración de DSC y sus dependencias. El artefacto es un archivo ZIP que contiene la configuración de DSC (como MOF) y recursos dependientes y otras dependencias, como módulos.

Nombre Tipo Description
assignmentSource

string

Especifica el origen de la configuración.

assignmentType

assignmentType

Especifica el tipo de asignación y la ejecución de la configuración. Los valores posibles son Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect y ApplyAndMonitor.

configurationParameter

ConfigurationParameter[]

Parámetros de configuración para la configuración de invitado.

configurationProtectedParameter

ConfigurationParameter[]

Parámetros de configuración protegidos para la configuración de invitado.

configurationSetting

ConfigurationSetting

El valor de configuración de la configuración de invitado.

contentHash

string

Hash combinado del paquete de configuración de invitado y los parámetros de configuración.

contentType

string

Especifica el tipo de contenido de la configuración. Los valores posibles podrían ser Builtin o Custom.

contentUri

string

URI del almacenamiento donde se carga el paquete de configuración de invitado.

kind

kind

Tipo de configuración de invitado. Por ejemplo: DSC

name

string

Nombre de la configuración de invitado.

version

string

Versión de la configuración de invitado.

kind

Tipo de configuración de invitado. Por ejemplo: DSC

Nombre Tipo Description
DSC

string

provisioningState

El estado de aprovisionamiento, que solo aparece en la respuesta.

Nombre Tipo Description
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

type

Tipo de informe, coherencia o inicial

Nombre Tipo Description
Consistency

string

Initial

string

VMInfo

Información sobre la máquina virtual.

Nombre Tipo Description
id

string

Identificador de recurso de Azure de la máquina virtual.

uuid

string

UUID(Identificador único universal) de la máquina virtual.

VMSSVMInfo

Información sobre la máquina virtual de VMSS

Nombre Tipo Description
complianceStatus

complianceStatus

Valor que indica el estado de cumplimiento de la máquina para la configuración de invitado asignada.

lastComplianceChecked

string

Fecha y hora en que se comprobó el último estado de cumplimiento.

latestReportId

string

Identificador del informe más reciente para la asignación de configuración de invitado.

vmId

string

UUID de la máquina virtual.

vmResourceId

string

Identificador de recurso de Azure de la máquina virtual.