Guest Configuration Assignments - Create Or Update
Cria uma associação entre uma configuração de VM e de convidado
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2022-01-25
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
guest
|
path | True |
string |
Nome da atribuição de configuração de convidado. |
resource
|
path | True |
string |
O nome do grupo de recursos. Regex pattern: |
subscription
|
path | True |
string |
ID da subscrição que identifica exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
vm
|
path | True |
string |
O nome da máquina virtual. Regex pattern: |
api-version
|
query | True |
string |
Versão da API do Cliente. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
location |
string |
Região onde a VM está localizada. |
name |
string |
Nome da atribuição de configuração de convidado. |
properties |
Propriedades da atribuição de configuração de Convidado. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK. A atribuição de configuração de convidado para a VM foi atualizada com êxito. |
|
201 Created |
Criado. A atribuição de configuração de convidado para a VM foi criada com êxito. |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
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"
}
}
Definições
Name | Description |
---|---|
action |
Especifica o que acontece após um reinício durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration |
Assignment |
Informações sobre a atribuição de configuração de convidados. |
Assignment |
|
Assignment |
O recurso de atribuição de configuração de convidado. |
Assignment |
Motivo e código para a conformidade do recurso de atribuição de configuração de convidado. |
assignment |
Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. |
compliance |
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída. |
Configuration |
Informações sobre a configuração. |
configuration |
Especifica como o LCM (local Configuration Manager) aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. |
Configuration |
Representa um parâmetro de configuração. |
Configuration |
Definição de configuração do LCM (local Configuration Manager). |
created |
O tipo de identidade que criou o recurso. |
Error | |
Error |
Resposta de erro de uma falha de operação |
Guest |
A atribuição de configuração de convidados é uma associação entre uma configuração de computador e convidado. |
Guest |
Propriedades de atribuição de configuração de convidados. |
Guest |
A configuração de convidados é um artefacto que encapsula a configuração do DSC e as respetivas dependências. O artefacto é um ficheiro zip que contém a configuração do DSC (como MOF) e recursos dependentes e outras dependências, como módulos. |
kind |
Tipo de configuração de convidado. Por exemplo: DSC |
provisioning |
O estado de aprovisionamento, que só aparece na resposta. |
system |
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 do VMSS |
actionAfterReboot
Especifica o que acontece após um reinício durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration
Name | Tipo | Description |
---|---|---|
ContinueConfiguration |
string |
|
StopConfiguration |
string |
AssignmentInfo
Informações sobre a atribuição de configuração de convidados.
Name | Tipo | Description |
---|---|---|
configuration |
Informações sobre a configuração. |
|
name |
string |
Nome da atribuição de configuração de convidado. |
AssignmentReport
Name | Tipo | Description |
---|---|---|
assignment |
Detalhes de configuração da atribuição de configuração de convidado. |
|
complianceStatus |
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída. |
|
endTime |
string |
Data e hora de fim da verificação do estado 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 |
Tipo de relatório, Consistência ou Inicial |
|
reportId |
string |
GUID que identifica o relatório de atribuição de configuração de convidado numa subscrição, grupo de recursos. |
resources |
A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada. |
|
startTime |
string |
Data e hora de início da verificação do estado de conformidade da atribuição de configuração de convidado. |
vm |
Informações sobre a VM. |
AssignmentReportResource
O recurso de atribuição de configuração de convidado.
Name | Tipo | Description |
---|---|---|
complianceStatus |
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída. |
|
properties |
object |
Propriedades de um recurso de atribuição de configuração de convidado. |
reasons |
Motivo de conformidade e código do motivo de um recurso. |
|
resourceId |
string |
Nome da definição do 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.
Name | 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
Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.
Name | Tipo | Description |
---|---|---|
ApplyAndAutoCorrect |
string |
|
ApplyAndMonitor |
string |
|
Audit |
string |
|
DeployAndAutoCorrect |
string |
complianceStatus
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída.
Name | Tipo | Description |
---|---|---|
Compliant |
string |
|
NonCompliant |
string |
|
Pending |
string |
ConfigurationInfo
Informações sobre a configuração.
Name | Tipo | Description |
---|---|---|
name |
string |
Nome da configuração. |
version |
string |
Versão da configuração. |
configurationMode
Especifica como o LCM (local Configuration Manager) aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect.
Name | Tipo | Description |
---|---|---|
ApplyAndAutoCorrect |
string |
|
ApplyAndMonitor |
string |
|
ApplyOnly |
string |
ConfigurationParameter
Representa um parâmetro de configuração.
Name | Tipo | Description |
---|---|---|
name |
string |
Nome do parâmetro de configuração. |
value |
string |
Valor do parâmetro de configuração. |
ConfigurationSetting
Definição de configuração do LCM (local Configuration Manager).
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
actionAfterReboot |
Especifica o que acontece após um reinício durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration |
||
allowModuleOverwrite |
boolean |
Se for verdadeiro – as novas configurações transferidas a partir do serviço Pull podem substituir as antigas no nó de destino. Caso contrário, falso |
|
configurationMode |
Especifica como o LCM (local Configuration Manager) aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. |
||
configurationModeFrequencyMins |
number |
15 |
Com que frequência, em minutos, a configuração atual é verificada e aplicada. Esta propriedade é ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor predefinido é 15. |
rebootIfNeeded |
boolean |
Defina como verdadeiro para reiniciar automaticamente o nó depois de ser aplicada uma configuração que exija o reinício. Caso contrário, terá de reiniciar manualmente o nó para qualquer configuração que o exija. O valor predefinido é false. Para utilizar esta definição quando uma condição de reinício é decretada por algo diferente do DSC (como o Windows Installer), combine esta definição com o módulo xPendingReboot. |
|
refreshFrequencyMins |
number |
30 |
O intervalo de tempo, em minutos, em que o LCM verifica um serviço Pull para obter configurações atualizadas. Este valor é ignorado se o LCM não estiver configurado no modo pull. O valor predefinido é 30. |
createdByType
O tipo de identidade que criou o recurso.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Error
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
message |
string |
Mensagem de erro detalhada que indica o motivo pela qual a operação falhou. |
ErrorResponse
Resposta de erro de uma falha de operação
Name | Tipo | Description |
---|---|---|
error |
GuestConfigurationAssignment
A atribuição de configuração de convidados é uma associação entre uma configuração de computador e convidado.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso do ARM da atribuição de configuração de convidado. |
location |
string |
Região onde a VM está localizada. |
name |
string |
Nome da atribuição de configuração de convidado. |
properties |
Propriedades da atribuição de configuração de Convidado. |
|
systemData |
O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy. |
|
type |
string |
O tipo de recurso. |
GuestConfigurationAssignmentProperties
Propriedades de atribuição de configuração de convidados.
Name | Tipo | Description |
---|---|---|
assignmentHash |
string |
Hash combinado do pacote de configuração e parâmetros. |
complianceStatus |
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída. |
|
context |
string |
A origem que iniciou a atribuição de configuração de convidado. Ex: Azure Policy |
guestConfiguration |
A configuração de convidado a atribuir. |
|
lastComplianceStatusChecked |
string |
Data e hora em que o estado de conformidade foi verificado. |
latestAssignmentReport |
Último relatório de atribuição de configuração de convidado comunicado. |
|
latestReportId |
string |
ID do relatório mais recente da atribuição de configuração de convidado. |
parameterHash |
string |
hash de parâmetros para a atribuição de configuração de convidado. |
provisioningState |
O estado de aprovisionamento, que só aparece na resposta. |
|
resourceType |
string |
Tipo do recurso – VMSS/VM |
targetResourceId |
string |
ID do recurso da VM. |
vmssVMList |
A lista de dados de Conformidade da VM para VMSS |
GuestConfigurationNavigation
A configuração de convidados é um artefacto que encapsula a configuração do DSC e as respetivas dependências. O artefacto é um ficheiro zip que contém a configuração do DSC (como MOF) e recursos dependentes e outras dependências, como módulos.
Name | Tipo | Description |
---|---|---|
assignmentSource |
string |
Especifica a origem da configuração. |
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. |
|
configurationParameter |
Os parâmetros de configuração da configuração de convidado. |
|
configurationProtectedParameter |
Os parâmetros de configuração protegidos para a configuração de convidado. |
|
configurationSetting |
A definição de configuração para a configuração de convidado. |
|
contentHash |
string |
Hash combinado do pacote de configuração do convidado e parâmetros de configuração. |
contentType |
string |
Especifica o tipo de conteúdo da configuração. Os valores possíveis podem ser Incorporados ou Personalizados. |
contentUri |
string |
Uri do armazenamento onde o pacote de configuração de convidado é carregado. |
kind |
Tipo de configuração de convidado. Por exemplo: DSC |
|
name |
string |
Nome da configuração de convidado. |
version |
string |
Versão da configuração de convidado. |
kind
Tipo de configuração de convidado. Por exemplo: DSC
Name | Tipo | Description |
---|---|---|
DSC |
string |
provisioningState
O estado de aprovisionamento, que só aparece na resposta.
Name | Tipo | Description |
---|---|---|
Canceled |
string |
|
Created |
string |
|
Failed |
string |
|
Succeeded |
string |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
type
Tipo de relatório, Consistência ou Inicial
Name | Tipo | Description |
---|---|---|
Consistency |
string |
|
Initial |
string |
VMInfo
Informações sobre a VM.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso do Azure da VM. |
uuid |
string |
UUID (Identificador Universalmente Exclusivo) da VM. |
VMSSVMInfo
Informações sobre a VM do VMSS
Name | Tipo | Description |
---|---|---|
complianceStatus |
Um valor que indica o estado de conformidade do computador para a configuração de convidado atribuída. |
|
lastComplianceChecked |
string |
Data e hora em que o estado de conformidade foi verificado. |
latestReportId |
string |
ID do relatório mais recente da atribuição de configuração de convidado. |
vmId |
string |
UUID da VM. |
vmResourceId |
string |
ID de recurso do Azure da VM. |