Guest Configuration Assignments - Create Or Update

Serviço:: Guest Configuration

Versão da API:: 2024-04-05

Cria uma associação entre uma VM e uma configuração de convidado

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
guestConfigurationAssignmentName	path	True	string	O nome da atribuição de configuração de convidado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	O nome da máquina virtual.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O nome da atribuição de configuração de convidado.
location		string	Região em que a VM está localizada.
properties		GuestConfigurationAssignmentProperties	Propriedades da atribuição de configuração de convidado.

Respostas

Nome	Tipo	Description
200 OK	GuestConfigurationAssignment	Operação de atualização do recurso 'GuestConfigurationAssignment' bem-sucedida
201 Created	GuestConfigurationAssignment	Operação de criação do recurso 'GuestConfigurationAssignment' bem-sucedida
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create or update guest configuration assignment

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:: 200

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

Código de status:: 201

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

Definições

Nome	Description
ActionAfterReboot	Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration
AssignmentInfo	Informações sobre a atribuição de configuração de convidado.
AssignmentReport
AssignmentReportResource	O recurso de atribuição de configuração de convidado.
AssignmentReportResourceComplianceReason	Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.
AssignmentType	Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.
ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
ConfigurationInfo	Informações sobre a configuração.
ConfigurationMode	Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.
ConfigurationParameter	Representa um parâmetro de configuração.
ConfigurationSetting	Configuração do LCM (Gerenciador de Configurações Local).
createdByType	O tipo de identidade que criou o recurso.
Error
ErrorResponse	Resposta de erro de uma falha de operação.
GuestConfigurationAssignment	A atribuição de configuração de convidado é uma associação entre uma configuração de computador e convidado.
GuestConfigurationAssignmentProperties	Propriedades de atribuição de configuração de convidado.
GuestConfigurationNavigation	A configuração de convidado é um artefato que encapsula a configuração de DSC e suas dependências. O artefato é um arquivo zip que contém a configuração de DSC (como MOF) e recursos dependentes e outras dependências, como módulos.
Kind	Tipo de configuração de convidado. Por exemplo:DSC
ProvisioningState	O estado de provisionamento, que aparece apenas na resposta.
systemData	Metadados relativos à criação e última modificação do recurso.
Type	Tipo de relatório, consistência ou inicial
VMInfo	Informações sobre a VM.
VMSSVMInfo	Informações sobre a VM VM do VMSS

ActionAfterReboot

Enumeração

Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration

Valor	Description
ContinueConfiguration
StopConfiguration

AssignmentInfo

Objeto

Informações sobre a atribuição de configuração de convidado.

Nome	Tipo	Description
configuration	ConfigurationInfo	Informações sobre a configuração.
name	string	Nome da atribuição de configuração de convidado.

AssignmentReport

Objeto

Nome	Tipo	Description
assignment	AssignmentInfo	Detalhes de configuração da atribuição de configuração de convidado.
complianceStatus	ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
endTime	string (date-time)	Data e hora de término da verificação de status de conformidade da atribuição de configuração de convidado.
id	string	ID de recurso do ARM do relatório para a atribuição de configuração de convidado.
operationType	Type	Tipo de relatório, consistência ou inicial
reportId	string	GUID que identifica o relatório de atribuição de configuração de convidado em uma assinatura, grupo de recursos.
resources	AssignmentReportResource[]	A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada.
startTime	string (date-time)	Data e hora de início da verificação de status de conformidade da atribuição de configuração de convidado.
vm	VMInfo	Informações sobre a VM.

AssignmentReportResource

Objeto

O recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
complianceStatus	ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
properties		Propriedades de um recurso de atribuição de configuração de convidado.
reasons	AssignmentReportResourceComplianceReason[]	Motivo de conformidade e código de motivo para um recurso.
resourceId	string	Nome da configuração de recurso de atribuição de configuração de convidado.

AssignmentReportResourceComplianceReason

Objeto

Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
code	string	Código para a conformidade do recurso de atribuição de configuração de convidado.
phrase	string	Motivo para a conformidade do recurso de atribuição de configuração de convidado.

AssignmentType

Enumeração

Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.

Valor	Description
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

Enumeração

Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.

Valor	Description
Compliant
NonCompliant
Pending

ConfigurationInfo

Objeto

Informações sobre a configuração.

Nome	Tipo	Description
name	string	Nome da configuração.
version	string	Versão da configuração.

ConfigurationMode

Enumeração

Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.

Valor	Description
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Objeto

Representa um parâmetro de configuração.

Nome	Tipo	Description
name	string	Nome do parâmetro de configuração.
value	string	Valor do parâmetro de configuração.

ConfigurationSetting

Objeto

Configuração do LCM (Gerenciador de Configurações Local).

Nome	Tipo	Valor padrão	Description
actionAfterReboot	ActionAfterReboot		Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration
allowModuleOverwrite	boolean		Se true – novas configurações baixadas do serviço de pull têm permissão para substituir as antigas no nó de destino. Caso contrário, false
configurationMode	ConfigurationMode		Especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.
configurationModeFrequencyMins	number (float)	15	Com que frequência, em minutos, a configuração atual é verificada e aplicada. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15.
rebootIfNeeded	boolean		Defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você precisará reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização é promulgada por algo diferente de DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.
refreshFrequencyMins	number (float)	30	O intervalo de tempo, em minutos, em que o LCM verifica um serviço de pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de pull. O valor padrão é 30.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

Error

Objeto

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro de detalhe indicando por que a operação falhou.

ErrorResponse

Objeto

Resposta de erro de uma falha de operação.

Nome	Tipo	Description
error	Error