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 a 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 do URI

Name	Em	Necessário	Tipo	Description
guestConfigurationAssignmentName	path	True	string	Nome da atribuição de configuração de convidado.
resourceGroupName	path	True	string	O nome do grupo de recursos. Padrão Regex: ^[-\w\._]+$
subscriptionId	path	True	string	ID de assinatura que identifica exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual. Padrão Regex: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
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	GuestConfigurationAssignmentProperties	Propriedades da atribuição de configuração de convidado.

Respostas

Name	Tipo	Description
200 OK	GuestConfigurationAssignment	OK. A atribuição de configuração de convidado para a VM foi atualizada com êxito.
201 Created	GuestConfigurationAssignment	Criado. A atribuição de configuração de convidado para a VM foi criada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create or update guest configuration assignment

Pedido de amostra

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

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.GuestConfiguration.Models;
using Azure.ResourceManager.GuestConfiguration;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionId";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Compute/virtualMachines/{2}", subscriptionId, resourceGroupName, vmName));
GuestConfigurationVmAssignmentCollection collection = client.GetGuestConfigurationVmAssignments(scopeId);

// invoke the operation
string guestConfigurationAssignmentName = "NotInstalledApplicationForWindows";
GuestConfigurationAssignmentData data = new GuestConfigurationAssignmentData()
{
    Properties = new GuestConfigurationAssignmentProperties()
    {
        GuestConfiguration = new GuestConfigurationNavigation()
        {
            Name = "NotInstalledApplicationForWindows",
            Version = "1.0.0.3",
            ContentUri = new Uri("https://thisisfake/pacakge"),
            ContentHash = "123contenthash",
            ContentManagedIdentity = "test_identity",
            AssignmentType = GuestConfigurationAssignmentType.ApplyAndAutoCorrect,
            ConfigurationParameters =
            {
            new GuestConfigurationParameter()
            {
            Name = "[InstalledApplication]NotInstalledApplicationResource1;Name",
            Value = "NotePad,sql",
            }
            },
        },
        Context = "Azure policy",
    },
    Name = "NotInstalledApplicationForWindows",
    Location = new AzureLocation("westcentralus"),
};
ArmOperation<GuestConfigurationVmAssignmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, guestConfigurationAssignmentName, data);
GuestConfigurationVmAssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GuestConfigurationAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

201

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

Código de estado:

200

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

Definições

Name	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	Razão 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 da máquina 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	Definição de configuração do LCM (Local Configuration Manager).
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 máquina e a configuração de convidado.
GuestConfigurationAssignmentProperties	Propriedades de atribuição de configuração de convidado.
GuestConfigurationNavigation	A configuração de convidado é um artefato que encapsula a configuração DSC e suas dependências. O artefato é um arquivo zip contendo configuração 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 só aparece na resposta.
systemData	Metadados referentes à 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 VMSS VM

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

Name	Tipo	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

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

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

AssignmentReport

Name	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 da máquina para a configuração de convidado atribuída.
endTime	string	Data e hora de término da verificação de status de conformidade da atribuição de configuração de convidado.
id	string	ID do recurso 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	Data e hora de início da verificação do status de conformidade da atribuição de configuração do convidado.
vm	VMInfo	Informações sobre a VM.

AssignmentReportResource

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

Name	Tipo	Description
complianceStatus	complianceStatus	Um valor que indica o status de conformidade da máquina para a configuração de convidado atribuída.
properties	object	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 do recurso de atribuição de configuração de convidado.

AssignmentReportResourceComplianceReason

Razão 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 da 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 status de conformidade da máquina 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) realmente 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	Default value	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 verdadeiro - novas configurações baixadas do serviço pull têm permissão para substituir as antigas no nó de destino. Caso contrário, falso
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	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ê terá que 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 for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.
refreshFrequencyMins	number	30	O intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 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 indicando por que a operação falhou.

ErrorResponse

Resposta de erro de uma falha de operação

Name	Tipo	Description
error	Error

GuestConfigurationAssignment

A atribuição de configuração de convidado é uma associação entre uma máquina e a configuração de convidado.

Name	Tipo	Description
id	string	ID do recurso 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	GuestConfigurationAssignmentProperties	Propriedades da atribuição de configuração de convidado.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso.

GuestConfigurationAssignmentProperties

Propriedades de atribuição de configuração de convidado.

Name	Tipo	Description
assignmentHash	string	Hash combinado do pacote de configuração e parâmetros.
complianceStatus	complianceStatus	Um valor que indica o status de conformidade da máquina para a configuração de convidado atribuída.
context	string	A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure
guestConfiguration	GuestConfigurationNavigation	A configuração de convidado a ser atribuída.
lastComplianceStatusChecked	string	Data e hora em que o último estado de conformidade foi verificado.
latestAssignmentReport	AssignmentReport	Último relatório de atribuição de configuração de convidado relatado.
latestReportId	string	Id do relatório mais recente para a atribuição de configuração de convidado.
parameterHash	string	hash de parâmetro para a atribuição de configuração de convidado.
provisioningState	provisioningState	O estado de provisionamento, que só aparece na resposta.
resourceType	string	Tipo de recurso - VMSS / VM
targetResourceId	string	ID do recurso VM.
vmssVMList	VMSSVMInfo[]	A lista de dados de conformidade de VM para VMSS

GuestConfigurationNavigation

A configuração de convidado é um artefato que encapsula a configuração DSC e suas dependências. O artefato é um arquivo zip contendo configuração 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	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	ConfigurationParameter[]	Os parâmetros de configuração para a configuração do convidado.
configurationProtectedParameter	ConfigurationParameter[]	Os parâmetros de configuração protegidos para a configuração de convidado.
configurationSetting	ConfigurationSetting	A definição de configuração para a configuração do convidado.
contentHash	string	Hash combinado do pacote de configuração do convidado e dos parâmetros de configuração.
contentManagedIdentity	string	Identidade gerenciada com acesso ao armazenamento 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 Builtin ou Custom.
contentUri	string	Uri do armazenamento onde o pacote de configuração de convidado é carregado.
kind	kind	Tipo de configuração de convidado. Por exemplo:DSC
name	string	Nome da configuração do convidado.
version	string	Versão da configuração do convidado.

kind

Tipo de configuração de convidado. Por exemplo:DSC

Name	Tipo	Description
DSC	string

provisioningState

O estado de provisionamento, que só aparece na resposta.

Name	Tipo	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

Metadados referentes à 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	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	createdByType	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 do recurso do Azure da VM.
uuid	string	UUID (Identificador Universalmente Único) da VM.

VMSSVMInfo

Informações sobre VMSS VM

Name	Tipo	Description
complianceStatus	complianceStatus	Um valor que indica o status de conformidade da máquina para a configuração de convidado atribuída.
lastComplianceChecked	string	Data e hora em que o último estado de conformidade foi verificado.
latestReportId	string	Id do relatório mais recente para a atribuição de configuração de convidado.
vmId	string	UUID da VM.
vmResourceId	string	ID do recurso do Azure da VM.