Guest Configuration Assignments - Get

Referência

Serviço:: Guest Configuration

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

Obter informações sobre uma atribuição de configuração de convidado

GET 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	O 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.

Respostas

Name	Tipo	Description
200 OK	GuestConfigurationAssignment	OK. A atribuição de configuração de convidado foi retornada 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

Get a guest configuration assignment

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

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/getGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_Get" 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 = "SecureProtocol";
NullableResponse<GuestConfigurationVmAssignmentResource> response = await collection.GetIfExistsAsync(guestConfigurationAssignmentName);
GuestConfigurationVmAssignmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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:: 200

{
  "location": "centraluseuap",
  "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol",
  "name": "AuditSecureProtocol",
  "properties": {
    "complianceStatus": "Compliant",
    "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
    "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
    "context": null,
    "guestConfiguration": {
      "kind": null,
      "name": "AuditSecureProtocol",
      "version": "1.0.0.3",
      "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip",
      "contentHash": "content hash",
      "contentManagedIdentity": "test_identity",
      "configurationParameter": [],
      "configurationSetting": null
    },
    "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